WordPress 4.4
[autoinstalls/wordpress.git] / wp-includes / cron.php
index fc876147cc8ef007e0433713514d310d2ae09b8b..60492c5d045a97391afe096989c4aeb675250592 100644 (file)
  * 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.
+ * @return false|void False when an event is not scheduled.
  */
 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
+       // Make sure timestamp is a positive integer
+       if ( ! is_numeric( $timestamp ) || $timestamp <= 0 ) {
+               return false;
+       }
+
+       // 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 + 10 * MINUTE_IN_SECONDS )
-               return;
+       if ( $next && abs( $next - $timestamp ) <= 10 * MINUTE_IN_SECONDS ) {
+               return false;
+       }
 
        $crons = _get_cron_array();
        $event = (object) array( 'hook' => $hook, 'timestamp' => $timestamp, 'schedule' => false, 'args' => $args );
@@ -65,9 +72,14 @@ function wp_schedule_single_event( $timestamp, $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 complete with scheduling event.
+ * @return false|void False when an event is not 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();
 
@@ -98,9 +110,14 @@ 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|void False when an event is not scheduled.
  */
 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 ) );
@@ -144,8 +161,14 @@ function wp_reschedule_event( $timestamp, $recurrence, $hook, $args = array() )
  * 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 when an event is not 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] );
@@ -194,7 +217,7 @@ function wp_clear_scheduled_hook( $hook, $args = array() ) {
  *
  * @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|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();
@@ -212,11 +235,8 @@ function wp_next_scheduled( $hook, $args = array() ) {
  * Send 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.
  */
 function spawn_cron( $gmt_time = 0 ) {
-
        if ( ! $gmt_time )
                $gmt_time = microtime( true );
 
@@ -224,9 +244,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 )
@@ -245,9 +268,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 );
@@ -264,6 +288,7 @@ 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 );
 
@@ -292,7 +317,7 @@ 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 )
                )
        ) );
@@ -304,11 +329,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;
@@ -347,17 +369,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 <code>__('Once Weekly')</code>.
+ * be `__( 'Once Weekly' )`.
  *
  * For your plugin, you will be passed an array. you can easily add your
  * schedule by doing the following.
- * <code>
- * // filter parameter variable name is 'array'
- *     $array['weekly'] = array(
- *             'interval' => 604800,
- *             'display' => __('Once Weekly')
- *     );
- * </code>
+ *
+ *     // Filter parameter variable name is 'array'.
+ *     $array['weekly'] = array(
+ *         'interval' => 604800,
+ *                'display'  => __( 'Once Weekly' )
+ *     );
+ *
  *
  * @since 2.1.0
  *
@@ -386,7 +408,7 @@ function wp_get_schedules() {
  *
  * @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.
+ * @return string|false False, if no schedule. Schedule on success.
  */
 function wp_get_schedule($hook, $args = array()) {
        $crons = _get_cron_array();
@@ -410,7 +432,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');