pre_get_scheduled_event WordPress Filter Hook
The pre_get_scheduled_event WordPress hook is used to retrieve a scheduled event before it is displayed. This hook is useful for modifying the event data before it is displayed on the front-end.
apply_filters( 'pre_get_scheduled_event', null|false|object $pre , string $hook , array $args , int|null $timestamp ) #
Filter to preflight or hijack retrieving a scheduled event.
Description
Returning a non-null value will short-circuit the normal process, returning the filtered value instead.
Return false if the event does not exist, otherwise an event object should be returned.
Parameters
- $pre
(null|false|object)Value to return instead. Default null to continue retrieving the event.
- $hook
(string)Action hook of the event.
- $args
(array)Array containing each separate argument to pass to the hook's callback function. Although not passed to a callback, these arguments are used to uniquely identify the event.
- $timestamp
(int|null)Unix timestamp (UTC) of the event. Null to retrieve next scheduled event.
Source
File: wp-includes/cron.php
Changelog
Version | Description |
---|---|
5.1.0 | Introduced. |