W3cubDocs

/WordPress

_set_cron_array( array[] $cron, bool $wp_error = false ): bool|WP_Error

Updates the cron option with the new cron array.

Parameters

$cronarray[]required
Array of cron info arrays from _get_cron_array() .
$wp_errorbooloptional
Whether to return a WP_Error on failure.

Default:false

Return

bool|WP_Error True if cron array updated. False or WP_Error on failure.

Source

function _set_cron_array( $cron, $wp_error = false ) {
	if ( ! is_array( $cron ) ) {
		$cron = array();
	}

	$cron['version'] = 2;

	$result = update_option( 'cron', $cron, true );

	if ( $wp_error && ! $result ) {
		return new WP_Error(
			'could_not_set',
			__( 'The cron event list could not be saved.' )
		);
	}

	return $result;
}

Changelog

Version Description
5.7.0 The $wp_error parameter was added.
5.1.0 Return value modified to outcome of update_option() .
2.1.0 Introduced.

© 2003–2024 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/_set_cron_array