apply_filters( 'pre_reschedule_event', null|bool|WP_Error $pre , object $event , bool $wp_error )
Filter to preflight or hijack rescheduling of a recurring event.
Description
Returning a non-null value will short-circuit the normal rescheduling process, causing the function to return the filtered value instead.
For plugins replacing wp-cron, return true if the event was successfully rescheduled, false or a WP_Error if not.
Parameters
- $pre
-
Value to return instead. Default null to continue adding the event.
- $event
-
An object containing an event's data.<br>
- 'hook'
(string) Action hook to execute when the event is run.<br> - 'timestamp'
(int) Unix timestamp (UTC) for when to next run the event.<br> - 'schedule'
(string) How often the event should subsequently recur.<br> - 'args'
(array) Array containing each separate argument to pass to the hook's callback function.<br> - 'interval'
(int) The interval time in seconds for the schedule.<br>
- 'hook'
- $wp_error
-
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. |