Filter hook 'pre_unschedule_hook'

Hook Information

Hook Parameters

Usage Examples

<?php
// Hook into pre_unschedule_hook
add_filter('pre_unschedule_hook', 'my_custom_filter', 10, 3);

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

Source Code Context

<?php
 668  	 *
 669  	 * @param null|int|false|WP_Error $pre      Value to return instead. Default null to continue unscheduling the hook.
 670  	 * @param string                  $hook     Action hook, the execution of which will be unscheduled.
 671  	 * @param bool                    $wp_error Whether to return a WP_Error on failure.
 672  	 */
 673  	$pre = apply_filters( 'pre_unschedule_hook', null, $hook, $wp_error );
 674  
 675  	if ( null !== $pre ) {
 676  		if ( $wp_error && false === $pre ) {
 677  			return new WP_Error(
 678  				'pre_unschedule_hook_false',

PHP Documentation

<?php
/**
	 * Filter to override 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). If unscheduling
	 * one or more events fails then return either a WP_Error object or false depending
	 * on the value of the `$wp_error` parameter.
	 *
	 * @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 hook.
	 * @param string                  $hook     Action hook, the execution of which will be unscheduled.
	 * @param bool                    $wp_error Whether to return a WP_Error on failure.
	 */