<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[27294] trunk: Introduce doing_filter() and doing_action() to identify hooks in progress.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/27294">27294</a></dd>
<dt>Author</dt> <dd>nacin</dd>
<dt>Date</dt> <dd>2014-02-26 18:43:59 +0000 (Wed, 26 Feb 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>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 <a href="http://core.trac.wordpress.org/ticket/14994">#14994</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludespluginphp">trunk/src/wp-includes/plugin.php</a></li>
<li><a href="#trunktestsphpunittestsactionsphp">trunk/tests/phpunit/tests/actions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludespluginphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/plugin.php (27293 => 27294)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/plugin.php 2014-02-26 18:20:44 UTC (rev 27293)
+++ trunk/src/wp-includes/plugin.php 2014-02-26 18:43:59 UTC (rev 27294)
</span><span class="lines">@@ -325,6 +325,61 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * 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 );
+}
+
+/**
</ins><span class="cx"> * Hooks a function on to a specific action.
</span><span class="cx"> *
</span><span class="cx"> * Actions are the hooks that the WordPress core launches at specific points
</span></span></pre></div>
<a id="trunktestsphpunittestsactionsphp"></a>
<div class="modfile"><h4>Modified: trunk/tests/phpunit/tests/actions.php (27293 => 27294)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/phpunit/tests/actions.php 2014-02-26 18:20:44 UTC (rev 27293)
+++ trunk/tests/phpunit/tests/actions.php 2014-02-26 18:43:59 UTC (rev 27294)
</span><span class="lines">@@ -256,4 +256,104 @@
</span><span class="cx"> function action_self_removal() {
</span><span class="cx"> remove_action( 'test_action_self_removal', array( $this, 'action_self_removal' ) );
</span><span class="cx"> }
</span><ins>+
+ /**
+ * 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' ) );
+ }
</ins><span class="cx"> }
</span></span></pre>
</div>
</div>
</body>
</html>