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 '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.
Parameters
$resultnull|bool|WP_Error
The value to return instead. Default null to continue adding the event.
$eventobject
{ 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 Optional. The interval time in seconds for the schedule. Only present for recurring events.}
$hookstring
Action hook to execute when the event is run.
$timestampint
Unix timestamp (UTC) for when to next run the event.
$schedulestring|false
How often the event should subsequently recur.
$argsarray
Array containing each separate argument to pass to the hook's callback function.
$intervalint
Optional. The interval time in seconds for the schedule. Only present for recurring events.
85<?php86 * @type string|false $schedule How often the event should subsequently recur.87 * @type array $args Array containing each separate argument to pass to the hook's callback function.88 * @type int $interval Optional. The interval time in seconds for the schedule. Only present for recurring events.89 * }90 * @param bool $wp_error Whether to return a WP_Error on failure.91 */92 $pre = apply_filters( 'pre_schedule_event', null, $event, $wp_error );9394 if ( null !== $pre ) {95 if ( $wp_error && false === $pre ) {96 return new WP_Error(97 'pre_schedule_event_false',98 __( 'A plugin prevented the event from being scheduled.' )
History
Introduced in 5.1.0. Unchanged from 6.7.7 through 7.1.0.