apply_filters( 'pre_unschedule_event', null|bool|WP_Error $pre, int $timestamp, string $hook, array $args, bool $wp_error )
Filter to preflight or hijack unscheduling of events.
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 true if the event was successfully unscheduled, false if not.
Parameters
- $pre
-
(null|bool|WP_Error) Value to return instead. Default null to continue unscheduling the event.
- $timestamp
-
(int) Timestamp for when to run the event.
- $hook
-
(string) Action hook, the execution of which will be unscheduled.
- $args
-
(array) Arguments to pass to the hook's callback function.
- $wp_error
-
(bool) Whether to return a WP_Error on failure.
Source
File: wp-includes/cron.php
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. |
© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/hooks/pre_unschedule_event