Filter hook 'pre_clear_scheduled_hook'

Hook Information

Hook Parameters

Usage Examples

<?php
// Hook into pre_clear_scheduled_hook
add_filter('pre_clear_scheduled_hook', 'my_custom_filter', 10, 4);

function my_custom_filter($pre, $hook, $args, $wp_error) {
    // Your custom filtering logic here
    return $pre;
}

Source Code Context

<?php
 578  	 * @param null|int|false|WP_Error $pre      Value to return instead. Default null to continue unscheduling the event.
 579  	 * @param string                  $hook     Action hook, the execution of which will be unscheduled.
 580  	 * @param array                   $args     Arguments to pass to the hook's callback function.
 581  	 * @param bool                    $wp_error Whether to return a WP_Error on failure.
 582  	 */
 583  	$pre = apply_filters( 'pre_clear_scheduled_hook', null, $hook, $args, $wp_error );
 584  
 585  	if ( null !== $pre ) {
 586  		if ( $wp_error && false === $pre ) {
 587  			return new WP_Error(
 588  				'pre_clear_scheduled_hook_false',

PHP Documentation

<?php
/**
	 * Filter to override clearing a scheduled 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
	 * or a WP_Error if unscheduling one or more events fails.
	 *
	 * @since 5.1.0
	 * @since 5.7.0 The `$wp_error` parameter was added, and a `WP_Error` object can now be returned.
	 *
	 * @param null|int|false|WP_Error $pre      Value to return instead. Default null to continue unscheduling the event.
	 * @param string                  $hook     Action hook, the execution of which will be unscheduled.
	 * @param array                   $args     Arguments to pass to the hook's callback function.
	 * @param bool                    $wp_error Whether to return a WP_Error on failure.
	 */