pre_unschedule_hook filter-hookWP 5.1.0

Filter to preflight or hijack clearing all events attached to the hook.

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 the number of events successfully unscheduled (zero if no events were registered with the hook) or false if unscheduling one or more events fails.

Usage

add_filter( 'pre_unschedule_hook', 'wp_kama_pre_unschedule_hook_filter', 10, 3 );

/**
 * Function for `pre_unschedule_hook` filter-hook.
 * 
 * @param null|int|false|WP_Error $pre      Value to return instead.
 * @param string                  $hook     Action hook, the execution of which will be unscheduled.
 * @param bool                    $wp_error Whether to return a WP_Error on failure.
 *
 * @return null|int|false|WP_Error
 */
function wp_kama_pre_unschedule_hook_filter( $pre, $hook, $wp_error ){

	// filter...
	return $pre;
}
$pre(null|int|false|WP_Error)
Value to return instead.
Default: null to continue unscheduling the hook
$hook(string)
Action hook, the execution of which will be unscheduled.
$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_hook()
pre_unschedule_hook
wp-includes/cron.php 669
$pre = apply_filters( 'pre_unschedule_hook', null, $hook, $wp_error );

Where the hook is used in WordPress

Usage not found.