Changeset 38224

Timestamp:

08/09/2016 01:50:21 AM (8 years ago)

Author:

pento

Message:

Boostrap/Load: Improve forward compatiblity of plugin global backup methods.

[37588] added methods to backup the plugin globals, for ensuring that advanced cache drop-ins don't overwrite hooks that've been added earlier in the load process.

The method for restoring the plugin globals wasn't compatible with the implementation of WP_Hook in #17817. WP_Hook implements ArrayAccess, so _restore_plugin_globals() was treating it as an array, and inadvertantly overwriting the WP_Hook object with a plain array.

To avoid having to re-write this code as part of #17817, we now use add_filter() to restore any hooks that were added by cache drop-ins, which WP_Hook correctly supports.

Merge of [38223] with the 4.6 branch.

Props pento, jorbin.
Fixes #36819.

Location:

branches/4.6

Files:

• src/wp-includes/plugin.php (modified) (3 diffs)
• src/wp-settings.php (modified) (1 diff)
• tests/phpunit/tests/actions.php (modified) (5 diffs)

branches/4.6/src/wp-includes/plugin.php

@@ -1020 +1020 @@
  * @return array the staticvar from the first time it is set.
  */
-function _backup_plugin_globals(){
+function _backup_plugin_globals( $backup = true ) {
     global $wp_filter, $wp_actions, $merged_filters, $wp_current_filter;
 
     static $backup_globals = array();
 
-    if ( empty( $backup_globals ) ) {
+    if ( $backup ) {
         $backup_globals = array(
             'backup_wp_filter'         => $wp_filter,
@@ -1032 +1032 @@
             'backup_wp_current_filter' => $wp_current_filter,
         );
-    };
+
+        $wp_filter = $wp_actions = array();
+    }
     return $backup_globals;
 }
@@ -1048 +1050 @@
  * @staticvar array $backup_globals Backed up globals.
  */
-function _restore_plugin_globals(){
+function _restore_plugin_globals() {
     global $wp_filter, $wp_actions, $merged_filters, $wp_current_filter;
 
-    $backup_globals = _backup_plugin_globals();
-
-    if ( $wp_filter !== $backup_globals['backup_wp_filter'] ){
-        $wp_filter = array_merge_recursive( $wp_filter, $backup_globals['backup_wp_filter'] );
-    }
-
-    if ( $wp_actions !== $backup_globals['backup_wp_actions'] ){
-        $wp_actions = array_merge_recursive( $wp_actions, $backup_globals['backup_wp_actions'] );
-    }
-
-    if ( $merged_filters !== $backup_globals['backup_merged_filters'] ){
+    $backup_globals = _backup_plugin_globals( false );
+
+    if ( empty( $wp_filter ) ) {
+        $wp_filter = $backup_globals['backup_wp_filter'];
+    } else {
+        $added_filters = $wp_filter;
+        $wp_filter = $backup_globals['backup_wp_filter'];
+
+        foreach ( $added_filters as $tag => $callback_groups ) {
+            // Loop through callback groups.
+            foreach ( $callback_groups as $priority => $callbacks ) {
+
+                // Loop through callbacks.
+                foreach ( $callbacks as $cb ) {
+                    add_filter( $tag, $cb['function'], $priority, $cb['accepted_args'] );
+                }
+            }
+        }
+    }
+
+    if ( empty ( $wp_actions ) ) {
+        $wp_actions = $backup_globals['backup_wp_actions'];
+    } else {
+        $run_actions = $wp_actions;
+        $wp_actions = $backup_globals['backup_wp_actions'];
+
+        foreach( $run_actions as $action => $count ) {
+            if ( ! isset( $wp_actions[ $action ] ) ) {
+                $wp_actions[ $action ] = 0;
+            }
+
+            $wp_actions[ $action ] += $count;
+        }
+    }
+
+    if ( $merged_filters !== $backup_globals['backup_merged_filters'] ) {
         $merged_filters = array_merge_recursive( $merged_filters, $backup_globals['backup_merged_filters'] );
     }
 
-    if ( $wp_current_filter !== $backup_globals['backup_wp_current_filter'] ){
+    if ( $wp_current_filter !== $backup_globals['backup_wp_current_filter'] ) {
         $wp_current_filter = array_merge_recursive( $wp_current_filter, $backup_globals['backup_wp_current_filter'] );
     }

branches/4.6/src/wp-settings.php

@@ -84 +84 @@
 if ( WP_CACHE && apply_filters( 'enable_loading_advanced_cache_dropin', true ) ) {
 // For an advanced caching plugin to use. Uses a static drop-in because you would only want one.
-    _backup_plugin_globals();
+    _backup_plugin_globals( true );
     WP_DEBUG ? include( WP_CONTENT_DIR . '/advanced-cache.php' ) : @include( WP_CONTENT_DIR . '/advanced-cache.php' );
     _restore_plugin_globals();

branches/4.6/tests/phpunit/tests/actions.php

@@ -333 +333 @@
      */
     function test_backup_plugin_globals_returns_filters() {
-        $backup = _backup_plugin_globals();
+        $backup = _backup_plugin_globals( true );
         $this->assertArrayHasKey( 'backup_wp_filter',         $backup );
         $this->assertArrayHasKey( 'backup_wp_actions',        $backup );
@@ -344 +344 @@
      */
     function test_backup_plugin_globals_returns_filters_from_first_time_called() {
-        $backup = _backup_plugin_globals();
-
-        $a = new MockAction();
-        $tag = rand_str();
-
-        add_action($tag, array(&$a, 'action'));
-
-        $new_backup = _backup_plugin_globals();
+        $backup = _backup_plugin_globals( true );
+
+        $a = new MockAction();
+        $tag = rand_str();
+
+        add_action($tag, array(&$a, 'action'));
+
+        $new_backup = _backup_plugin_globals( false );
         $this->assertEquals( $backup, $new_backup );
     }
@@ -362 +362 @@
         $original_actions = $wp_actions;
 
-        _backup_plugin_globals();
+        _backup_plugin_globals( true );
 
         $wp_actions = array();
@@ -379 +379 @@
         $original_filter = $wp_filter;
 
-        $backup = _backup_plugin_globals();
+        $backup = _backup_plugin_globals( true );
 
         $a = new MockAction();
@@ -390 +390 @@
 
         $this->assertNotEquals( $GLOBALS['wp_filter'], $original_filter );
+    }
+
+    /**
+     * @ticket 36819
+     */
+    function test_applied_actions_are_counted_after_restore() {
+        global $wp_actions;
+
+        $action_name = 'this_is_a_fake_action_name';
+        $this->assertArrayNotHasKey( $action_name, $wp_actions );
+
+        do_action( $action_name );
+
+        $this->assertEquals( 1, $wp_actions[ $action_name ] );
+
+        _backup_plugin_globals( true );
+        do_action( $action_name );
+        _restore_plugin_globals();
+
+        $this->assertEquals( 2, $wp_actions[ $action_name ] );
     }