Changeset 53803

Timestamp:

07/31/2022 02:18:36 PM (2 years ago)

Author:

SergeyBiryukov

Message:

Plugins: Introduce did_filter() function.

While most of the action functions are aliases for the respective filter functions, using did_action() to detect whether a filter has been run is not possible, as it only works specifically for actions.

This is now resolved by introducing a new function, did_filter(), which retrieves the number of times a filter has been applied during the current request, bringing parity with did_action().

Follow-up to [4630], [6318], [27294].

Props mordauk, chriscct7, andykeith, nacin, dd32, markparnell, SergeyBiryukov.
Fixes #35357.

Location:

trunk

Files:

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

trunk/src/wp-includes/plugin.php

@@ -30 +30 @@
 /** @var int[] $wp_actions */
 global $wp_actions;
+
+/** @var int[] $wp_filters */
+global $wp_filters;
 
 /** @var string[] $wp_current_filter */
@@ -42 +45 @@
 if ( ! isset( $wp_actions ) ) {
     $wp_actions = array();
+}
+
+if ( ! isset( $wp_filters ) ) {
+    $wp_filters = array();
 }
 
@@ -156 +163 @@
  *
  * @global WP_Hook[] $wp_filter         Stores all of the filters and actions.
+ * @global int[]     $wp_filters        Stores the number of times each filter was triggered.
  * @global string[]  $wp_current_filter Stores the list of current filters with the current one last.
  *
@@ -164 +172 @@
  */
 function apply_filters( $hook_name, $value, ...$args ) {
-    global $wp_filter, $wp_current_filter;
+    global $wp_filter, $wp_filters, $wp_current_filter;
+
+    if ( ! isset( $wp_filters[ $hook_name ] ) ) {
+        $wp_filters[ $hook_name ] = 1;
+    } else {
+        ++$wp_filters[ $hook_name ];
+    }
 
     // Do 'all' actions first.
@@ -205 +219 @@
  *
  * @global WP_Hook[] $wp_filter         Stores all of the filters and actions.
+ * @global int[]     $wp_filters        Stores the number of times each filter was triggered.
  * @global string[]  $wp_current_filter Stores the list of current filters with the current one last.
  *
@@ -212 +227 @@
  */
 function apply_filters_ref_array( $hook_name, $args ) {
-    global $wp_filter, $wp_current_filter;
+    global $wp_filter, $wp_filters, $wp_current_filter;
+
+    if ( ! isset( $wp_filters[ $hook_name ] ) ) {
+        $wp_filters[ $hook_name ] = 1;
+    } else {
+        ++$wp_filters[ $hook_name ];
+    }
 
     // Do 'all' actions first.
@@ -376 +397 @@
 
     return in_array( $hook_name, $wp_current_filter, true );
+}
+
+/**
+ * Retrieves the number of times a filter has been applied during the current request.
+ *
+ * @since 6.1.0
+ *
+ * @global int[] $wp_filters Stores the number of times each filter was triggered.
+ *
+ * @param string $hook_name The name of the filter hook.
+ * @return int The number of times the filter hook has been applied.
+ */
+function did_filter( $hook_name ) {
+    global $wp_filters;
+
+    if ( ! isset( $wp_filters[ $hook_name ] ) ) {
+        return 0;
+    }
+
+    return $wp_filters[ $hook_name ];
 }
 

trunk/tests/phpunit/tests/filters.php

@@ -151 +151 @@
     }
 
+    /**
+     * @covers ::did_filter
+     */
+    public function test_did_filter() {
+        $tag1 = 'filter1';
+        $tag2 = 'filter2';
+        $val  = __FUNCTION__ . '_val';
+
+        // Apply filter $tag1 but not $tag2.
+        apply_filters( $tag1, $val );
+        $this->assertSame( 1, did_filter( $tag1 ) );
+        $this->assertSame( 0, did_filter( $tag2 ) );
+
+        // Apply filter $tag2 10 times.
+        $count = 10;
+        for ( $i = 0; $i < $count; $i++ ) {
+            apply_filters( $tag2, $val );
+        }
+
+        // $tag1's count hasn't changed, $tag2 should be correct.
+        $this->assertSame( 1, did_filter( $tag1 ) );
+        $this->assertSame( $count, did_filter( $tag2 ) );
+
+    }
+
     public function test_all_filter() {
         $a    = new MockAction();