<!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>[53803] trunk: Plugins: Introduce `did_filter()` function.</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 { white-space: pre-line; 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" style="font-size: 105%">

<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/53803">53803</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/53803","name":"Review Commit"}}</script></dd>

<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>

<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-07-31 14:18:36 +0000 (Sun, 31 Jul 2022)</dd>

</dl>

<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="https://core.trac.wordpress.org/changeset/4630">[4630]</a>, <a href="https://core.trac.wordpress.org/changeset/6318">[6318]</a>, <a href="https://core.trac.wordpress.org/changeset/27294">[27294]</a>.

Props mordauk, chriscct7, andykeith, nacin, dd32, markparnell, SergeyBiryukov.

Fixes <a href="https://core.trac.wordpress.org/ticket/35357">#35357</a>.</pre>

<h3>Modified Paths</h3>

<ul>

<li><a href="#trunksrcwpincludespluginphp">trunk/src/wp-includes/plugin.php</a></li>

<li><a href="#trunktestsphpunittestsfiltersphp">trunk/tests/phpunit/tests/filters.php</a></li>

</ul>

</div>

<div id="patch">

<h3>Diff</h3>

<a id="trunksrcwpincludespluginphp"></a>

<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/plugin.php</h4>

<pre class="diff"><span>

<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/plugin.php  2022-07-31 13:09:00 UTC (rev 53802)

+++ trunk/src/wp-includes/plugin.php    2022-07-31 14:18:36 UTC (rev 53803)

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -30,6 +30,9 @@

</span><span class="cx" style="display: block; padding: 0 10px"> /** @var int[] $wp_actions */

</span><span class="cx" style="display: block; padding: 0 10px"> global $wp_actions;

</span><span class="cx" style="display: block; padding: 0 10px"> 

</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/** @var int[] $wp_filters */

+global $wp_filters;

+

</ins><span class="cx" style="display: block; padding: 0 10px"> /** @var string[] $wp_current_filter */

</span><span class="cx" style="display: block; padding: 0 10px"> global $wp_current_filter;

</span><span class="cx" style="display: block; padding: 0 10px"> 

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -43,6 +46,10 @@

</span><span class="cx" style="display: block; padding: 0 10px">        $wp_actions = array();

</span><span class="cx" style="display: block; padding: 0 10px"> }

</span><span class="cx" style="display: block; padding: 0 10px"> 

</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+if ( ! isset( $wp_filters ) ) {

+       $wp_filters = array();

+}

+

</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! isset( $wp_current_filter ) ) {

</span><span class="cx" style="display: block; padding: 0 10px">        $wp_current_filter = array();

</span><span class="cx" style="display: block; padding: 0 10px"> }

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -155,6 +162,7 @@

<span class="cx" style="display: block; padding: 0 10px">  *              by adding it to the function signature.

</span><span class="cx" style="display: block; padding: 0 10px">  *

<span class="cx" style="display: block; padding: 0 10px">  * @global WP_Hook[] $wp_filter         Stores all of the filters and actions.

<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global int[]     $wp_filters        Stores the number of times each filter was triggered.

</ins><span class="cx" style="display: block; padding: 0 10px">  * @global string[]  $wp_current_filter Stores the list of current filters with the current one last.

</span><span class="cx" style="display: block; padding: 0 10px">  *

<span class="cx" style="display: block; padding: 0 10px">  * @param string $hook_name The name of the filter hook.

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -163,8 +171,14 @@

<span class="cx" style="display: block; padding: 0 10px">  * @return mixed The filtered value after all hooked functions are applied to it.

</span><span class="cx" style="display: block; padding: 0 10px">  */

</span><span class="cx" style="display: block; padding: 0 10px"> function apply_filters( $hook_name, $value, ...$args ) {

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-        global $wp_filter, $wp_current_filter;

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ global $wp_filter, $wp_filters, $wp_current_filter;

</ins><span class="cx" style="display: block; padding: 0 10px"> 

</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+        if ( ! isset( $wp_filters[ $hook_name ] ) ) {

+               $wp_filters[ $hook_name ] = 1;

+       } else {

+               ++$wp_filters[ $hook_name ];

+       }

+

</ins><span class="cx" style="display: block; padding: 0 10px">         // Do 'all' actions first.

</span><span class="cx" style="display: block; padding: 0 10px">        if ( isset( $wp_filter['all'] ) ) {

</span><span class="cx" style="display: block; padding: 0 10px">                $wp_current_filter[] = $hook_name;

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -204,6 +218,7 @@

<span class="cx" style="display: block; padding: 0 10px">  *                      functions hooked to `$hook_name` are supplied using an array.

</span><span class="cx" style="display: block; padding: 0 10px">  *