<!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>[52300] trunk/src/wp-includes: Plugins: Correct the documented allowable types for to the `$callback` parameter of various hook related functions.</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/52300">52300</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/52300","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>johnbillion</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2021-12-01 13:20:36 +0000 (Wed, 01 Dec 2021)</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: Correct the documented allowable types for to the `$callback` parameter of various hook related functions.
These functions don't require the callback to be a valid callable, therefore `array` and `string` are also valid types for this parameter.
Props malthert
Fixes <a href="https://core.trac.wordpress.org/ticket/54440">#54440</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswphookphp">trunk/src/wp-includes/class-wp-hook.php</a></li>
<li><a href="#trunksrcwpincludespluginphp">trunk/src/wp-includes/plugin.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswphookphp"></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/class-wp-hook.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-hook.php 2021-12-01 12:15:21 UTC (rev 52299)
+++ trunk/src/wp-includes/class-wp-hook.php 2021-12-01 13:20:36 UTC (rev 52300)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -168,9 +168,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.7.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $hook_name The filter hook to which the function to be removed is hooked.
- * @param callable $callback The callback to be removed from running when the filter is applied.
- * @param int $priority The exact priority used when adding the original filter callback.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $hook_name The filter hook to which the function to be removed is hooked.
+ * @param callable|string|array $callback The callback to be removed from running when the filter is applied.
+ * This method can be called unconditionally to speculatively remove
+ * a callback that may or may not exist.
+ * @param int $priority The exact priority used when adding the original filter callback.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool Whether the callback existed before it was removed.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function remove_filter( $hook_name, $callback, $priority ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -201,8 +203,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.7.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $hook_name Optional. The name of the filter hook. Default empty.
- * @param callable|false $callback Optional. The callback to check for. Default false.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $hook_name Optional. The name of the filter hook. Default empty.
+ * @param callable|string|array|false $callback Optional. The callback to check for.
+ * This method can be called unconditionally to speculatively check
+ * a callback that may or may not exist. Default false.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool|int If `$callback` is omitted, returns boolean for whether the hook has
</span><span class="cx" style="display: block; padding: 0 10px"> * anything registered. When checking a specific function, the priority
</span><span class="cx" style="display: block; padding: 0 10px"> * of that hook is returned, or false if the function is not attached.
</span></span></pre></div>
<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 2021-12-01 12:15:21 UTC (rev 52299)
+++ trunk/src/wp-includes/plugin.php 2021-12-01 13:20:36 UTC (rev 52300)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -247,8 +247,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @global WP_Hook[] $wp_filter Stores all of the filters and actions.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $hook_name The name of the filter hook.
- * @param callable|false $callback Optional. The callback to check for. Default false.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $hook_name The name of the filter hook.
+ * @param callable|string|array|false $callback Optional. The callback to check for.
+ * This function can be called unconditionally to speculatively check
+ * a callback that may or may not exist. Default false.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool|int If `$callback` is omitted, returns boolean for whether the hook has
</span><span class="cx" style="display: block; padding: 0 10px"> * anything registered. When checking a specific function, the priority
</span><span class="cx" style="display: block; padding: 0 10px"> * of that hook is returned, or false if the function is not attached.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -277,10 +279,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @global WP_Hook[] $wp_filter Stores all of the filters and actions.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $hook_name The filter hook to which the function to be removed is hooked.
- * @param callable $callback The name of the function which should be removed.
- * @param int $priority Optional. The exact priority used when adding the original
- * filter callback. Default 10.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $hook_name The filter hook to which the function to be removed is hooked.
+ * @param callable|string|array $callback The callback to be removed from running when the filter is applied.
+ * This function can be called unconditionally to speculatively remove
+ * a callback that may or may not exist.
+ * @param int $priority Optional. The exact priority used when adding the original
+ * filter callback. Default 10.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool Whether the function existed before it was removed.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function remove_filter( $hook_name, $callback, $priority = 10 ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -530,8 +534,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @see has_filter() has_action() is an alias of has_filter().
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $hook_name The name of the action hook.
- * @param callable|false $callback Optional. The callback to check for. Default false.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $hook_name The name of the action hook.
+ * @param callable|string|array|false $callback Optional. The callback to check for.
+ * This function can be called unconditionally to speculatively check
+ * a callback that may or may not exist. Default false.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool|int If `$callback` is omitted, returns boolean for whether the hook has
</span><span class="cx" style="display: block; padding: 0 10px"> * anything registered. When checking a specific function, the priority
</span><span class="cx" style="display: block; padding: 0 10px"> * of that hook is returned, or false if the function is not attached.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -552,10 +558,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.2.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $hook_name The action hook to which the function to be removed is hooked.
- * @param callable $callback The name of the function which should be removed.
- * @param int $priority Optional. The exact priority used when adding the original
- * action callback. Default 10.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $hook_name The action hook to which the function to be removed is hooked.
+ * @param callable|string|array $callback The name of the function which should be removed.
+ * This function can be called unconditionally to speculatively remove
+ * a callback that may or may not exist.
+ * @param int $priority Optional. The exact priority used when adding the original
+ * action callback. Default 10.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool Whether the function is removed.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function remove_action( $hook_name, $callback, $priority = 10 ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -924,12 +932,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.3.0 Removed workarounds for spl_object_hash().
</span><span class="cx" style="display: block; padding: 0 10px"> * `$hook_name` and `$priority` are no longer used,
</span><span class="cx" style="display: block; padding: 0 10px"> * and the function always returns a string.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @access private
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $hook_name Unused. The name of the filter to build ID for.
- * @param callable $callback The function to generate ID for.
- * @param int $priority Unused. The order in which the functions
- * associated with a particular action are executed.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $hook_name Unused. The name of the filter to build ID for.
+ * @param callable|string|array $callback The callback to generate ID for. The callback may
+ * or may not exist.
+ * @param int $priority Unused. The order in which the functions
+ * associated with a particular action are executed.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string Unique function ID for usage as array key.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function _wp_filter_build_unique_id( $hook_name, $callback, $priority ) {
</span></span></pre>
</div>
</div>
</body>
</html>