Changeset 43050

Timestamp:

05/01/2018 02:04:25 AM (7 years ago)

Author:

peterwilsoncc

Message:

Cron API: Return meaningful values from cron functions.

Return values added to Cron API functions to indicate outcome:

• wp_schedule_single_event(), wp_schedule_event(), wp_reschedule_event() and wp_unschedule_event(): boolean indicating success or failure,
• wp_clear_scheduled_hook(): integer indicating number of jobs cleared (zero or more), false if one or more jobs fail to clear,
• wp_unschedule_hook(): integer indicating number of jobs cleared (zero or more), false if the jobs fail to clear,
• spawn_cron(): boolean indicating whether job spawned,
• wp_cron(): integer indicating number of jobs spawned (zero or more), false if one or more jobs fail to spawned,
• _set_cron_array(): boolean outcome of update_option().

Props evansolomon, jrf, peterwilsoncc, pento for code review.
Fixes #21072.

Location:

trunk

Files:

• src/wp-includes/cron.php (modified) (26 diffs)
• tests/phpunit/tests/cron.php (modified) (11 diffs)

trunk/src/wp-includes/cron.php

@@ -22 +22 @@
  *
  * @since 2.1.0
+ * @since 5.0.0 Return value modified to boolean indicating success or failure.
+ *
  * @link https://codex.wordpress.org/Function_Reference/wp_schedule_single_event
  *
@@ -27 +29 @@
  * @param string $hook       Action hook to execute when the event is run.
  * @param array  $args       Optional. Array containing each separate argument to pass to the hook's callback function.
- * @return false|void False if the event did not get scheduled.
+ * @return bool True if event successfully scheduled. False for failure.
  */
 function wp_schedule_single_event( $timestamp, $hook, $args = array() ) {
@@ -78 +80 @@
     );
     uksort( $crons, 'strnatcasecmp' );
-    _set_cron_array( $crons );
+    return _set_cron_array( $crons );
 }
 
@@ -100 +102 @@
  *
  * @since 2.1.0
+ * @since 5.0.0 Return value modified to boolean indicating success or failure.
+ *
  * @link https://codex.wordpress.org/Function_Reference/wp_schedule_event
  *
@@ -106 +110 @@
  * @param string $hook       Action hook to execute when the event is run.
  * @param array  $args       Optional. Array containing each separate argument to pass to the hook's callback function.
- * @return false|void False if the event did not get scheduled.
+ * @return bool True if event successfully scheduled. False for failure.
  */
 function wp_schedule_event( $timestamp, $recurrence, $hook, $args = array() ) {
@@ -144 +148 @@
     );
     uksort( $crons, 'strnatcasecmp' );
-    _set_cron_array( $crons );
+    return _set_cron_array( $crons );
 }
 
@@ -151 +155 @@
  *
  * @since 2.1.0
+ * @since 5.0.0 Return value modified to boolean indicating success or failure.
  *
  * @param int    $timestamp  Unix timestamp (UTC) for when to next run the event.
@@ -156 +161 @@
  * @param string $hook       Action hook to execute when the event is run.
  * @param array  $args       Optional. Array containing each separate argument to pass to the hook's callback function.
- * @return false|void False if the event did not get rescheduled.
+ * @return bool True if event successfully rescheduled. False for failure.
  */
 function wp_reschedule_event( $timestamp, $recurrence, $hook, $args = array() ) {
@@ -190 +195 @@
     }
 
-    wp_schedule_event( $timestamp, $recurrence, $hook, $args );
+    return wp_schedule_event( $timestamp, $recurrence, $hook, $args );
 }
 
@@ -200 +205 @@
  *
  * @since 2.1.0
+ * @since 5.0.0 Return value modified to boolean indicating success or failure.
  *
  * @param int    $timestamp Unix timestamp (UTC) of the event.
@@ -206 +212 @@
  *                          Although not passed to a callback, these arguments are used to uniquely identify the
  *                          event, so they should be the same as those used when originally scheduling the event.
- * @return false|void False if the event did not get unscheduled.
+ * @return bool True if event successfully unscheduled. False for failure.
  */
 function wp_unschedule_event( $timestamp, $hook, $args = array() ) {
@@ -223 +229 @@
         unset( $crons[ $timestamp ] );
     }
