X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/42aebe6945a3a60c8f73853bea2c8b202d64a20b..e3ff8f35458a959c1879c0a4976701ed8dcfe651:/wp-includes/cron.php diff --git a/wp-includes/cron.php b/wp-includes/cron.php index 1c68e146..f7e444b8 100644 --- a/wp-includes/cron.php +++ b/wp-includes/cron.php @@ -1,33 +1,58 @@ $hook, 'timestamp' => $timestamp, 'schedule' => false, 'args' => $args ); - $event = apply_filters('schedule_event', $event); + /** + * Filters a single event before it is scheduled. + * + * @since 3.1.0 + * + * @param stdClass $event { + * An object containing an event's data. + * + * @type string $hook Action hook to execute when event is run. + * @type int $timestamp Unix timestamp (UTC) for when to run the event. + * @type string|false $schedule How often the event should recur. See `wp_get_schedules()`. + * @type array $args Arguments to pass to the hook's callback function. + * } + */ + $event = apply_filters( 'schedule_event', $event ); // A plugin disallowed this event if ( ! $event ) @@ -41,26 +66,31 @@ function wp_schedule_single_event( $timestamp, $hook, $args = array()) { } /** - * Schedule a periodic event. + * Schedule a recurring event. * * Schedules a hook which will be executed by the WordPress actions core on a * specific interval, specified by you. The action will trigger when someone * visits your WordPress site, if the scheduled time has passed. * - * Valid values for the recurrence are hourly, daily and twicedaily. These can - * be extended using the cron_schedules filter in wp_get_schedules(). + * Valid values for the recurrence are hourly, daily, and twicedaily. These can + * be extended using the {@see 'cron_schedules'} filter in wp_get_schedules(). * * Use wp_next_scheduled() to prevent duplicates * * @since 2.1.0 * - * @param int $timestamp Timestamp for when to run the event. + * @param int $timestamp Unix timestamp (UTC) for when to run the event. * @param string $recurrence How often the event should recur. - * @param string $hook Action hook to execute when cron is run. + * @param string $hook Action hook to execute when event is run. * @param array $args Optional. Arguments to pass to the hook's callback function. - * @return bool|null False on failure, null when complete with scheduling event. + * @return false|void False if the event does not get scheduled. */ function wp_schedule_event( $timestamp, $recurrence, $hook, $args = array()) { + // Make sure timestamp is a positive integer + if ( ! is_numeric( $timestamp ) || $timestamp <= 0 ) { + return false; + } + $crons = _get_cron_array(); $schedules = wp_get_schedules(); @@ -68,7 +98,8 @@ function wp_schedule_event( $timestamp, $recurrence, $hook, $args = array()) { return false; $event = (object) array( 'hook' => $hook, 'timestamp' => $timestamp, 'schedule' => $recurrence, 'args' => $args, 'interval' => $schedules[$recurrence]['interval'] ); - $event = apply_filters('schedule_event', $event); + /** This filter is documented in wp-includes/cron.php */ + $event = apply_filters( 'schedule_event', $event ); // A plugin disallowed this event if ( ! $event ) @@ -86,54 +117,69 @@ function wp_schedule_event( $timestamp, $recurrence, $hook, $args = array()) { * * @since 2.1.0 * - * @param int $timestamp Timestamp for when to run the event. + * @param int $timestamp Unix timestamp (UTC) for when to run the event. * @param string $recurrence How often the event should recur. - * @param string $hook Action hook to execute when cron is run. + * @param string $hook Action hook to execute when event is run. * @param array $args Optional. Arguments to pass to the hook's callback function. - * @return bool|null False on failure. Null when event is rescheduled. + * @return false|void False if the event does not get rescheduled. */ -function wp_reschedule_event( $timestamp, $recurrence, $hook, $args = array()) { +function wp_reschedule_event( $timestamp, $recurrence, $hook, $args = array() ) { + // Make sure timestamp is a positive integer + if ( ! is_numeric( $timestamp ) || $timestamp <= 0 ) { + return false; + } + $crons = _get_cron_array(); $schedules = wp_get_schedules(); - $key = md5(serialize($args)); + $key = md5( serialize( $args ) ); $interval = 0; // First we try to get it from the schedule - if ( 0 == $interval ) - $interval = $schedules[$recurrence]['interval']; + if ( isset( $schedules[ $recurrence ] ) ) { + $interval = $schedules[ $recurrence ]['interval']; + } // Now we try to get it from the saved interval in case the schedule disappears - if ( 0 == $interval ) - $interval = $crons[$timestamp][$hook][$key]['interval']; + if ( 0 == $interval ) { + $interval = $crons[ $timestamp ][ $hook ][ $key ]['interval']; + } // Now we assume something is wrong and fail to schedule - if ( 0 == $interval ) + if ( 0 == $interval ) { return false; + } $now = time(); - if ( $timestamp >= $now ) + if ( $timestamp >= $now ) { $timestamp = $now + $interval; - else - $timestamp = $now + ($interval - (($now - $timestamp) % $interval)); + } else { + $timestamp = $now + ( $interval - ( ( $now - $timestamp ) % $interval ) ); + } wp_schedule_event( $timestamp, $recurrence, $hook, $args ); } /** - * Unschedule a previously scheduled cron job. + * Unschedule a previously scheduled event. * - * The $timestamp and $hook parameters are required, so that the event can be + * The $timestamp and $hook parameters are required so that the event can be * identified. * * @since 2.1.0 * - * @param int $timestamp Timestamp for when to run the event. + * @param int $timestamp Unix timestamp (UTC) for when to run the event. * @param string $hook Action hook, the execution of which will be unscheduled. * @param array $args Arguments to pass to the hook's callback function. * Although not passed to a callback function, these arguments are used * to uniquely identify the scheduled event, so they should be the same * as those used when originally scheduling the event. + * @return false|void False if the event does not get unscheduled. */ function wp_unschedule_event( $timestamp, $hook, $args = array() ) { + // Make sure timestamp is a positive integer + if ( ! is_numeric( $timestamp ) || $timestamp <= 0 ) { + return false; + } + $crons = _get_cron_array(); $key = md5(serialize($args)); unset( $crons[$timestamp][$hook][$key] ); @@ -145,18 +191,18 @@ function wp_unschedule_event( $timestamp, $hook, $args = array() ) { } /** - * Unschedule all cron jobs attached to a specific hook. + * Unschedule all events attached to the specified hook. * * @since 2.1.0 * * @param string $hook Action hook, the execution of which will be unscheduled. - * @param array $args Optional. Arguments that were to be pass to the hook's callback function. + * @param array $args Optional. Arguments that were to be passed to the hook's callback function. */ function wp_clear_scheduled_hook( $hook, $args = array() ) { // Backward compatibility // Previously this function took the arguments as discrete vars rather than an array like the rest of the API if ( !is_array($args) ) { - _deprecated_argument( __FUNCTION__, '3.0', __('This argument has changed to an array to match the behavior of the other cron functions.') ); + _deprecated_argument( __FUNCTION__, '3.0.0', __('This argument has changed to an array to match the behavior of the other cron functions.') ); $args = array_slice( func_get_args(), 1 ); } @@ -176,13 +222,13 @@ function wp_clear_scheduled_hook( $hook, $args = array() ) { } /** - * Retrieve the next timestamp for a cron event. + * Retrieve the next timestamp for an event. * * @since 2.1.0 * - * @param string $hook Action hook to execute when cron is run. + * @param string $hook Action hook to execute when event is run. * @param array $args Optional. Arguments to pass to the hook's callback function. - * @return bool|int The UNIX timestamp of the next time the scheduled event will occur. + * @return false|int The Unix timestamp of the next time the scheduled event will occur. */ function wp_next_scheduled( $hook, $args = array() ) { $crons = _get_cron_array(); @@ -197,14 +243,13 @@ function wp_next_scheduled( $hook, $args = array() ) { } /** - * Send request to run cron through HTTP request that doesn't halt page loading. + * Sends a request to run cron through HTTP request that doesn't halt page loading. * * @since 2.1.0 * - * @return null Cron could not be spawned, because it is not needed to run. + * @param int $gmt_time Optional. Unix timestamp (UTC). Default 0 (current time is used). */ function spawn_cron( $gmt_time = 0 ) { - if ( ! $gmt_time ) $gmt_time = microtime( true ); @@ -212,9 +257,12 @@ function spawn_cron( $gmt_time = 0 ) { return; /* - * multiple processes on multiple web servers can run this code concurrently - * try to make this as atomic as possible by setting doing_cron switch - */ + * Get the cron lock, which is a Unix timestamp of when the last cron was spawned + * and has not finished running. + * + * Multiple processes on multiple web servers can run this code concurrently, + * this lock attempts to make spawning as atomic as possible. + */ $lock = get_transient('doing_cron'); if ( $lock > $gmt_time + 10 * MINUTE_IN_SECONDS ) @@ -233,9 +281,10 @@ function spawn_cron( $gmt_time = 0 ) { if ( isset($keys[0]) && $keys[0] > $gmt_time ) return; - if ( defined('ALTERNATE_WP_CRON') && ALTERNATE_WP_CRON ) { - if ( !empty($_POST) || defined('DOING_AJAX') ) + if ( defined( 'ALTERNATE_WP_CRON' ) && ALTERNATE_WP_CRON ) { + if ( 'GET' !== $_SERVER['REQUEST_METHOD'] || defined( 'DOING_AJAX' ) || defined( 'XMLRPC_REQUEST' ) ) { return; + } $doing_wp_cron = sprintf( '%.22F', $gmt_time ); set_transient( 'doing_cron', $doing_wp_cron ); @@ -252,14 +301,41 @@ function spawn_cron( $gmt_time = 0 ) { return; } + // Set the cron lock with the current unix timestamp, when the cron is being spawned. $doing_wp_cron = sprintf( '%.22F', $gmt_time ); set_transient( 'doing_cron', $doing_wp_cron ); + /** + * Filters the cron request arguments. + * + * @since 3.5.0 + * @since 4.5.0 The `$doing_wp_cron` parameter was added. + * + * @param array $cron_request_array { + * An array of cron request URL arguments. + * + * @type string $url The cron request URL. + * @type int $key The 22 digit GMT microtime. + * @type array $args { + * An array of cron request arguments. + * + * @type int $timeout The request timeout in seconds. Default .01 seconds. + * @type bool $blocking Whether to set blocking for the request. Default false. + * @type bool $sslverify Whether SSL should be verified for the request. Default false. + * } + * } + * @param string $doing_wp_cron The unix timestamp of the cron lock. + */ $cron_request = apply_filters( 'cron_request', array( - 'url' => site_url( 'wp-cron.php?doing_wp_cron=' . $doing_wp_cron ), - 'key' => $doing_wp_cron, - 'args' => array( 'timeout' => 0.01, 'blocking' => false, 'sslverify' => apply_filters( 'https_local_ssl_verify', true ) ) - ) ); + 'url' => add_query_arg( 'doing_wp_cron', $doing_wp_cron, site_url( 'wp-cron.php' ) ), + 'key' => $doing_wp_cron, + 'args' => array( + 'timeout' => 0.01, + 'blocking' => false, + /** This filter is documented in wp-includes/class-wp-http-streams.php */ + 'sslverify' => apply_filters( 'https_local_ssl_verify', false ) + ) + ), $doing_wp_cron ); wp_remote_post( $cron_request['url'], $cron_request['args'] ); } @@ -268,11 +344,8 @@ function spawn_cron( $gmt_time = 0 ) { * Run scheduled callbacks or spawn cron for all scheduled events. * * @since 2.1.0 - * - * @return null When doesn't need to run Cron. */ function wp_cron() { - // Prevent infinite loops caused by lack of wp-cron.php if ( strpos($_SERVER['REQUEST_URI'], '/wp-cron.php') !== false || ( defined('DISABLE_WP_CRON') && DISABLE_WP_CRON ) ) return; @@ -298,11 +371,11 @@ function wp_cron() { } /** - * Retrieve supported and filtered Cron recurrences. + * Retrieve supported event recurrence schedules. * - * The supported recurrences are 'hourly' and 'daily'. A plugin may add more by - * hooking into the 'cron_schedules' filter. The filter accepts an array of - * arrays. The outer array has a key that is the name of the schedule or for + * The default supported recurrences are 'hourly', 'twicedaily', and 'daily'. A plugin may + * add more by hooking into the {@see 'cron_schedules'} filter. The filter accepts an array + * of arrays. The outer array has a key that is the name of the schedule or for * example 'weekly'. The value is an array with two keys, one is 'interval' and * the other is 'display'. * @@ -311,17 +384,17 @@ function wp_cron() { * 60*60*24*7 or 604800. The value of 'interval' would then be 604800. * * The 'display' is the description. For the 'weekly' key, the 'display' would - * be __('Once Weekly'). + * be `__( 'Once Weekly' )`. * * For your plugin, you will be passed an array. you can easily add your * schedule by doing the following. - * - * // filter parameter variable name is 'array' - * $array['weekly'] = array( - * 'interval' => 604800, - * 'display' => __('Once Weekly') - * ); - * + * + * // Filter parameter variable name is 'array'. + * $array['weekly'] = array( + * 'interval' => 604800, + * 'display' => __( 'Once Weekly' ) + * ); + * * * @since 2.1.0 * @@ -333,17 +406,26 @@ function wp_get_schedules() { 'twicedaily' => array( 'interval' => 12 * HOUR_IN_SECONDS, 'display' => __( 'Twice Daily' ) ), 'daily' => array( 'interval' => DAY_IN_SECONDS, 'display' => __( 'Once Daily' ) ), ); + /** + * Filters the non-default cron schedules. + * + * @since 2.1.0 + * + * @param array $new_schedules An array of non-default cron schedules. Default empty. + */ return array_merge( apply_filters( 'cron_schedules', array() ), $schedules ); } /** - * Retrieve Cron schedule for hook with arguments. + * Retrieve the recurrence schedule for an event. + * + * @see wp_get_schedules() for available schedules. * * @since 2.1.0 * - * @param string $hook Action hook to execute when cron is run. - * @param array $args Optional. Arguments to pass to the hook's callback function. - * @return string|bool False, if no schedule. Schedule on success. + * @param string $hook Action hook to identify the event. + * @param array $args Optional. Arguments passed to the event's callback function. + * @return string|false False, if no schedule. Schedule name on success. */ function wp_get_schedule($hook, $args = array()) { $crons = _get_cron_array(); @@ -367,7 +449,7 @@ function wp_get_schedule($hook, $args = array()) { * @since 2.1.0 * @access private * - * @return array CRON info array. + * @return false|array CRON info array. */ function _get_cron_array() { $cron = get_option('cron'); @@ -388,7 +470,7 @@ function _get_cron_array() { * @since 2.1.0 * @access private * - * @param array $cron Cron info array from {@link _get_cron_array()}. + * @param array $cron Cron info array from _get_cron_array(). */ function _set_cron_array($cron) { $cron['version'] = 2; @@ -403,7 +485,7 @@ function _set_cron_array($cron) { * @since 2.1.0 * @access private * - * @param array $cron Cron info array from {@link _get_cron_array()}. + * @param array $cron Cron info array from _get_cron_array(). * @return array An upgraded Cron info array. */ function _upgrade_cron_array($cron) {