Changeset 38571 for trunk/tests/phpunit/includes/testcase.php

Timestamp:

09/08/2016 03:54:13 AM (8 years ago)

Author:

pento

Message:

Hooks: Add the new class WP_Hook, and modify hook handling to make use of it.

Filters and actions have been the basis of WordPress' plugin functionality since time immemorial, they've always been a reliable method for acting upon the current state of WordPress, and will continue to be so.

Over the years, however, edge cases have cropped up. Particularly when it comes to recursively executing hooks, or a hook adding and removing itself, the existing implementation struggled to keep up with more complex use cases.

And so, we introduce WP_Hook. By changing $wp_filter from an array of arrays, to an array of objects, we reduce the complexity of the hook handling code, as the processing code (see ::apply_filters()) only needs to be aware of itself, rather than the state of all hooks. At the same time, we're able te handle more complex use cases, as the object can more easily keep track of its own state than an array ever could.

Props jbrinley for the original architecture and design of this patch.
Props SergeyBiryukov, cheeserolls, Denis-de-Bernardy, leewillis77, wonderboymusic, nacin, jorbin, DrewAPicture, ocean90, dougwollison, khag7, pento, noplanman and aaroncampbell for their testing, suggestions, contributions, patch maintenance, cajoling and patience as we got through this.
Fixes #17817.

File:

• trunk/tests/phpunit/includes/testcase.php (modified) (2 diffs)

trunk/tests/phpunit/includes/testcase.php

@@ -224 +224 @@
      */
     protected function _backup_hooks() {
-        $globals = array( 'merged_filters', 'wp_actions', 'wp_current_filter', 'wp_filter' );
+        $globals = array( 'wp_actions', 'wp_current_filter' );
         foreach ( $globals as $key ) {
             self::$hooks_saved[ $key ] = $GLOBALS[ $key ];
+        }
+        self::$hooks_saved['wp_filter'] = array();
+        foreach ( $GLOBALS['wp_filter'] as $hook_name => $hook_object ) {
+            self::$hooks_saved['wp_filter'][ $hook_name ] = clone $hook_object;
         }
     }
@@ -241 +245 @@
      */
     protected function _restore_hooks() {
-        $globals = array( 'merged_filters', 'wp_actions', 'wp_current_filter', 'wp_filter' );
+        $globals = array( 'wp_actions', 'wp_current_filter' );
         foreach ( $globals as $key ) {
             if ( isset( self::$hooks_saved[ $key ] ) ) {
                 $GLOBALS[ $key ] = self::$hooks_saved[ $key ];
+            }
+        }
+        if ( isset( self::$hooks_saved['wp_filter'] ) ) {
+            $GLOBALS['wp_filter'] = array();
+            foreach ( self::$hooks_saved['wp_filter'] as $hook_name => $hook_object ) {
+                $GLOBALS['wp_filter'][ $hook_name ] = clone $hook_object;
             }
         }