Changeset 56609 for trunk/tests/phpunit/tests/hooks/removeFilter.php

Timestamp:

09/18/2023 12:39:18 PM (18 months ago)

Author:

spacedmonkey

Message:

Plugins: Store result of call to array_keys, to save repeated calls in WP_Hook class.

In the WP_Hook class the function array_keys was called every time an array of hook priorities was needed. For sites with lots of filters or actions, this would result in thousands of calls to the array_keys function, which uses server resources. Instead of recomputing this array every time it is needed, only compute it when filters are added and removed, then store the result as a class property. Improve unit tests to ensure this behaviour is tested.

Props spacedmonkey, bor0, flixos90, hellofromTonya, mukesh27.
Fixes #58458.

File:

• trunk/tests/phpunit/tests/hooks/removeFilter.php (modified) (5 diffs)

trunk/tests/phpunit/tests/hooks/removeFilter.php

@@ -18 +18 @@
         $hook->add_filter( $hook_name, $callback, $priority, $accepted_args );
         $hook->remove_filter( $hook_name, $callback, $priority );
+        $this->check_priority_non_existent( $hook, $priority );
 
         $this->assertArrayNotHasKey( $priority, $hook->callbacks );
@@ -32 +33 @@
         $hook->add_filter( $hook_name, $callback, $priority, $accepted_args );
         $hook->remove_filter( $hook_name, $callback, $priority );
+        $this->check_priority_non_existent( $hook, $priority );
 
         $this->assertArrayNotHasKey( $priority, $hook->callbacks );
@@ -45 +47 @@
         $hook->add_filter( $hook_name, $callback, $priority, $accepted_args );
         $hook->remove_filter( $hook_name, $callback, $priority );
+        $this->check_priority_non_existent( $hook, $priority );
 
         $this->assertArrayNotHasKey( $priority, $hook->callbacks );
@@ -63 +66 @@
 
         $this->assertCount( 1, $hook->callbacks[ $priority ] );
+        $this->check_priority_exists( $hook, $priority, 'Has priority of 2' );
     }
 
@@ -77 +81 @@
 
         $hook->remove_filter( $hook_name, $callback_one, $priority );
+        $this->check_priority_non_existent( $hook, $priority );
         $this->assertArrayNotHasKey( $priority, $hook->callbacks );
         $this->assertCount( 1, $hook->callbacks[ $priority + 1 ] );
+        $this->check_priority_exists( $hook, $priority + 1, 'Should priority of 3' );
+    }
+
+    protected function check_priority_non_existent( $hook, $priority ) {
+        $priorities = $this->get_priorities( $hook );
+
+        $this->assertNotContains( $priority, $priorities );
+    }
+
+    protected function check_priority_exists( $hook, $priority ) {
+        $priorities = $this->get_priorities( $hook );
+
+        $this->assertContains( $priority, $priorities );
+    }
+
+    protected function get_priorities( $hook ) {
+        $reflection          = new ReflectionClass( $hook );
+        $reflection_property = $reflection->getProperty( 'priorities' );
+        $reflection_property->setAccessible( true );
+
+        return $reflection_property->getValue( $hook );
     }
 }