Changeset 52952

Timestamp:

03/18/2022 06:21:40 PM (3 years ago)

Author:

johnbillion

Message:

Plugins: Convert apply_filters() into a proper variadic function.

This makes its signature more correct by implementing the spread operator, and adjusts the internal logic correspondingly without affecting performance.

Props jrf, SergeyBiryukov, davidbaumwald, mauriac, johnbillion

Fixes #53218

Location:

trunk

Files:

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

trunk/src/wp-includes/plugin.php

@@ -152 +152 @@
  *
  * @since 0.71
+ * @since 6.0.0 Formalized the existing and already documented `...$args` parameter
+ *              by adding it to the function signature.
  *
  * @global WP_Hook[] $wp_filter         Stores all of the filters and actions.
@@ -161 +163 @@
  * @return mixed The filtered value after all hooked functions are applied to it.
  */
-function apply_filters( $hook_name, $value ) {
+function apply_filters( $hook_name, $value, ...$args ) {
     global $wp_filter, $wp_current_filter;
-
-    $args = func_get_args();
 
     // Do 'all' actions first.
     if ( isset( $wp_filter['all'] ) ) {
         $wp_current_filter[] = $hook_name;
-        _wp_call_all_hook( $args );
+
+        $all_args = func_get_args(); // phpcs:ignore PHPCompatibility.FunctionUse.ArgumentFunctionsReportCurrentValue.NeedsInspection
+        _wp_call_all_hook( $all_args );
     }
 
@@ -184 +186 @@
     }
 
-    // Don't pass the tag name to WP_Hook.
-    array_shift( $args );
+    // Pass the value to WP_Hook.
+    array_unshift( $args, $value );
 
     $filtered = $wp_filter[ $hook_name ]->apply_filters( $value, $args );

trunk/tests/phpunit/tests/filters.php

@@ -217 +217 @@
 
     /**
+     * @ticket 53218
+     */
+    public function test_filter_with_ref_value() {
+        $obj = new stdClass();
+        $ref = &$obj;
+        $a   = new MockAction();
+        $tag = __FUNCTION__;
+
+        add_action( $tag, array( $a, 'filter' ) );
+
+        $filtered = apply_filters( $tag, $ref );
+
+        $args = $a->get_args();
+        $this->assertSame( $args[0][0], $obj );
+        $this->assertSame( $filtered, $obj );
+        // Just in case we don't trust assertSame().
+        $obj->foo = true;
+        $this->assertNotEmpty( $args[0][0]->foo );
+        $this->assertNotEmpty( $filtered->foo );
+    }
+
+    /**
+     * @ticket 53218
+     */
+    public function test_filter_with_ref_argument() {
+        $obj = new stdClass();
+        $ref = &$obj;
+        $a   = new MockAction();
+        $tag = __FUNCTION__;
+        $val = 'Hello';
+
+        add_action( $tag, array( $a, 'filter' ), 10, 2 );
+
+        apply_filters( $tag, $val, $ref );
+
+        $args = $a->get_args();
+        $this->assertSame( $args[0][1], $obj );
+        // Just in case we don't trust assertSame().
+        $obj->foo = true;
+        $this->assertNotEmpty( $args[0][1]->foo );
+    }
+
+    /**
      * @ticket 9886
      */