On this page
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 or a WP_Error if not.
Parameters
$prenull|bool|WP_Error-
Value to return instead. Default null to continue unscheduling the event.
$timestampint-
Timestamp for when to run the event.
$hookstring-
Action hook, the execution of which will be unscheduled.
$argsarray-
Arguments to pass to the hook's callback function.
$wp_errorbool-
Whether to return a WP_Error on failure.
Source
File: wp-includes/cron.php. View all references
$pre = apply_filters( 'pre_unschedule_event', null, $timestamp, $hook, $args, $wp_error );
Related
Used By
| Used By | Description |
|---|---|
| wp_unschedule_event() wp-includes/cron.php | Unschedule a previously scheduled event. |
Changelog
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/hooks/pre_unschedule_event