WordPress at Your Fingertips
filter is not described

pre_unschedule_event filter-hook . WP 5.1.0

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.

Usage

add_filter( 'pre_unschedule_event', 'filter_function_name_31', 10, 5 );
function filter_function_name_31( $pre, $timestamp, $hook, $args, $wp_error ){
	// filter...

	return $pre;
}
$pre(null|true|false|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(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_unschedule_event()
pre_unschedule_event
wp-includes/cron.php 492
$pre = apply_filters( 'pre_unschedule_event', null, $timestamp, $hook, $args, $wp_error );

Where in WP core the hook is used WordPress

Usage not found.