Ticket #39052: 39052.diff

src/wp-includes/cron.php

@@ -165 +165 @@
  * identified.
  *
  * @since 2.1.0
+ * @since 4.7.1 A condition was added to ensure function returns false when the event does not exist.
  *
  * @param int $timestamp Unix timestamp (UTC) for when to run the event.
  * @param string $hook Action hook, the execution of which will be unscheduled.
@@ -172 +173 @@
  * 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.
+ *
+ * @return false|void False if the event does not exist.
  */
 function wp_unschedule_event( $timestamp, $hook, $args = array() ) {
         // Make sure timestamp is a positive integer
@@ -181 +183 @@
         }
 
         $crons = _get_cron_array();
-        $key = md5(serialize($args));
-        unset( $crons[$timestamp][$hook][$key] );
-        if ( empty($crons[$timestamp][$hook]) )
-                unset( $crons[$timestamp][$hook] );
-        if ( empty($crons[$timestamp]) )
-                unset( $crons[$timestamp] );
+        $key = md5( serialize( $args ) );
+
+        // If the event does not exist, we can't unschedule the event, so return false.
+        if ( ! isset(
+                $crons,
+                $crons[ $timestamp ],
+                $crons[ $timestamp ][ $hook ],
+                $crons[ $timestamp ][ $hook ][ $key ] )
+        ) {
+                return false;
+        }
+
+        // Now, remove the event, do cleanup, and update the cron option.
+        unset( $crons[ $timestamp ][ $hook ][ $key ] );
+        if ( empty( $crons[ $timestamp ][ $hook ] ) ) {
+                unset( $crons[ $timestamp ][ $hook ] );
+        }
+        if ( empty( $crons[ $timestamp ] ) ) {
+                unset( $crons[ $timestamp ] );
+        }
         _set_cron_array( $crons );
 }
 

tests/phpunit/tests/cron.php

@@ -98 +98 @@
                 $this->assertEquals( false, wp_next_scheduled($hook) );
         }
 
+        function test_unschedule_event_returns_false_when_event_not_unscheduled() {
+                $hook = __FUNCTION__;
+                $timestamp = strtotime( '+1 hour' );
+
+                $this->assertFalse( wp_unschedule_event( 'hello', $hook ) );
+                $this->assertFalse( wp_unschedule_event( -1, $hook ) );
+                $this->assertFalse( wp_unschedule_event( 123456, $hook ) );
+
+                // now unschedule it and make sure it's gone
+                wp_unschedule_event( $timestamp, $hook );
+                $this->assertEquals( false, wp_next_scheduled($hook) );
+        }
+
         function test_clear_schedule() {
                 $hook = __FUNCTION__;
                 $args = array( 'arg1' );