Ticket #18997: 18997-refreshed-mordauks-patch.patch

src/wp-includes/cron.php

@@ -211 +211 @@
 }
 
 /**
+ * Unschedule all previously scheduled cron jobs for a hook.
+ *
+ * Can be useful for plugins when deactivating to clean up the cron queue.
+ *
+ * The $hook parameter is required, so that the events can be identified.
+ *
+ * @since x.x
+ *
+ * @param string $hook Action hook, the execution of which will be unscheduled.
+ */
+function wp_unschedule_hook( $hook ) {
+        $crons = _get_cron_array();
+
+        foreach( $crons as $timestamp => $args ) {
+                unset( $crons[ $timestamp ][ $hook ] );
+
+                if ( empty( $crons[ $timestamp ] ) ) {
+                        unset( $crons[ $timestamp ] );
+                }
+        }
+
+        _set_cron_array( $crons );
+}
+
+/**
  * Retrieve the next timestamp for a cron event.
  *
  * @since 2.1.0

tests/phpunit/tests/cron.php

@@ -124 +124 @@
                 $this->assertFalse( wp_next_scheduled($hook, $args) );
         }
 
+        /**
+         * @ticket 18997
+         */
+        function test_unschedule_hook() {
+                $hook = rand_str();
+                $args = array(rand_str());
+
+                // schedule several events with and without arguments.
+                wp_schedule_single_event( strtotime('+1 hour'), $hook );
+                wp_schedule_single_event( strtotime('+2 hour'), $hook );
+                wp_schedule_single_event( strtotime('+3 hour'), $hook, $args );
+                wp_schedule_single_event( strtotime('+4 hour'), $hook, $args );
+
+                // make sure they're returned by wp_next_scheduled().
+                $this->assertTrue( wp_next_scheduled($hook) > 0 );
+                $this->assertTrue( wp_next_scheduled($hook, $args) > 0 );
+
+                // clear the schedule for the no args events and make sure it's gone.
+                wp_unschedule_hook($hook);
+                $this->assertFalse( wp_next_scheduled($hook) );
+        }
+
         function test_clear_schedule_multiple_args() {
                 $hook = rand_str();
                 $args = array(rand_str(), rand_str());