pre_schedule_event

过滤钩子


apply_filters( 'pre_schedule_event', null, $event, $wp_error )
参数
  • (null|bool|WP_Error)
    $pre
    Value to return instead. Default null to continue adding the event.
    Required:
  • (stdClass)
    $event
    {
    An object containing an event’s data.

    @type string $hook Action hook to execute when the event is run.
    @type int $timestamp Unix timestamp (UTC) for when to next run the event.
    @type string|false $schedule How often the event should subsequently recur.
    @type array $args Array containing each separate argument to pass to the hook’s callback function.
    @type int $interval The interval time in seconds for the schedule. Only present for recurring events.
    }

    Required:
  • (bool)
    $wp_error
    Whether to return a WP_Error on failure.
    Required:
定义位置
  • wp-includes/cron.php
    , line 91
引入
5.7.0
弃用

Filter to preflight or hijack scheduling an event.

Returning a non-null value will short-circuit adding the event to the
cron array, causing the function to return the filtered value instead.

Both single events and recurring events are passed through this filter;
single events have $event->schedule as false, whereas recurring events
have this set to a recurrence from wp_get_schedules(). Recurring
events also have the integer recurrence interval set as $event->interval.

For plugins replacing wp-cron, it is recommended you check for an
identical event within ten minutes and apply the {@see ‘schedule_event’}
filter to check if another plugin has disallowed the event before scheduling.

Return true if the event was scheduled, false or a WP_Error if not.

$pre = apply_filters( 'pre_schedule_event', null, $event, $wp_error );