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

Filter to override unscheduling of events.

Description

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 or a WP_Error if not.

$prenull|bool|WP_Error: Value to return instead. Default null to continue unscheduling the event.
$timestampint: Unix timestamp (UTC) for when to run the event.
$hookstring: Action hook, the execution of which will be unscheduled.
$argsarray: Arguments to pass to the hook’s callback function.
$wp_errorbool: Whether to return a WP_Error on failure.

$pre = apply_filters( 'pre_unschedule_event', null, $timestamp, $hook, $args, $wp_error );

Used by	Description
wp_unschedule_event()`wp-includes/cron.php`	Unschedules a previously scheduled event.

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.