Changeset 27294

Timestamp:

02/26/2014 06:43:59 PM (11 years ago)

Author:

nacin

Message:

Introduce doing_filter() and doing_action() to identify hooks in progress.

did_action() returns true the moment a hook is initially run, leaving you no way to tell if the hook is still in progress. Hooks can be nested and this checks the entire stack, versus current_filter() which only identifies the final hook in the stack. This commit also introduces current_action() for parity.

To tell if a hook has completed, one can use did_action() and ! doing_action() together.

The functions do not require an argument. In that situation, they indicate whether the stack is empty.

props ericmann for the initial unit tests.
fixes #14994.

Location:

trunk

Files:

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

trunk/src/wp-includes/plugin.php

@@ -323 +323 @@
     global $wp_current_filter;
     return end( $wp_current_filter );
+}
+
+/**
+ * Retrieve the name of the current action.
+ *
+ * @since 3.9.0
+ * @uses current_filter()
+ *
+ * @return string Hook name of the current action.
+ */
+function current_action() {
+    return current_filter();
+}
+
+/**
+ * Retrieve the name of a filter currently being processed.
+ *
+ * The function current_filter() only returns the most recent filter or action
+ * being executed.  did_action() returns true once the action is initially
+ * processed.  This function allows detection for any filter currently being
+ * executed (despite not being the most recent filter to fire, in the case of
+ * hooks called from hook callbacks) to be verified.
+ *
+ * @since 3.9.0
+ * @see current_filter()
+ * @see did_action()
+ *
+ * @param string $filter Optional. Filter to check. Defaults to null, which checks if any filter is currently being run.
+ *
+ * @global array $wp_current_filter
+ *
+ * @return bool Whether the filter is currently in the stack
+ */
+function doing_filter( $filter = null ) {
+    global $wp_current_filter;
+
+    if ( null === $filter ) {
+        return ! empty( $wp_current_filter );
+    }
+
+    return in_array( $filter, $wp_current_filter );
+}
+
+/**
+ * Retrieve the name of an action currently being processed.
+ *
+ * @since 3.9.0
+ * @uses doing_filter()
+ *
+ * @param string $action Optional. Action to check. Defaults to null, which checks if any action is currently being run.
+ *
+ * @return bool Whether the action is currently in the stack.
+ */
+function doing_action( $action = null ) {
+    return doing_filter( $action );
 }
 

trunk/tests/phpunit/tests/actions.php

@@ -257 +257 @@
         remove_action( 'test_action_self_removal', array( $this, 'action_self_removal' ) );
     }
+
+    /**
+     * Make sure current_action() behaves as current_filter()
+     *
+     * @ticket 14994
+     */
+    function test_current_action() {
+        global $wp_current_filter;
+        $wp_current_filter[] = 'first';
+        $wp_current_filter[] = 'second'; // Let's say a second action was invoked.
+
+        $this->assertEquals( 'second', current_action() );
+    }
+
+    /**
+     * @ticket 14994
+     */
+    function test_doing_filter() {
+        global $wp_current_filter;
+        $wp_current_filter = array(); // Set to an empty array first
+
+        $this->assertFalse( doing_filter() ); // No filter is passed in, and no filter is being processed
+        $this->assertFalse( doing_filter( 'testing' ) ); // Filter is passed in but not being processed
+
+        $wp_current_filter[] = 'testing';
+
+        $this->assertTrue( doing_filter() ); // No action is passed in, and a filter is being processed
+        $this->assertTrue( doing_filter( 'testing') ); // Filter is passed in and is being processed
+        $this->assertFalse( doing_filter( 'something_else' ) ); // Filter is passed in but not being processed
+
+        $wp_current_filter = array();
+    }
+
+    /**
+     * @ticket 14994
+     */
+    function test_doing_action() {
+        global $wp_current_filter;
+        $wp_current_filter = array(); // Set to an empty array first
+
+        $this->assertFalse( doing_action() ); // No action is passed in, and no filter is being processed
+        $this->assertFalse( doing_action( 'testing' ) ); // Action is passed in but not being processed
+
+        $wp_current_filter[] = 'testing';
+
+        $this->assertTrue( doing_action() ); // No action is passed in, and a filter is being processed
+        $this->assertTrue( doing_action( 'testing') ); // Action is passed in and is being processed
+        $this->assertFalse( doing_action( 'something_else' ) ); // Action is passed in but not being processed
+
+        $wp_current_filter = array();
+    }
+
+    /**
+     * @ticket 14994
+     */
+    function test_doing_filter_real() {
+        $this->assertFalse( doing_filter() ); // No filter is passed in, and no filter is being processed
+        $this->assertFalse( doing_filter( 'testing' ) ); // Filter is passed in but not being processed
+
+        add_filter( 'testing', array( $this, 'apply_testing_filter' ) );
+        $this->assertTrue( has_action( 'testing' ) );
+        $this->assertEquals( 10, has_action( 'testing', array( $this, 'apply_testing_filter' ) ) );
+
+        apply_filters( 'testing', '' );
+
+        // Make sure it ran.
+        $this->assertTrue( $this->apply_testing_filter );
+
+        $this->assertFalse( doing_filter() ); // No longer doing any filters
+        $this->assertFalse( doing_filter( 'testing' ) ); // No longer doing this filter
+    }
+
+    function apply_testing_filter() {
+        $this->apply_testing_filter = true;
+
+        $this->assertTrue( doing_filter() );
+        $this->assertTrue( doing_filter( 'testing' ) );
+        $this->assertFalse( doing_filter( 'something_else' ) );
+        $this->assertFalse( doing_filter( 'testing_nested' ) );
+
+        add_filter( 'testing_nested', array( $this, 'apply_testing_nested_filter' ) );
+        $this->assertTrue( has_action( 'testing_nested' ) );
+        $this->assertEquals( 10, has_action( 'testing_nested', array( $this, 'apply_testing_nested_filter' ) ) );
+
+        apply_filters( 'testing_nested', '' );
+
+        // Make sure it ran.
+        $this->assertTrue( $this->apply_testing_nested_filter );
+
+        $this->assertFalse( doing_filter( 'testing_nested' ) );
+        $this->assertFalse( doing_filter( 'testing_nested' ) );
+    }
+
+    function apply_testing_nested_filter() {
+        $this->apply_testing_nested_filter = true;
+        $this->assertTrue( doing_filter() );
+        $this->assertTrue( doing_filter( 'testing' ) );
+        $this->assertTrue( doing_filter( 'testing_nested' ) );
+        $this->assertFalse( doing_filter( 'something_else' ) );
+    }
 }