pre_unschedule_hook WordPress Filter Hook
The pre_unschedule_hook is a Wordpress hook that is triggered before a scheduled event is unscheduled. This hook can be used to perform cleanup or other actions before an event is unscheduled.
apply_filters( 'pre_unschedule_hook', null|int|false|WP_Error $pre , string $hook , bool $wp_error ) #
Filter to preflight or hijack 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) or false if unscheduling one or more events fails.
Parameters
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. |