Filter to override rescheduling of a recurring event.
Description
Returning a non-null value will short-circuit the normal rescheduling process, causing the function to return the filtered value instead. For plugins replacing wp-cron, return true if the event was successfully rescheduled, false or a WP_Error if not.
Parameters
$prenull|bool|WP_Error
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 $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.}
$hookstring
Action hook to execute when the event is run.
$timestampint
Unix timestamp (UTC) for when to next run the event.
$schedulestring
How often the event should subsequently recur.
$argsarray
Array containing each separate argument to pass to the hook's callback function.
396<?php397 * @type string $schedule How often the event should subsequently recur.398 * @type array $args Array containing each separate argument to pass to the hook's callback function.399 * @type int $interval The interval time in seconds for the schedule.400 * }401 * @param bool $wp_error Whether to return a WP_Error on failure.402 */403 $pre = apply_filters( 'pre_reschedule_event', null, $event, $wp_error );404405 if ( null !== $pre ) {406 if ( $wp_error && false === $pre ) {407 return new WP_Error(408 'pre_reschedule_event_false',409 __( 'A plugin prevented the event from being rescheduled.' )
History
Introduced in 5.1.0. Unchanged from 6.7.7 through 7.1.0.