pre_reschedule_event filter-hookWP 5.1.0

Filter to preflight or hijack rescheduling of events.

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 if not.

Usage

add_filter( 'pre_reschedule_event', 'wp_kama_pre_reschedule_event_filter', 10, 3 );

/**
 * Function for `pre_reschedule_event` filter-hook.
 * 
 * @param null|bool|WP_Error $pre      Value to return instead.
 * @param stdClass           $event    An object containing an event's data.
 * @param bool               $wp_error Whether to return a WP_Error on failure.
 *
 * @return null|bool|WP_Error
 */
function wp_kama_pre_reschedule_event_filter( $pre, $event, $wp_error ){

	// filter...
	return $pre;
}
$pre(null|true|false|WP_Error)
Value to return instead.
Default: null to continue adding the event
$event(stdClass)

An object containing an event's data.

  • hook(string)
    Action hook to execute when the event is run.

  • timestamp(int)
    Unix timestamp (UTC) for when to next run the event.

  • schedule(string|false)
    How often the event should subsequently recur.

  • args(array)
    Array containing each separate argument to pass to the hook's callback function.

  • interval(int)
    The interval time in seconds for the schedule. Only present for recurring events.
$wp_error(true|false)
Whether to return a WP_Error on failure.

Changelog

Since 5.1.0 Introduced.
Since 5.7.0 The $wp_error parameter was added, and a WP_Error object can now be returned.

Where the hook is called

wp_reschedule_event()
pre_reschedule_event
wp-includes/cron.php 409
$pre = apply_filters( 'pre_reschedule_event', null, $event, $wp_error );

Where the hook is used in WordPress

Usage not found.