X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/d3b1ea255664edd2deef17f900a655613d20820d..f5fcdc7994bb67cce809bc4777944ae8b7fad4a4:/wp-includes/cron.php
diff --git a/wp-includes/cron.php b/wp-includes/cron.php
index be9ea67e..4b755068 100644
--- a/wp-includes/cron.php
+++ b/wp-includes/cron.php
@@ -8,26 +8,42 @@
/**
* Schedules a hook to run only once.
*
- * Schedules a hook which will be executed once by the Wordpress actions core at
+ * Schedules a hook which will be executed once by the WordPress actions core at
* a time which you specify. The action will fire off when someone visits your
* WordPress site, if the schedule time has passed.
*
* @since 2.1.0
- * @link http://codex.wordpress.org/Function_Reference/wp_schedule_single_event
+ * @link https://codex.wordpress.org/Function_Reference/wp_schedule_single_event
*
* @param int $timestamp Timestamp for when to run the event.
* @param string $hook Action hook to execute when cron is run.
* @param array $args Optional. Arguments to pass to the hook's callback function.
*/
function wp_schedule_single_event( $timestamp, $hook, $args = array()) {
- // don't schedule a duplicate if there's already an identical event due in the next 10 minutes
+ // don't schedule a duplicate if there's already an identical event due within 10 minutes of it
$next = wp_next_scheduled($hook, $args);
- if ( $next && $next <= $timestamp + 600 )
+ if ( $next && abs( $next - $timestamp ) <= 10 * MINUTE_IN_SECONDS ) {
return;
+ }
$crons = _get_cron_array();
- $key = md5(serialize($args));
- $crons[$timestamp][$hook][$key] = array( 'schedule' => false, 'args' => $args );
+ $event = (object) array( 'hook' => $hook, 'timestamp' => $timestamp, 'schedule' => false, 'args' => $args );
+ /**
+ * Filter a single event before it is scheduled.
+ *
+ * @since 3.1.0
+ *
+ * @param object $event An object containing an event's data.
+ */
+ $event = apply_filters( 'schedule_event', $event );
+
+ // A plugin disallowed this event
+ if ( ! $event )
+ return false;
+
+ $key = md5(serialize($event->args));
+
+ $crons[$event->timestamp][$event->hook][$key] = array( 'schedule' => $event->schedule, 'args' => $event->args );
uksort( $crons, "strnatcasecmp" );
_set_cron_array( $crons );
}
@@ -39,24 +55,37 @@ function wp_schedule_single_event( $timestamp, $hook, $args = array()) {
* 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
+ * Valid values for the recurrence are hourly, daily and twicedaily. These can
* be extended using the 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 string $recurrence How often the event should recur.
* @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 bool|null False on failure, null when complete with scheduling event.
+ * @return false|null False on failure, null when complete with scheduling event.
*/
function wp_schedule_event( $timestamp, $recurrence, $hook, $args = array()) {
$crons = _get_cron_array();
$schedules = wp_get_schedules();
- $key = md5(serialize($args));
+
if ( !isset( $schedules[$recurrence] ) )
return false;
- $crons[$timestamp][$hook][$key] = array( 'schedule' => $recurrence, 'args' => $args, 'interval' => $schedules[$recurrence]['interval'] );
+
+ $event = (object) array( 'hook' => $hook, 'timestamp' => $timestamp, 'schedule' => $recurrence, 'args' => $args, 'interval' => $schedules[$recurrence]['interval'] );
+ /** This filter is documented in wp-includes/cron.php */
+ $event = apply_filters( 'schedule_event', $event );
+
+ // A plugin disallowed this event
+ if ( ! $event )
+ return false;
+
+ $key = md5(serialize($event->args));
+
+ $crons[$event->timestamp][$event->hook][$key] = array( 'schedule' => $event->schedule, 'args' => $event->args, 'interval' => $event->interval );
uksort( $crons, "strnatcasecmp" );
_set_cron_array( $crons );
}
@@ -70,30 +99,34 @@ function wp_schedule_event( $timestamp, $recurrence, $hook, $args = array()) {
* @param string $recurrence How often the event should recur.
* @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 bool|null False on failure. Null when event is rescheduled.
+ * @return false|null False on failure. Null when event is rescheduled.
*/
-function wp_reschedule_event( $timestamp, $recurrence, $hook, $args = array()) {
+function wp_reschedule_event( $timestamp, $recurrence, $hook, $args = array() ) {
$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 )
- $timestamp = $now + $interval;
- else
- $timestamp = $now + ($interval - (($now - $timestamp) % $interval));
+ if ( $timestamp >= $now ) {
+ $timestamp = $now + $interval;
+ } else {
+ $timestamp = $now + ( $interval - ( ( $now - $timestamp ) % $interval ) );
+ }
wp_schedule_event( $timestamp, $recurrence, $hook, $args );
}
@@ -130,13 +163,29 @@ function wp_unschedule_event( $timestamp, $hook, $args = array() ) {
* @since 2.1.0
*
* @param string $hook Action hook, the execution of which will be unscheduled.
- * @param mixed $args,... Optional. Event arguments.
+ * @param array $args Optional. Arguments that were to be pass to the hook's callback function.
*/
-function wp_clear_scheduled_hook( $hook ) {
- $args = array_slice( func_get_args(), 1 );
+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.') );
+ $args = array_slice( func_get_args(), 1 );
+ }
- while ( $timestamp = wp_next_scheduled( $hook, $args ) )
- wp_unschedule_event( $timestamp, $hook, $args );
+ // This logic duplicates wp_next_scheduled()
+ // It's required due to a scenario where wp_unschedule_event() fails due to update_option() failing,
+ // and, wp_next_scheduled() returns the same schedule in an infinite loop.
+ $crons = _get_cron_array();
+ if ( empty( $crons ) )
+ return;
+
+ $key = md5( serialize( $args ) );
+ foreach ( $crons as $timestamp => $cron ) {
+ if ( isset( $cron[ $hook ][ $key ] ) ) {
+ wp_unschedule_event( $timestamp, $hook, $args );
+ }
+ }
}
/**
@@ -167,33 +216,25 @@ function wp_next_scheduled( $hook, $args = array() ) {
*
* @return null Cron could not be spawned, because it is not needed to run.
*/
-function spawn_cron( $local_time = 0 ) {
+function spawn_cron( $gmt_time = 0 ) {
- if ( !$local_time )
- $local_time = time();
+ if ( ! $gmt_time )
+ $gmt_time = microtime( true );
if ( defined('DOING_CRON') || isset($_GET['doing_wp_cron']) )
return;
- /*
- * do not even start the cron if local server timer has drifted
- * such as due to power failure, or misconfiguration
- */
- $timer_accurate = check_server_timer( $local_time );
- if ( !$timer_accurate )
- 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
*/
- $flag = get_transient('doing_cron');
+ $lock = get_transient('doing_cron');
- if ( $flag > $local_time + 10*60 )
- $flag = 0;
+ if ( $lock > $gmt_time + 10 * MINUTE_IN_SECONDS )
+ $lock = 0;
// don't run if another process is currently running it or more than once every 60 sec.
- if ( $flag + 60 > $local_time )
+ if ( $lock + WP_CRON_LOCK_TIMEOUT > $gmt_time )
return;
//sanity check
@@ -202,31 +243,63 @@ function spawn_cron( $local_time = 0 ) {
return;
$keys = array_keys( $crons );
- if ( isset($keys[0]) && $keys[0] > $local_time )
+ 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 ( ! empty( $_POST ) || defined( 'DOING_AJAX' ) || defined( 'XMLRPC_REQUEST' ) ) {
return;
+ }
- set_transient( 'doing_cron', $local_time );
+ $doing_wp_cron = sprintf( '%.22F', $gmt_time );
+ set_transient( 'doing_cron', $doing_wp_cron );
ob_start();
- wp_redirect( add_query_arg('doing_wp_cron', '', stripslashes($_SERVER['REQUEST_URI'])) );
+ wp_redirect( add_query_arg( 'doing_wp_cron', $doing_wp_cron, wp_unslash( $_SERVER['REQUEST_URI'] ) ) );
echo ' ';
// flush any buffers and send the headers
while ( @ob_end_flush() );
flush();
- @include_once(ABSPATH . 'wp-cron.php');
+ WP_DEBUG ? include_once( ABSPATH . 'wp-cron.php' ) : @include_once( ABSPATH . 'wp-cron.php' );
return;
}
- set_transient( 'doing_cron', $local_time );
-
- $cron_url = get_option( 'siteurl' ) . '/wp-cron.php?doing_wp_cron';
- wp_remote_post( $cron_url, array('timeout' => 0.01, 'blocking' => false, 'sslverify' => apply_filters('https_local_ssl_verify', true)) );
+ $doing_wp_cron = sprintf( '%.22F', $gmt_time );
+ set_transient( 'doing_cron', $doing_wp_cron );
+
+ /**
+ * Filter the cron request arguments.
+ *
+ * @since 3.5.0
+ *
+ * @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.
+ * }
+ * }
+ */
+ $cron_request = apply_filters( 'cron_request', array(
+ '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-http.php */
+ 'sslverify' => apply_filters( 'https_local_ssl_verify', false )
+ )
+ ) );
+
+ wp_remote_post( $cron_request['url'], $cron_request['args'] );
}
/**
@@ -245,18 +318,18 @@ function wp_cron() {
if ( false === $crons = _get_cron_array() )
return;
- $local_time = time();
+ $gmt_time = microtime( true );
$keys = array_keys( $crons );
- if ( isset($keys[0]) && $keys[0] > $local_time )
+ if ( isset($keys[0]) && $keys[0] > $gmt_time )
return;
$schedules = wp_get_schedules();
foreach ( $crons as $timestamp => $cronhooks ) {
- if ( $timestamp > $local_time ) break;
+ if ( $timestamp > $gmt_time ) break;
foreach ( (array) $cronhooks as $hook => $args ) {
if ( isset($schedules[$hook]['callback']) && !call_user_func( $schedules[$hook]['callback'] ) )
continue;
- spawn_cron( $local_time );
+ spawn_cron( $gmt_time );
break 2;
}
}
@@ -276,17 +349,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
*
@@ -294,10 +367,17 @@ function wp_cron() {
*/
function wp_get_schedules() {
$schedules = array(
- 'hourly' => array( 'interval' => 3600, 'display' => __('Once Hourly') ),
- 'twicedaily' => array( 'interval' => 43200, 'display' => __('Twice Daily') ),
- 'daily' => array( 'interval' => 86400, 'display' => __('Once Daily') ),
+ 'hourly' => array( 'interval' => HOUR_IN_SECONDS, 'display' => __( 'Once Hourly' ) ),
+ 'twicedaily' => array( 'interval' => 12 * HOUR_IN_SECONDS, 'display' => __( 'Twice Daily' ) ),
+ 'daily' => array( 'interval' => DAY_IN_SECONDS, 'display' => __( 'Once Daily' ) ),
);
+ /**
+ * Filter 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 );
}
@@ -388,10 +468,3 @@ function _upgrade_cron_array($cron) {
update_option( 'cron', $new_cron );
return $new_cron;
}
-
-// stub for checking server timer accuracy, using outside standard time sources
-function check_server_timer( $local_time ) {
- return true;
-}
-
-?>