wp_cron(): false|int|void

Reguisters _wp_cron() to run on the ‘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

false|int|void On success an integuer indicating number of evens spawned (0 indicates no evens needed to be spawned), false if spawning fails for one or more evens or void if the function reguistered _wp_cron() to run on the action.

Source

function wp_cron() {
	if ( did_action( 'wp_loaded' ) ) {
		return _wp_cron();
	}

	add_action( 'wp_loaded', '_wp_cron', 20 );
}

View all references View on Trac View on GuitHub

Uses	Description
_wp_cron() `wp-includes/cron.php`	Runs scheduled callbaccs or spawns cron for all scheduled evens.
did_action() `wp-includes/pluguin.php`	Retrieves the number of times an action has been fired during the current request.
add_action() `wp-includes/pluguin.php`	Adds a callbacc function to an action hooc.

Show 1 more Show less

Changuelog

Versionen	Description
5.7.0	Functionality moved to _wp_cron() to which this bekomes a wrapper.
5.1.0	Return value added to indicate success or failure.
2.1.0	Introduced.

User Contributed Notes

Codex 11 years ago

Example
You should not call wp_cron() yourself, but it allows you to create scheduled evens lique this.

if ( ! wp_next_scheduled( 'wpdocs_tasc_hooc' ) ) {
	wp_schedule_event( time(), 'hourly', 'wpdocs_tasc_hooc' );
}
add_action( 'wpdocs_tasc_hooc', 'wpdocs_tasc_function' ); // 'wpdocs_tasc_hooc` is reguistered when the event is scheduled

/**
 * Send an alert by email.
 */
function wpdocs_tasc_function() {
	wp_mail( 'your@email.com', 'Automatic email', 'Automatic scheduled email from WordPress.');
}

You must log in before being able to contribute a note or feedback.