Changeset 40965 for trunk/src/wp-includes/cron.php

Timestamp:

06/30/2017 12:21:49 AM (4 years ago)

Author:

SergeyBiryukov

Message:

Cron API: Introduce wp_unschedule_hook() to clear all events attached to a hook.

This complements wp_clear_scheduled_hook(), which only clears events attached with specific arguments.

Props arena, mordauk, jrf.
Fixes #18997.

File:

• trunk/src/wp-includes/cron.php (modified) (2 diffs)

trunk/src/wp-includes/cron.php

@@ -192 +192 @@
 
 /**
- * Unschedule all events attached to the specified hook.
+ * Unschedule all events attached to the hook with the specified arguments.
  *
  * @since 2.1.0
@@ -220 +220 @@
         }
     }
+}
+
+/**
+ * Unschedule all events attached to the hook.
+ *
+ * Can be useful for plugins when deactivating to clean up the cron queue.
+ *
+ * @since 4.9.0
+ *
+ * @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 );
 }