-    _set_cron_array( $crons );
+    return _set_cron_array( $crons );
 }
 
@@ -229 +235 @@
  * Unschedules all events attached to the hook with the specified arguments.
  *
- * @since 2.1.0
+ * Warning: This function may return Boolean FALSE, but may also return a non-Boolean
+ * value which evaluates to FALSE. For information about casting to booleans see the
+ * {@link https://php.net/manual/en/language.types.boolean.php PHP documentation}. Use
+ * the `===` operator for testing the return value of this function.
+ *
+ * @since 2.1.0
+ * @since 5.0.0 Return value modified to indicate success or failure.
  *
  * @param string $hook Action hook, the execution of which will be unscheduled.
  * @param array $args Optional. Arguments that were to be passed to the hook's callback function.
+ * @return bool|int On success an integer indicating number of events unscheduled (0 indicates no
+ *                  events were registered with the hook and arguments combination), false if
+ *                  unscheduling one or more events fail.
  */
 function wp_clear_scheduled_hook( $hook, $args = array() ) {
@@ -247 +262 @@
     $crons = _get_cron_array();
     if ( empty( $crons ) ) {
-        return;
-    }
-
-    $key = md5( serialize( $args ) );
+        return 0;
+    }
+
+    $results = array();
+    $key     = md5( serialize( $args ) );
     foreach ( $crons as $timestamp => $cron ) {
         if ( isset( $cron[ $hook ][ $key ] ) ) {
-            wp_unschedule_event( $timestamp, $hook, $args );
-        }
-    }
+            $results[] = wp_unschedule_event( $timestamp, $hook, $args );
+        }
+    }
+    if ( in_array( false, $results, true ) ) {
+        return false;
+    }
+    return count( $results );
 }
 
@@ -263 +283 @@
  * Can be useful for plugins when deactivating to clean up the cron queue.
  *
+ * Warning: This function may return Boolean FALSE, but may also return a non-Boolean
+ * value which evaluates to FALSE. For information about casting to booleans see the
+ * {@link https://php.net/manual/en/language.types.boolean.php PHP documentation}. Use
+ * the `===` operator for testing the return value of this function.
+ *
  * @since 4.9.0
+ * @since 5.0.0 Return value added to indicate success or failure.
  *
  * @param string $hook Action hook, the execution of which will be unscheduled.
+ * @return bool|int On success an integer indicating number of events unscheduled (0 indicates no
+ *                  events were registered on the hook), false if unscheduling fails.
  */
 function wp_unschedule_hook( $hook ) {
     $crons = _get_cron_array();
-
+    if ( empty( $crons ) ) {
+        return 0;
+    }
+
+    $results = array();
     foreach ( $crons as $timestamp => $args ) {
+        if ( ! empty( $crons[ $timestamp ][ $hook ] ) ) {
+            $results[] = count( $crons[ $timestamp ][ $hook ] );
+        }
         unset( $crons[ $timestamp ][ $hook ] );
 
@@ -278 +313 @@
     }
 
-    _set_cron_array( $crons );
+    /*
+     * If the results are empty (zero events to unschedule), no attempt
+     * to update the cron array is required.
+     */
+    if ( empty( $results ) ) {
+        return 0;
+    }
+    if ( _set_cron_array( $crons ) ) {
+        return array_sum( $results );
+    }
+    return false;
 }
 
@@ -310 +355 @@
  *
  * @since 2.1.0
+ * @since 5.0.0 Return values added.
  *
  * @param int $gmt_time Optional. Unix timestamp (UTC). Default 0 (current time is used).
+ * @return bool True if spawned, false if no events spawned.
  */
 function spawn_cron( $gmt_time = 0 ) {
@@ -319 +366 @@
 
     if ( defined( 'DOING_CRON' ) || isset( $_GET['doing_wp_cron'] ) ) {
-        return;
+        return false;
     }
 
@@ -337 +384 @@
     // don't run if another process is currently running it or more than once every 60 sec.
     if ( $lock + WP_CRON_LOCK_TIMEOUT > $gmt_time ) {
-        return;
+        return false;
     }
 
@@ -343 +390 @@
     $crons = _get_cron_array();
     if ( ! is_array( $crons ) ) {
-        return;
+        return false;
     }
 
     $keys = array_keys( $crons );
     if ( isset( $keys[0] ) && $keys[0] > $gmt_time ) {
-        return;
+        return false;
     }
 
     if ( defined( 'ALTERNATE_WP_CRON' ) && ALTERNATE_WP_CRON ) {
         if ( 'GET' !== $_SERVER['REQUEST_METHOD'] || defined( 'DOING_AJAX' ) || defined( 'XMLRPC_REQUEST' ) ) {
-            return;
+            return false;
         }
 
@@ -369 +416 @@
 
         WP_DEBUG ? include_once( ABSPATH . 'wp-cron.php' ) : @include_once( ABSPATH . 'wp-cron.php' );
-        return;
+        return true;
     }
 
@@ -410 +457 @@
     );
 
-    wp_remote_post( $cron_request['url'], $cron_request['args'] );
+    $result = wp_remote_post( $cron_request['url'], $cron_request['args'] );
+    return ! is_wp_error( $result );
 }
 
