wp_cron() WordPress Function
The wp_cron() function is used to schedule events in WordPress. It is typically used to schedule cron jobs, which are tasks that are executed at a given time or interval.
wp_cron() #
Register _wp_cron() to run on the {@see ‘wp_loaded’} action.
Description
If the ‘wp_loaded’ action has already fired, this function calls _wp_cron() directly.
Warning: This function may return Boolean FALSE, but may also return a non-Boolean value which evaluates to FALSE. For information about casting to booleans see the PHP documentation. Use the === operator for testing the return value of this function.
Return
(bool|int|void) On success an integer indicating number of events spawned (0 indicates no events needed to be spawned), false if spawning fails for one or more events or void if the function registered _wp_cron() to run on the action.
Source
File: wp-includes/cron.php
function wp_cron() {
if ( did_action( 'wp_loaded' ) ) {
return _wp_cron();
}
add_action( 'wp_loaded', '_wp_cron', 20 );
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 5.7.0 | Functionality moved to _wp_cron() to which this becomes a wrapper. |
| 5.1.0 | Return value added to indicate success or failure. |
| 2.1.0 | Introduced. |