egister_once(); break; } } catch ( \RuntimeException $exception ) { $action_id = null; $error = ' ' . $exception->getMessage(); } if ( empty( $action_id ) ) { $this->log_register_failure( "Action Scheduler could not create the action.{$error}" ); } return $action_id; } /** * Register the async task. * * @since 1.5.9 * * @return null|string Action ID. * @noinspection PhpUndefinedFunctionInspection */ protected function register_async() { if ( ! function_exists( 'as_enqueue_async_action' ) ) { return null; } return as_enqueue_async_action( $this->action, /** * Filter arguments passed to the async task. * * @since 1.9.4 * * @param array $args Arguments passed to the async task. * * @return array */ (array) apply_filters( 'wpforms_tasks_task_register_async_args', [ 'tasks_meta_id' => $this->meta_id, ] ), Tasks::GROUP ); } /** * Register the recurring task. * * @since 1.5.9 * * @return null|string Action ID. * @noinspection PhpUndefinedFunctionInspection */ protected function register_recurring() { if ( ! function_exists( 'as_schedule_recurring_action' ) ) { return null; } return as_schedule_recurring_action( $this->timestamp, $this->interval, $this->action, [ 'tasks_meta_id' => $this->meta_id ], Tasks::GROUP ); } /** * Register the one-time task. * * @since 1.5.9 * * @return null|string Action ID. * @noinspection PhpUndefinedFunctionInspection */ protected function register_once() { if ( ! function_exists( 'as_schedule_single_action' ) ) { return null; } return as_schedule_single_action( $this->timestamp, $this->action, [ 'tasks_meta_id' => $this->meta_id ], Tasks::GROUP ); } /** * Unschedule every action registered for a hook. * * Static on purpose. Cancelling through an instance runs the subclass constructor, * and several tasks schedule themselves from there, so `( new SomeTask() )->cancel()` * schedules the action on the line before it removes it. * * @since 2.0.2.1 * * @param string $action Action hook name. * * @return bool Whether the unschedule was attempted. * * @noinspection PhpUndefinedFunctionInspection */ public static function unschedule_action( string $action ): bool { if ( ! function_exists( 'as_unschedule_all_actions' ) ) { return false; } as_unschedule_all_actions( $action ); return true; } /** * Cancel all occurrences of this task. * * @since 1.6.1 * * @return null|bool|string Null if no matching action found, * false if AS library is missing, * true if scheduled task has no params, * string of the scheduled action ID if a scheduled action was found and unscheduled. * @noinspection PhpUndefinedFunctionInspection */ public function cancel() { if ( ! function_exists( 'as_unschedule_all_actions' ) ) { return false; } if ( $this->params === null ) { as_unschedule_all_actions( $this->action ); return true; } $this->meta_id = $this->meta->get_meta_id( $this->action, $this->params ); if ( $this->meta_id === null ) { return null; } return as_unschedule_action( $this->action, [ 'tasks_meta_id' => $this->meta_id ], Tasks::GROUP ); } /** * Log message to WPForms logger and standard debug.log file. * * @since 1.9.1 * * @param string $message The error message that should be logged. */ protected function log( $message ) { wpforms_log( $this->log_title, $message, [ 'type' => 'log' ] ); } /** * Log a task registration failure. * * Throttled to one log entry per task action per hour, since on a broken * environment the same failure repeats on almost every request. * * @since 2.0.3 * * @param string $reason The reason why the task was not registered. */ private function log_register_failure( string $reason ) { $transient = "wpforms_task_register_failure_{$this->action}"; if ( get_transient( $transient ) ) { return; } /** * Filter the interval between logged registration failures of the same task. * * @since 2.0.3 * * @param int $interval Throttle interval in seconds. Default HOUR_IN_SECONDS. * @param string $action Task action name. */ $interval = (int) apply_filters( 'wpforms_tasks_task_log_register_failure_interval', HOUR_IN_SECONDS, $this->action ); // A dropped record must not start the throttle, or the next failure would go unlogged too. if ( ! wpforms_log( 'Task registration failure', "Task '{$this->action}' was not registered: {$reason}", [ 'type' => 'error' ] ) ) { return; } set_transient( $transient, 1, $interval ); } }