pre_unschedule_hook – Hook | Developer.WordPress.org

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

Filter to override clearing all events attached to the hook.

Description

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.

Parameters

$prenull|int|false|WP_Error: Value to return instead. Default null to continue unscheduling the hook.
$hookstring: Action hook, the execution of which will be unscheduled.
$wp_errorbool: Whether to return a WP_Error on failure.

Source

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

View all references View on Trac View on GitHub

Used by	Description
wp_unschedule_hook()`wp-includes/cron.php`	Unschedules all events attached to the hook.

Changelog

Version	Description
5.7.0	The `$wp_error` parameter was added, and a `WP_Error` object can now be returned.
5.1.0	Introduced.

User Contributed Notes

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