wp_get_scheduled_event( string $hook, array $args = array(), int|null $timestamp = null ): object|false

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$hookstring

Action hook of the event.

$argsarrayoptional

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.Default: array()

$timestampint|nulloptional

Unix timestamp (UTC) of the event. If not specified, the next scheduled event is returned. Default null.Default: null

Return value

object|false

The event object. False if the event does not exist.

• $hookstring

  Action hook to execute when the event is run.

• $timestampint

  Unix timestamp (UTC) for when to next run the event.

• $schedulestring|false

  How often the event should subsequently recur.

• $argsarray

  Array containing each separate argument to pass to the hook's callback function.

• $intervalint

  Optional. The interval time in seconds for the schedule. Only present for recurring events.

Performance profile

How much work a call to wp_get_scheduled_event() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

14–63

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 72.

Plugin surface

1 hook

Third-party callbacks on 'pre_get_scheduled_event' run inside this call, and their cost is not bounded by anything here.

Called by

4

4 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly
• serializeserialisationserialize()called directly
• optionoption read or writeget_option()one call below wp_get_scheduled_event()

Further down the call graph this can also reach cache, query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 3 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_get_scheduled_event() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while wp_get_scheduled_event() runs, in this order:

1. 1
   apply_filters( pre_get_scheduled_event )filterline 770 (+19 into the body)

   Filter to override retrieving a scheduled event.

Uses · 2

• apply_filters()Calls the callback functions that have been added to a filter hook.
• _get_cron_array()Retrieves cron info array option.

Used by · 4

• upgrade_640()Executes changes made in WordPress 6.4.0.
• wp_get_schedule()Retrieves the name of the recurrence schedule for an event.
• wp_next_scheduled()Retrieves the next timestamp for an event.
• wp_reschedule_event()Reschedules a recurring event.

Source code

View on Trac ↗View on GitHub ↗

751function wp_get_scheduled_event( $hook, $args = array(), $timestamp = null ) {752	/**753	 * Filter to override retrieving a scheduled event.754	 *755	 * Returning a non-null value will short-circuit the normal process,756	 * returning the filtered value instead.757	 *758	 * Return false if the event does not exist, otherwise an event object759	 * should be returned.760	 *761	 * @since 5.1.0762	 *763	 * @param null|false|object $pre  Value to return instead. Default null to continue retrieving the event.764	 * @param string            $hook Action hook of the event.765	 * @param array             $args Array containing each separate argument to pass to the hook's callback function.766	 *                                Although not passed to a callback, these arguments are used to uniquely identify767	 *                                the event.768	 * @param int|null  $timestamp Unix timestamp (UTC) of the event. Null to retrieve next scheduled event.769	 */770	$pre = apply_filters( 'pre_get_scheduled_event', null, $hook, $args, $timestamp );771 772	if ( null !== $pre ) {773		return $pre;774	}775 776	if ( null !== $timestamp && ! is_numeric( $timestamp ) ) {777		return false;778	}779 780	$crons = _get_cron_array();781	if ( empty( $crons ) ) {782		return false;783	}784 785	$key = md5( serialize( $args ) );786 787	if ( ! $timestamp ) {788		// Get next event.789		$next = false;790		foreach ( $crons as $timestamp => $cron ) {791			if ( isset( $cron[ $hook ][ $key ] ) ) {792				$next = $timestamp;793				break;794			}795		}796 797		if ( ! $next ) {798			return false;799		}800 801		$timestamp = $next;802	} elseif ( ! isset( $crons[ $timestamp ][ $hook ][ $key ] ) ) {803		return false;804	}805 806	$event = (object) array(807		'hook'      => $hook,808		'timestamp' => $timestamp,809		'schedule'  => $crons[ $timestamp ][ $hook ][ $key ]['schedule'],810		'args'      => $args,811	);812 813	if ( isset( $crons[ $timestamp ][ $hook ][ $key ]['interval'] ) ) {814		$event->interval = $crons[ $timestamp ][ $hook ][ $key ]['interval'];815	}816 817	return $event;818}

Changelog

Introduced in 5.1.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/cron.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.