Core Function
View Source on Trac ↗ wp_get_scheduled_event()
wp_get_scheduled_event( mixed $hook, mixed $args = array(), mixed $timestamp = null ) Retrieves a scheduled event.
Parameters 3 required
| Name / Type | Description |
|---|---|
| $hook string | Action hook of the event. Required |
| array | $args Optional. 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, so they should be the same as those used when originally scheduling the event. Default empty array. Required |
| mixed | (int | null) $timestamp Optional. Unix timestamp (UTC) of the event. If not specified, the next scheduled event is returned. Default null. Required |
Return Value
((object)
(object | false) {
The event object. False if the event does not exist.
Function Information
Since Version
5.1.0
Source File
wp-includes/cron.php
Advertisement