Alert: 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.
_set_cron_array() WordPress Function
The set_cron_array() function is used to schedule events to be executed by the WordPress cron system. The function takes an array of cron event objects as its parameter. Each cron event object must contain a 'schedule' property, which defines when the event should be executed, and a 'hook' property, which is the name of the action hook that will be called when the event is executed.
_set_cron_array( array[] $cron, bool $wp_error = false ) #
Updates the cron option with the new cron array.
Parameters
- $cron
(array[])(Required)Array of cron info arrays from _get_cron_array().
- $wp_error
(bool)(Optional) Whether to return a WP_Error on failure.
Default value: false
Return
(bool|WP_Error) True if cron array updated. False or WP_Error on failure.
Source
File: wp-includes/cron.php
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; }
Expand full source codeCollapse full source codeView on TracView on GitHub
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. |