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

In this article

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.


Value to return instead. Default null to continue unscheduling the event.
Action hook, the execution of which will be unscheduled.
Arguments to pass to the hook’s callback function.
Whether to return a WP_Error on failure.


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


5.7.0The $wp_error parameter was added, and a WP_Error object can now be returned.

User Contributed Notes

You must log in before being able to contribute a note or feedback.