@@ -416 +464 @@
  * Run scheduled callbacks or spawn cron for all scheduled events.
  *
- * @since 2.1.0
+ * Warning: This function may return Boolean FALSE, but may also return a non-Boolean
+ * value which evaluates to FALSE. For information about casting to booleans see the
+ * {@link https://php.net/manual/en/language.types.boolean.php PHP documentation}. Use
+ * the `===` operator for testing the return value of this function.
+ *
+ * @since 2.1.0
+ * @since 5.0.0 Return value added to indicate success or failure.
+ *
+ * @return bool|int On success an integer indicating number of events spawned (0 indicates no
+ *                  events needed to be spawned), false if spawning fails for one or more events.
  */
 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;
-    }
-
-    if ( false === $crons = _get_cron_array() ) {
-        return;
+        return 0;
+    }
+
+    $crons = _get_cron_array();
+    if ( false === $crons ) {
+        return 0;
     }
 
@@ -431 +489 @@
     $keys     = array_keys( $crons );
     if ( isset( $keys[0] ) && $keys[0] > $gmt_time ) {
-        return;
+        return 0;
     }
 
     $schedules = wp_get_schedules();
+    $results   = array();
     foreach ( $crons as $timestamp => $cronhooks ) {
         if ( $timestamp > $gmt_time ) {
@@ -443 +502 @@
                 continue;
             }
-            spawn_cron( $gmt_time );
+            $results[] = spawn_cron( $gmt_time );
             break 2;
         }
     }
+
+    if ( in_array( false, $results, true ) ) {
+        return false;
+    }
+    return count( $results );
 }
 
@@ -559 +623 @@
  *
  * @since 2.1.0
+ * @since 5.0.0 Return value modified to outcome of {@see update_option}.
+ *
  * @access private
  *
  * @param array $cron Cron info array from _get_cron_array().
+ * @return bool True if cron array updated, false on failure.
  */
 function _set_cron_array( $cron ) {
     $cron['version'] = 2;
-    update_option( 'cron', $cron );
+    return update_option( 'cron', $cron );
 }
 

trunk/tests/phpunit/tests/cron.php

@@ -30 +30 @@
         $timestamp = strtotime( '+1 hour' );
 
-        wp_schedule_single_event( $timestamp, $hook );
+        $scheduled = wp_schedule_single_event( $timestamp, $hook );
+        $this->assertTrue( $scheduled );
         $this->assertEquals( $timestamp, wp_next_scheduled( $hook ) );
 
@@ -44 +45 @@
         $args      = array( 'foo' );
 
-        wp_schedule_single_event( $timestamp, $hook, $args );
+        $scheduled = wp_schedule_single_event( $timestamp, $hook, $args );
+        $this->assertTrue( $scheduled );
         // this returns the timestamp only if we provide matching args
         $this->assertEquals( $timestamp, wp_next_scheduled( $hook, $args ) );
@@ -61 +63 @@
         $timestamp = strtotime( '+1 hour' );
 
-        wp_schedule_event( $timestamp, $recur, $hook );
+        $scheduled = wp_schedule_event( $timestamp, $recur, $hook );
+        $this->assertTrue( $scheduled );
         // it's scheduled for the right time
         $this->assertEquals( $timestamp, wp_next_scheduled( $hook ) );
@@ -75 +78 @@
         $args      = array( 'foo' );
 
