apply_filters( 'pre_reschedule_event', null|bool|WP_Error $pre, object $event, bool $wp_error )

Filter to preflight or hijack 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.

$pre null|bool|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 bool

Whether to return a WP_Error on failure.

File: wp-includes/cron.php. View all references

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

Used By
Used By	Description
wp_reschedule_event() wp-includes/cron.php	Reschedules a recurring event.

Changelog
Version	Description
5.7.0	The `$wp_error` parameter was added, and a `WP_Error` object can now be returned.
5.1.0	Introduced.

You must log in before being able to contribute a note or feedback.