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
$prenull|false|object
Value to return instead. Default null to continue retrieving the event.
$hookstring
Action hook of the event.
$argsarray
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.
$timestampint|null
Unix timestamp (UTC) of the event. Null to retrieve next scheduled event.
791<?php792 * @param string $hook Action hook of the event.793 * @param array $args Array containing each separate argument to pass to the hook's callback function.794 * Although not passed to a callback, these arguments are used to uniquely identify795 * the event.796 * @param int|null $timestamp Unix timestamp (UTC) of the event. Null to retrieve next scheduled event.797 */798 $pre = apply_filters( 'pre_get_scheduled_event', null, $hook, $args, $timestamp );799800 if ( null !== $pre ) {801 return $pre;802 }803804 if ( null !== $timestamp && ! is_numeric( $timestamp ) ) {
History
Introduced in 5.1.0. Unchanged from 6.7.7 through 7.1.0.