spawn_cron( int $gmt_time = 0 ): bool

Compatibility

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

Parameters

$gmt_timeintoptional

Unix timestamp (UTC). Default 0 (current time is used).Default: 0

Return value

bool

True if spawned, false if no events spawned.

Performance profile

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

Expensive

Reaches an outbound HTTP request via wp_remote_post().

Scaling

Constant

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

Instructions

5–91

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

Plugin surface

2 hooks

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

Called by

1

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

What it touches

• transienttransientget_transient()called directly
• hookthird-party callbacksapply_filters()called directly
• httpoutbound HTTP requestwp_remote_post()called directly
• cacheobject cachewp_cache_get()one call below spawn_cron()
• optionoption read or writeget_option()one call below spawn_cron()

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

What one call costs · 12 distinct outcomes

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

Hooks and filters fired · 2

2 hooks fire while spawn_cron() runs, in this order:

1. 1
   apply_filters( cron_request )filterline 934 (+83 into the body)

   Filters the cron request arguments.

2. 2
   apply_filters( https_local_ssl_verify )filterline 943 (+92 into the body)

   Filters whether SSL should be verified for local HTTP API requests.

Uses · 11

• get_transient()Retrieves the value of a transient.
• wp_get_ready_cron_jobs()Retrieves cron jobs ready to be run.
• set_transient()Sets/updates the value of a transient.
• wp_redirect()Redirects to another page.
• add_query_arg()Retrieves a modified URL query string.
• wp_unslash()Removes slashes from a string or recursively removes slashes from strings within an array.
• wp_ob_end_flush_all()Flushes all output buffers for PHP 5.2.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• site_url()Retrieves the URL for the current site where WordPress application files (e.g. wp-blog-header.php or the wp-admin/ folder) are accessible.
• wp_remote_post()Performs an HTTP request using the POST method and returns its response.
• is_wp_error()Checks whether the given variable is a WordPress Error.

Used by · 1

• _wp_cron()Runs scheduled callbacks or spawns cron for all scheduled events.

Source code

View on Trac ↗View on GitHub ↗

851function spawn_cron( $gmt_time = 0 ) {852	if ( ! $gmt_time ) {853		$gmt_time = microtime( true );854	}855 856	if ( defined( 'DOING_CRON' ) || isset( $_GET['doing_wp_cron'] ) ) {857		return false;858	}859 860	/*861	 * Get the cron lock, which is a Unix timestamp of when the last cron was spawned862	 * and has not finished running.863	 *864	 * Multiple processes on multiple web servers can run this code concurrently,865	 * this lock attempts to make spawning as atomic as possible.866	 */867	$lock = (float) get_transient( 'doing_cron' );868 869	if ( $lock > $gmt_time + 10 * MINUTE_IN_SECONDS ) {870		$lock = 0;871	}872 873	// Don't run if another process is currently running it or more than once every 60 sec.874	if ( $lock + WP_CRON_LOCK_TIMEOUT > $gmt_time ) {875		return false;876	}877 878	// Confidence check.879	$crons = wp_get_ready_cron_jobs();880	if ( empty( $crons ) ) {881		return false;882	}883 884	$keys = array_keys( $crons );885	if ( isset( $keys[0] ) && $keys[0] > $gmt_time ) {886		return false;887	}888 889	if ( defined( 'ALTERNATE_WP_CRON' ) && ALTERNATE_WP_CRON ) {890		if ( 'GET' !== $_SERVER['REQUEST_METHOD'] || defined( 'DOING_AJAX' ) || defined( 'XMLRPC_REQUEST' ) ) {891			return false;892		}893 894		$doing_wp_cron = sprintf( '%.22F', $gmt_time );895		set_transient( 'doing_cron', $doing_wp_cron );896 897		ob_start();898		wp_redirect( add_query_arg( 'doing_wp_cron', $doing_wp_cron, wp_unslash( $_SERVER['REQUEST_URI'] ) ) );899		echo ' ';900 901		// Flush any buffers and send the headers.902		wp_ob_end_flush_all();903		flush();904 905		require_once ABSPATH . 'wp-cron.php';906		return true;907	}908 909	// Set the cron lock with the current unix timestamp, when the cron is being spawned.910	$doing_wp_cron = sprintf( '%.22F', $gmt_time );911	set_transient( 'doing_cron', $doing_wp_cron );912 913	/**914	 * Filters the cron request arguments.915	 *916	 * @since 3.5.0917	 * @since 4.5.0 The `$doing_wp_cron` parameter was added.918	 *919	 * @param array $cron_request_array {920	 *     An array of cron request URL arguments.921	 *922	 *     @type string $url  The cron request URL.923	 *     @type int    $key  The 22 digit GMT microtime.924	 *     @type array  $args {925	 *         An array of cron request arguments.926	 *927	 *         @type int  $timeout   The request timeout in seconds. Default .01 seconds.928	 *         @type bool $blocking  Whether to set blocking for the request. Default false.929	 *         @type bool $sslverify Whether SSL should be verified for the request. Default false.930	 *     }

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