X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/53f4633144ed68c8b8fb5861f992b5489894a940..refs/tags/wordpress-4.7.1:/wp-includes/cron.php diff --git a/wp-includes/cron.php b/wp-includes/cron.php index 8b88c122..f7e444b8 100644 --- a/wp-includes/cron.php +++ b/wp-includes/cron.php @@ -1,40 +1,56 @@ $hook, 'timestamp' => $timestamp, 'schedule' => false, 'args' => $args ); /** - * Filter a single event before it is scheduled. + * Filters a single event before it is scheduled. * * @since 3.1.0 * - * @param object $event An object containing an event's data. + * @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 ); @@ -50,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 false|void False when does not schedule 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(); @@ -96,13 +117,18 @@ 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 false|void False when does not schedule event. + * @return false|void False if the event does not get rescheduled. */ 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 ) ); @@ -133,21 +159,27 @@ function wp_reschedule_event( $timestamp, $recurrence, $hook, $args = array() ) } /** - * 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] ); @@ -159,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 ); } @@ -190,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 false|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(); @@ -211,9 +243,11 @@ 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 + * + * @param int $gmt_time Optional. Unix timestamp (UTC). Default 0 (current time is used). */ function spawn_cron( $gmt_time = 0 ) { if ( ! $gmt_time ) @@ -223,7 +257,7 @@ function spawn_cron( $gmt_time = 0 ) { return; /* - * Get the cron lock, which is a unix timestamp of when the last cron was spawned + * 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, @@ -248,7 +282,7 @@ function spawn_cron( $gmt_time = 0 ) { return; if ( defined( 'ALTERNATE_WP_CRON' ) && ALTERNATE_WP_CRON ) { - if ( ! empty( $_POST ) || defined( 'DOING_AJAX' ) || defined( 'XMLRPC_REQUEST' ) ) { + if ( 'GET' !== $_SERVER['REQUEST_METHOD'] || defined( 'DOING_AJAX' ) || defined( 'XMLRPC_REQUEST' ) ) { return; } @@ -272,9 +306,10 @@ function spawn_cron( $gmt_time = 0 ) { set_transient( 'doing_cron', $doing_wp_cron ); /** - * Filter the cron request arguments. + * 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. @@ -289,6 +324,7 @@ function spawn_cron( $gmt_time = 0 ) { * @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' => add_query_arg( 'doing_wp_cron', $doing_wp_cron, site_url( 'wp-cron.php' ) ), @@ -296,10 +332,10 @@ function spawn_cron( $gmt_time = 0 ) { 'args' => array( 'timeout' => 0.01, 'blocking' => false, - /** This filter is documented in wp-includes/class-http.php */ + /** 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'] ); } @@ -335,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'. * @@ -371,7 +407,7 @@ function wp_get_schedules() { 'daily' => array( 'interval' => DAY_IN_SECONDS, 'display' => __( 'Once Daily' ) ), ); /** - * Filter the non-default cron schedules. + * Filters the non-default cron schedules. * * @since 2.1.0 * @@ -381,13 +417,15 @@ function wp_get_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|false 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(); @@ -432,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; @@ -447,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) {