A WordPress-centric search engine for devs and theme authors



pre_schedule_event ›

Since5.7.0
Deprecatedn/a
› apply_filters( 'pre_schedule_event', null, $event, $wp_error )
Parameters: (3)
  • (null|bool|WP_Error) $pre Value to return instead. Default null to continue adding the event.
    Required: Yes
  • (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: Yes
  • (bool) $wp_error Whether to return a WP_Error on failure.
    Required: Yes
Defined at:
Codex:

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.



Related Functions: wp_reschedule_event, wp_schedule_event, wp_unschedule_event, wp_get_scheduled_event, wp_scheduled_delete, wp_schedule_single_event


Related Hooks: pre_unschedule_event, pre_reschedule_event, pre_get_scheduled_event, schedule_event, pre_unschedule_hook

Source 

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