wp_get_schedule( string $hook, array $args = array() ): string|false

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 to identify the event.

$argsarrayoptional

Arguments passed to the event's callback function.
Default empty array.Default: array()

Return value

string|false

Schedule name on success, false if no schedule.

Performance profile

How much work a call to wp_get_schedule() 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

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

16–17

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

Plugin surface

1 hook

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

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksapply_filters()called directly

Further down the call graph this can also reach option, cache, serialize, 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 · 1 distinct outcome

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

Hooks and filters fired · 1

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

1. 1
   apply_filters( get_schedule )filterline 1172 (+17 into the body)

   Filters the schedule name for a hook.

Uses · 2

• wp_get_scheduled_event()Retrieves a scheduled event.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Source code

View on Trac ↗View on GitHub ↗

1155function wp_get_schedule( $hook, $args = array() ) {1156	$schedule = false;1157	$event    = wp_get_scheduled_event( $hook, $args );1158 1159	if ( $event ) {1160		$schedule = $event->schedule;1161	}1162 1163	/**1164	 * Filters the schedule name for a hook.1165	 *1166	 * @since 5.1.01167	 *1168	 * @param string|false $schedule Schedule for the hook. False if not found.1169	 * @param string       $hook     Action hook to execute when cron is run.1170	 * @param array        $args     Arguments to pass to the hook's callback function.1171	 */1172	return apply_filters( 'get_schedule', $schedule, $hook, $args );1173}

Changelog

Introduced in 2.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.9.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.