pre_get_scheduled_event

Advertisement

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

$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 Source

File: wp-includes/cron.php

Advertisement

Changelog Changelog

Changelog
Version Description
5.1.0 Introduced.

Advertisement

Leave a Reply

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