Summery Summery

Filter to preflight or hijack retrieving a scheduled event.

Syntax Syntax

apply_filters( 'pre_get_scheduled_event', null|false|object $pre, string $hook, array $args, int|null $timestamp )

Description 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 Parameters


(null|false|object) Value to return instead. Default null to continue retrieving the event.


(string) Action hook of the event.


(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.


(int|null) Unix timestamp (UTC) of the event. Null to retrieve next scheduled event.

Source Source

File: wp-includes/cron.php


Changelog Changelog

Version Description
5.1.0 Introduced.


Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.

What are you looking for?