Used By
| Used By | Description |
|---|---|
| wp-includes/cron.php: wp_schedule_event() | Schedules a recurring event. |
| wp-includes/cron.php: wp_schedule_single_event() | Schedules an event to run only once. |
Filter to preflight or hijack scheduling an event.
Returning a non-null value will short-circuit adding the event to the cron array, causing the function to return the filtered value instead.
Both single events and recurring events are passed through this filter; single events have $event->schedule as false, whereas recurring events have this set to a recurrence from wp_get_schedules(). Recurring events also have the integer recurrence interval set as $event->interval.
For plugins replacing wp-cron, it is recommended you check for an identical event within ten minutes and apply the ‘schedule_event’ filter to check if another plugin has disallowed the event before scheduling.
Return true if the event was scheduled, false if not.
(null|bool) Value to return instead. Default null to continue adding the event.
(stdClass) An object containing an event's data.
(string) Action hook to execute when the event is run.
(int) Unix timestamp (UTC) for when to next run the event.
(string|false) How often the event should subsequently recur.
(array) Array containing each separate argument to pass to the hook's callback function.
(int) The interval time in seconds for the schedule. Only present for recurring events.
File: wp-includes/cron.php
| Version | Description |
|---|---|
| 5.1.0 | Introduced. |
© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/hooks/pre_schedule_event