pre_unschedule_event WordPress Filter Hook

The pre_unschedule_event hook is called before an event is unscheduled. This hook can be used to modify the event data before it is unscheduled.

apply_filters( 'pre_unschedule_event', null|bool|WP_Error $pre, int $timestamp, string $hook, array $args, bool $wp_error ) #

Filter to preflight or hijack unscheduling of events.

Returning a non-null value will short-circuit the normal unscheduling process, causing the function to return the filtered value instead.

For plugins replacing wp-cron, return true if the event was successfully unscheduled, false if not.

$pre: (null|bool|WP_Error)Value to return instead. Default null to continue unscheduling the event.
$timestamp: (int)Timestamp for when to run the event.
$hook: (string)Action hook, the execution of which will be unscheduled.
$args: (array)Arguments to pass to the hook's callback function.
$wp_error: (bool)Whether to return a WP_Error on failure.