-        wp_schedule_event( $timestamp, 'hourly', $hook, $args );
+        $scheduled = wp_schedule_event( $timestamp, 'hourly', $hook, $args );
+        $this->assertTrue( $scheduled );
         // this returns the timestamp only if we provide matching args
         $this->assertEquals( $timestamp, wp_next_scheduled( $hook, $args ) );
@@ -95 +99 @@
 
         // now unschedule it and make sure it's gone
-        wp_unschedule_event( $timestamp, $hook );
+        $unscheduled = wp_unschedule_event( $timestamp, $hook );
+        $this->assertTrue( $unscheduled );
         $this->assertEquals( false, wp_next_scheduled( $hook ) );
     }
@@ -114 +119 @@
 
         // clear the schedule for the no args events and make sure it's gone
-        wp_clear_scheduled_hook( $hook );
+        $hook_unscheduled = wp_clear_scheduled_hook( $hook );
+        $this->assertSame( 2, $hook_unscheduled );
         $this->assertFalse( wp_next_scheduled( $hook ) );
         // the args events should still be there
@@ -123 +129 @@
         wp_clear_scheduled_hook( $hook, $args );
         $this->assertFalse( wp_next_scheduled( $hook, $args ) );
+    }
+
+    function test_clear_undefined_schedule() {
+        $hook = __FUNCTION__;
+        $args = array( 'arg1' );
+
+        wp_schedule_single_event( strtotime( '+1 hour' ), $hook, $args );
+        wp_schedule_single_event( strtotime( '+2 hour' ), $hook, $args );
+
+        // clear the schedule for no args events and ensure no events are cleared.
+        $hook_unscheduled = wp_clear_scheduled_hook( $hook );
+        $this->assertSame( 0, $hook_unscheduled );
     }
 
@@ -207 +225 @@
 
         // clear the schedule and make sure it's gone.
-        wp_unschedule_hook( $hook );
+        $unschedule_hook = wp_unschedule_hook( $hook );
+        $this->assertSame( 4, $unschedule_hook );
+        $this->assertFalse( wp_next_scheduled( $hook ) );
+    }
+
+    function test_unschedule_undefined_hook() {
+        $hook           = __FUNCTION__;
+        $unrelated_hook = __FUNCTION__ . '_two';
+
+        // Attempt to clear schedule on non-existant hook.
+        $unschedule_hook = wp_unschedule_hook( $hook );
+        $this->assertSame( 0, $unschedule_hook );
+        $this->assertFalse( wp_next_scheduled( $hook ) );
+
+        // Repeat tests with populated cron array.
+        wp_schedule_single_event( strtotime( '+1 hour' ), $unrelated_hook );
+        wp_schedule_single_event( strtotime( '+2 hour' ), $unrelated_hook );
+
+        $unschedule_hook = wp_unschedule_hook( $hook );
+        $this->assertSame( 0, $unschedule_hook );
         $this->assertFalse( wp_next_scheduled( $hook ) );
     }
@@ -222 +259 @@
 
         // first one works
-        wp_schedule_single_event( $ts1, $hook, $args );
+        $this->assertTrue( wp_schedule_single_event( $ts1, $hook, $args ) );
         // second one is ignored
-        wp_schedule_single_event( $ts2, $hook, $args );
+        $this->assertFalse( wp_schedule_single_event( $ts2, $hook, $args ) );
 
         // the next event should be at +5 minutes, not +3
@@ -241 +278 @@
 
         // first one works
-        wp_schedule_single_event( $ts1, $hook, $args );
+        $this->assertTrue( wp_schedule_single_event( $ts1, $hook, $args ) );
         // second works too
-        wp_schedule_single_event( $ts2, $hook, $args );
+        $this->assertTrue( wp_schedule_single_event( $ts2, $hook, $args ) );
 
         // the next event should be at +3 minutes, even though that one was scheduled second
@@ -260 +297 @@
 
         // first one works
-        wp_schedule_single_event( $ts1, $hook, $args );
+        $this->assertTrue( wp_schedule_single_event( $ts1, $hook, $args ) );
         // second works too
-        wp_schedule_single_event( $ts2, $hook, $args );
+        $this->assertTrue( wp_schedule_single_event( $ts2, $hook, $args ) );
 
         // the next event should be at +3 minutes