pre_reschedule_event │ filter-hook │ WP 5.1.0

Filter to override rescheduling of a recurring event.

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.

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 object             $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(object)

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)
  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.

$wp_error(true|false)

Whether to return a WP_Error on failure.

Changelog

Where the hook is called

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

Where the hook is used in WordPress