<!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>[21288] trunk/wp-includes/plugin.php: Clarify the return value of has_filter() and has_action().</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, #logmsg > ol { margin-left: 0; 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/21288">21288</a></dd>

<dt>Author</dt> <dd>nacin</dd>

<dt>Date</dt> <dd>2012-07-20 13:54:42 +0000 (Fri, 20 Jul 2012)</dd>

</dl>

<h3>Log Message</h3>

<pre>Clarify the return value of has_filter() and has_action(). It returns a boolean if only the first argument is specified. If the second argument is specified, it returns false or an integer, which means it may return a non-boolean value that evaluates to false (so, 0), so you should take care to use the === operator.

Correct the function definition of remove_filter() and remove_action(), which 'accepted' an $accepted_args argument, but did not require or use it.

fixes <a href="http://core.trac.wordpress.org/ticket/19417">#19417</a>.</pre>

<h3>Modified Paths</h3>

<ul>

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

</ul>

</div>

<div id="patch">

<h3>Diff</h3>

<a id="trunkwpincludespluginphp"></a>

<div class="modfile"><h4>Modified: trunk/wp-includes/plugin.php (21287 => 21288)</h4>

<pre class="diff"><span>

<span class="info">--- trunk/wp-includes/plugin.php        2012-07-20 05:25:37 UTC (rev 21287)

+++ trunk/wp-includes/plugin.php        2012-07-20 13:54:42 UTC (rev 21288)

</span><span class="lines">@@ -80,8 +80,11 @@

</span><span class="cx">  * @global array $wp_filter Stores all of the filters

</span><span class="cx">  *

<span class="cx">  * @param string $tag The name of the filter hook.

<del>- * @param callback $function_to_check optional. If specified, return the priority of that function on this hook or false if not attached.

- * @return int|boolean Optionally returns the priority on that hook for the specified function.

</del><ins>+ * @param callback $function_to_check optional.

+ * @return mixed If $function_to_check is omitted, returns boolean for whether the hook has anything registered.

+ *         When checking a specific function, the priority of that hook is returned, or false if the function is not attached.

+ *         When using the $function_to_check argument, this function may return a non-boolean value that evaluates to false

+ *         (e.g.) 0, so use the === operator for testing the return value.

</ins><span class="cx">  */

</span><span class="cx"> function has_filter($tag, $function_to_check = false) {

</span><span class="cx">         global $wp_filter;

</span><span class="lines">@@ -251,7 +254,7 @@

<span class="cx">  * @param int $accepted_args optional. The number of arguments the function accepts (default: 1).

<span class="cx">  * @return boolean Whether the function existed before it was removed.

</span><span class="cx">  */

</span><del>-function remove_filter($tag, $function_to_remove, $priority = 10, $accepted_args = 1) {

</del><ins>+function remove_filter( $tag, $function_to_remove, $priority = 10 ) {

</ins><span class="cx">         $function_to_remove = _wp_filter_build_unique_id($tag, $function_to_remove, $priority);

</span><span class="cx"> 

</span><span class="cx">         $r = isset($GLOBALS['wp_filter'][$tag][$priority][$function_to_remove]);

</span><span class="lines">@@ -494,8 +497,11 @@

<span class="cx">  * @see has_filter() has_action() is an alias of has_filter().

</span><span class="cx">  *

<span class="cx">  * @param string $tag The name of the action hook.

<del>- * @param callback $function_to_check optional. If specified, return the priority of that function on this hook or false if not attached.

- * @return int|boolean Optionally returns the priority on that hook for the specified function.

</del><ins>+ * @param callback $function_to_check optional.

+ * @return mixed If $function_to_check is omitted, returns boolean for whether the hook has anything registered.

+ *         When checking a specific function, the priority of that hook is returned, or false if the function is not attached.

+ *         When using the $function_to_check argument, this function may return a non-boolean value that evaluates to false

+ *         (e.g.) 0, so use the === operator for testing the return value.

</ins><span class="cx">  */

</span><span class="cx"> function has_action($tag, $function_to_check = false) {

</span><span class="cx">         return has_filter($tag, $function_to_check);

</span><span class="lines">@@ -515,11 +521,10 @@

<span class="cx">  * @param string $tag The action hook to which the function to be removed is hooked.

<span class="cx">  * @param callback $function_to_remove The name of the function which should be removed.

<span class="cx">  * @param int $priority optional The priority of the function (default: 10).

<del>- * @param int $accepted_args optional. The number of arguments the function accepts (default: 1).

</del><span class="cx">  * @return boolean Whether the function is removed.

</span><span class="cx">  */

</span><del>-function remove_action($tag, $function_to_remove, $priority = 10, $accepted_args = 1) {

-        return remove_filter($tag, $function_to_remove, $priority, $accepted_args);

</del><ins>+function remove_action( $tag, $function_to_remove, $priority = 10 ) {

+        return remove_filter( $tag, $function_to_remove, $priority );

</ins><span class="cx"> }

</span><span class="cx"> 

</span><span class="cx"> /**

</span></span></pre>

</div>

</div>

</body>

</html>