null|bool|WP_Error $pre, stdClass $event, bool $wp_error )
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
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.
Value to return instead. Default null to continue adding the event.
An object containing an event's data.
hookstringAction hook to execute when the event is run.
timestampintUnix timestamp (UTC) for when to next run the event.
schedulestring|falseHow often the event should subsequently recur.
argsarrayArray containing each separate argument to pass to the hook's callback function.
intervalintThe interval time in seconds for the schedule. Only present for recurring events.
Whether to return a WP_Error on failure.
View all references
$pre = apply_filters( 'pre_schedule_event', null, $event, $wp_error );