wppaste
WordPress

wp_get_schedules(): array

Since
2.1.0, 5.4.0
Source
wp-includes/cron.php:1133
Retrieves supported event recurrence schedules.

Description

The default supported recurrences are 'hourly', 'twicedaily', 'daily', and 'weekly'.
A plugin may add more by hooking into the 'cron_schedules' filter.
The filter accepts an array of arrays. The outer array has a key that is the name of the schedule, for example 'monthly'. The value is an array with two keys, one is 'interval' and the other is 'display'.

The 'interval' is a number in seconds of when the cron job should run.
So for 'hourly' the time is HOUR_IN_SECONDS (60 * 60 or 3600). For 'monthly', the value would be MONTH_IN_SECONDS (30 * 24 * 60 * 60 or 2592000).

The 'display' is the description. For the 'monthly' key, the 'display' would be __( 'Once Monthly' ).

For your plugin, you will be passed an array. You can add your schedule by doing the following:

// Filter parameter variable name is 'array'.
$array['monthly'] = array(
 'interval' => MONTH_IN_SECONDS,
 'display' => __( 'Once Monthly' )
);

Compatibility

WordPress
since 5.4.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

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

Return value

array
The array of cron schedules keyed by the schedule name.

  • ...$0array

    Cron schedule information.

    • $intervalint

      The schedule interval in seconds.

    • $displaystring

      The schedule display name.

Performance profile

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

Executed per call on PHP 8.5. The body compiles to 39.

Plugin surface
1 hook

Third-party callbacks on 'cron_schedules' 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

Further down the call graph this can also reach query, option, cache, serialize 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_schedules() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
always39__(), __(), __(), __(), apply_filters(), array_merge()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 39 instructions, 39 executed per call, 0 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Hooks and filters fired · 1

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

  1. apply_filters( cron_schedules )filterline 1169 (+36 into the body)

    Filters the non-default cron schedules.

Uses · 2

  • __()Retrieves the translation of $text.
  • apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 4

Source code

View on Trac View on GitHub 

function wp_get_schedules() {	$schedules = array(		'hourly'     => array(			'interval' => HOUR_IN_SECONDS,			'display'  => __( 'Once Hourly' ),		),		'twicedaily' => array(			'interval' => 12 * HOUR_IN_SECONDS,			'display'  => __( 'Twice Daily' ),		),		'daily'      => array(			'interval' => DAY_IN_SECONDS,			'display'  => __( 'Once Daily' ),		),		'weekly'     => array(			'interval' => WEEK_IN_SECONDS,			'display'  => __( 'Once Weekly' ),		),	); 	/**	 * Filters the non-default cron schedules.	 *	 * @since 2.1.0	 *	 * @param array $new_schedules {	 *     An array of non-default cron schedules keyed by the schedule name. Default empty array.	 *	 *     @type array ...$0 {	 *         Cron schedule information.	 *	 *         @type int    $interval The schedule interval in seconds.	 *         @type string $display  The schedule display name.	 *     }	 * }	 */	return array_merge( apply_filters( 'cron_schedules', array() ), $schedules );}

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.

5.4.0
The 'weekly' schedule was added.from the docblock
2.1.0
Introduced.from the docblock

About this page

Parsed data
Generated from the wordpress-develop 7.1.0 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.