wp_next_scheduled( string $hook, array $args = array() ): int|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 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 must match those used when originally scheduling the event. If the arguments do not match exactly, the event will not be found. Default empty array.Default: array()

Return value

int|false

The Unix timestamp (UTC) of the next time the event will occur. False if the event doesn't exist.

Performance profile

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

9–18

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

Plugin surface

1 hook

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

Called by

15

15 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 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 · 2 distinct outcomes

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

Hooks and filters fired · 1

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

1. 1
   apply_filters( wp_next_scheduled )filterline 887 (+28 into the body)

   Filters the timestamp of the next scheduled event for the given 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.

Used by · 15

• WP_Recovery_Mode::initialize()Initialize recovery mode for the current request.
• WP_Site_Health::maybe_create_scheduled_event()Creates a weekly cron event, if one does not already exist.
• WP_Upgrader::schedule_temp_backup_cleanup()Schedules the cleanup of the temporary backup directory.
• _publish_post_hook()Hook to schedule pings and enclosures when a post is published.
• _wp_check_for_scheduled_split_terms()In order to avoid the _wp_batch_split_terms() job being accidentally removed, checks that it's still scheduled while we haven't finished splitting terms.
• _wp_check_for_scheduled_update_comment_type()In order to avoid the _wp_batch_update_comment_type() job being accidentally removed, check that it's still scheduled while we haven't finished updating comment types.
• get_default_post_to_edit()Returns default post information to use when populating the "Write Post" form.
• populate_network()Populate network settings.
• wp_get_auto_update_message()Determines the appropriate auto-update message to be displayed.
• wp_schedule_delete_old_privacy_export_files()Schedules a `WP_Cron` job to delete expired export files.
• wp_schedule_personal_data_cleanup_requests()Schedules a WP-Cron job to clean up personal data requests.
• wp_schedule_update_checks()Schedules core, theme, and plugin update checks.

Source code

View on Trac ↗View on GitHub ↗

859function wp_next_scheduled( $hook, $args = array() ) {860	$next_event = wp_get_scheduled_event( $hook, $args );861 862	if ( ! $next_event ) {863		return false;864	}865 866	/**867	 * Filters the timestamp of the next scheduled event for the given hook.868	 *869	 * @since 6.8.0870	 *871	 * @param int    $timestamp  Unix timestamp (UTC) for when to next run the event.872	 * @param object $next_event {873	 *     An object containing an event's data.874	 *875	 *     @type string $hook      Action hook of the event.876	 *     @type int    $timestamp Unix timestamp (UTC) for when to next run the event.877	 *     @type string $schedule  How often the event should subsequently recur.878	 *     @type array  $args      Array containing each separate argument to pass to the hook879	 *                             callback function.880	 *     @type int    $interval  Optional. The interval time in seconds for the schedule. Only881	 *                             present for recurring events.882	 * }883	 * @param string $hook       Action hook of the event.884	 * @param array  $args       Array containing each separate argument to pass to the hook885	 *                           callback function.886	 */887	return apply_filters( 'wp_next_scheduled', $next_event->timestamp, $next_event, $hook, $args );888}

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 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.