On this page
_set_cron_array( array[] $cron, bool $wp_error = false ): bool|WP_Error
This function’s access is marked private. This means it is not intended for use by plugin or theme developers, only in other core functions. It is listed here for completeness.
Updates the cron option with the new cron array.
Parameters
$cronarray[] Required-
Array of cron info arrays from _get_cron_array() .
$wp_errorbool Optional-
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
File: wp-includes/cron.php. View all references
function _set_cron_array( $cron, $wp_error = false ) {
if ( ! is_array( $cron ) ) {
$cron = array();
}
$cron['version'] = 2;
$result = update_option( 'cron', $cron );
if ( $wp_error && ! $result ) {
return new WP_Error(
'could_not_set',
__( 'The cron event list could not be saved.' )
);
}
return $result;
}
Related
Uses
| Uses | Description |
|---|---|
| __() wp-includes/l10n.php | Retrieves the translation of $text. |
| update_option() wp-includes/option.php | Updates the value of an option that was already added. |
| WP_Error::__construct() wp-includes/class-wp-error.php | Initializes the error. |
Used By
| Used By | Description |
|---|---|
| wp_unschedule_hook() wp-includes/cron.php | Unschedules all events attached to the hook. |
| wp_schedule_event() wp-includes/cron.php | Schedules a recurring event. |
| wp_unschedule_event() wp-includes/cron.php | Unschedule a previously scheduled event. |
| wp_schedule_single_event() wp-includes/cron.php | Schedules an event to run only once. |
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–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/_set_cron_array