<!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>[46801] trunk: Docs: Correct `@param` type for the function parameter in `tests_add_filter()` and `_test_filter_build_unique_id()`.</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/46801">46801</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/46801","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>2019-11-29 21:40:58 +0000 (Fri, 29 Nov 2019)</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'>Docs: Correct `@param` type for the function parameter in `tests_add_filter()` and `_test_filter_build_unique_id()`.
Synchronize documentation for `add_filter()`, `tests_add_filter()`, `_wp_filter_build_unique_id()`, `_test_filter_build_unique_id()`.
Add a note that `$tag` and `$priority` are no longer used in `_wp_filter_build_unique_id()` since <a href="https://core.trac.wordpress.org/changeset/46220">[46220]</a>, and the function always returns a string now.
Props donmhico, remcotolsma, SergeyBiryukov.
Fixes <a href="https://core.trac.wordpress.org/ticket/47407">#47407</a>. See <a href="https://core.trac.wordpress.org/ticket/48303">#48303</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>
<li><a href="#trunktestsphpunitincludesfunctionsphp">trunk/tests/phpunit/includes/functions.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 2019-11-29 17:59:47 UTC (rev 46800)
+++ trunk/src/wp-includes/class-wp-hook.php 2019-11-29 21:40:58 UTC (rev 46801)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -64,14 +64,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $tag The name of the filter to hook the $function_to_add callback to.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param callable $function_to_add The callback to be run when the filter is applied.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $priority The order in which the functions associated with a
- * particular action are executed. Lower numbers correspond with
- * earlier execution, and functions with the same priority are executed
- * in the order in which they were added to the action.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $priority The order in which the functions associated with a particular action
+ * are executed. Lower numbers correspond with earlier execution,
+ * and functions with the same priority are executed in the order
+ * in which they were added to the action.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param int $accepted_args The number of arguments the function accepts.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function add_filter( $tag, $function_to_add, $priority, $accepted_args ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $idx = _wp_filter_build_unique_id( $tag, $function_to_add, $priority );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $idx = _wp_filter_build_unique_id( $tag, $function_to_add, $priority );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $priority_existed = isset( $this->callbacks[ $priority ] );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->callbacks[ $priority ][ $idx ] = array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -162,8 +163,7 @@
</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 $tag The filter hook to which the function to be removed is hooked. Used
- * for building the callback ID when SPL is not available.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $tag The filter hook to which the function to be removed is hooked.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param callable $function_to_remove The callback to be removed from running when the filter is applied.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $priority The exact priority used when adding the original filter callback.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return bool Whether the callback existed before it was removed.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -189,8 +189,7 @@
</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 $tag Optional. The name of the filter hook. Used for building
- * the callback ID when SPL is not available. Default empty.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $tag Optional. The name of the filter hook. Default empty.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param callable|bool $function_to_check Optional. The callback to check for. Default false.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return bool|int The priority of that hook is returned, or false if the function is not attached.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</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 2019-11-29 17:59:47 UTC (rev 46800)
+++ trunk/src/wp-includes/plugin.php 2019-11-29 21:40:58 UTC (rev 46801)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -93,15 +93,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 0.71
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @global array $wp_filter A multidimensional array of all hooks and the callbacks hooked to them.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global array $wp_filter A multidimensional array of all hooks and the callbacks hooked to them.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $tag The name of the filter to hook the $function_to_add callback to.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param callable $function_to_add The callback to be run when the filter is applied.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $priority Optional. Used to specify the order in which the functions
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * associated with a particular action are executed. Default 10.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * associated with a particular action are executed.
</ins><span class="cx" style="display: block; padding: 0 10px"> * Lower numbers correspond with earlier execution,
</span><span class="cx" style="display: block; padding: 0 10px"> * and functions with the same priority are executed
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * in the order in which they were added to the action.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * in the order in which they were added to the action. Default 10.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param int $accepted_args Optional. The number of arguments the function accepts. Default 1.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return true
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -119,7 +119,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.5.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">- * @global array $wp_filter Stores all of the filters.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global array $wp_filter Stores all of the filters and actions.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $tag The name of the filter hook.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param callable|bool $function_to_check Optional. The callback to check for. Default false.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -170,7 +170,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 0.71
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @global array $wp_filter Stores all of the filters.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global array $wp_filter Stores all of the filters and actions.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @global array $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><span class="cx" style="display: block; padding: 0 10px"> * @param string $tag The name of the filter hook.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -218,8 +218,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @see apply_filters() This function is identical, but the arguments passed to the
</span><span class="cx" style="display: block; padding: 0 10px"> * functions hooked to `$tag` are supplied using an array.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @global array $wp_filter Stores all of the filters
- * @global array $wp_current_filter Stores the list of current filters with the current one last
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global array $wp_filter Stores all of the filters and actions.
+ * @global array $wp_current_filter Stores the list of current filters with the current one last.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $tag The name of the filter hook.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args The arguments supplied to the functions hooked to $tag.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -266,7 +266,7 @@
</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">- * @global array $wp_filter Stores all of the filters
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global array $wp_filter Stores all of the filters and actions.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $tag The filter hook to which the function to be removed is hooked.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param callable $function_to_remove The name of the function which should be removed.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -292,7 +292,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.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">- * @global array $wp_filter Stores all of the filters
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global array $wp_filter Stores all of the filters and actions.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $tag The filter to remove hooks from.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int|bool $priority Optional. The priority number to remove. Default false.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -433,9 +433,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.3.0 Formalized the existing and already documented `...$arg` parameter
</span><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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @global array $wp_filter Stores all of the filters
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global array $wp_filter Stores all of the filters and actions.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @global array $wp_actions Increments the amount of times action was triggered.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @global array $wp_current_filter Stores the list of current filters with the current one last
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global array $wp_current_filter Stores the list of current filters with the current one last.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $tag The name of the action to be executed.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param mixed ...$arg Optional. Additional arguments which are passed on to the
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -507,9 +507,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @see do_action() This function is identical, but the arguments passed to the
</span><span class="cx" style="display: block; padding: 0 10px"> * functions hooked to `$tag` are supplied using an array.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @global array $wp_filter Stores all of the filters
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global array $wp_filter Stores all of the filters and actions.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @global array $wp_actions Increments the amount of times action was triggered.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @global array $wp_current_filter Stores the list of current filters with the current one last
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global array $wp_current_filter Stores the list of current filters with the current one last.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $tag The name of the action to be executed.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args The arguments supplied to the functions hooked to `$tag`.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -867,7 +867,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.5.0
</span><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">- * @global array $wp_filter Stores all of the filters
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global array $wp_filter Stores all of the filters and actions.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args The collected parameters from the hook that was called.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -897,19 +897,19 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @link https://core.trac.wordpress.org/ticket/3875
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.2.3
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.3.0 Removed workarounds for spl_object_hash().
+ * `$tag` and `$priority` are no longer used,
+ * and the function always returns a string.
</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">- * @global array $wp_filter Storage for all of the filters and actions.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global array $wp_filter Stores all of the filters and actions.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @staticvar int $filter_id_count
</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 $tag Used in counting how many hooks were applied
- * @param callable $function Used for creating unique id
- * @param int|bool $priority Used in counting how many hooks were applied. If === false
- * and $function is an object reference, we return the unique
- * id only if it already has one, false otherwise.
- * @return string|false Unique ID for usage as array key or false if $priority === false
- * and $function is an object reference, and it does not already have
- * a unique id.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $tag Unused. The name of the filter to build ID for.
+ * @param callable $function The function to generate ID for.
+ * @param int $priority Unused. The order in which the functions associated
+ * with a particular action are executed.
+ * @return string Unique ID for usage as array key.
</ins><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( $tag, $function, $priority ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wp_filter;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -920,7 +920,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_object( $function ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Closures are currently implemented as objects
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Closures are currently implemented as objects.
</ins><span class="cx" style="display: block; padding: 0 10px"> $function = array( $function, '' );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $function = (array) $function;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -927,10 +927,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_object( $function[0] ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Object Class Calling
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Object class calling.
</ins><span class="cx" style="display: block; padding: 0 10px"> return spl_object_hash( $function[0] ) . $function[1];
</span><span class="cx" style="display: block; padding: 0 10px"> } elseif ( is_string( $function[0] ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Static Calling
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Static calling.
</ins><span class="cx" style="display: block; padding: 0 10px"> return $function[0] . '::' . $function[1];
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunitincludesfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/includes/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/includes/functions.php 2019-11-29 17:59:47 UTC (rev 46800)
+++ trunk/tests/phpunit/includes/functions.php 2019-11-29 21:40:58 UTC (rev 46801)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -38,11 +38,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Adds hooks before loading WP.
</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 $tag The name for the filter to add.
- * @param object|array $function_to_add The function/callback to execute on call.
- * @param int $priority The priority.
- * @param int $accepted_args The amount of accepted arguments.
- * @return bool Always true.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @see add_filter()
+ *
+ * @param string $tag The name of the filter to hook the $function_to_add callback to.
+ * @param callable $function_to_add The callback to be run when the filter is applied.
+ * @param int $priority Optional. Used to specify the order in which the functions
+ * associated with a particular action are executed.
+ * Lower numbers correspond with earlier execution,
+ * and functions with the same priority are executed
+ * in the order in which they were added to the action. Default 10.
+ * @param int $accepted_args Optional. The number of arguments the function accepts. Default 1.
+ * @return true
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function tests_add_filter( $tag, $function_to_add, $priority = 10, $accepted_args = 1 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wp_filter;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -50,7 +56,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( function_exists( 'add_filter' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( $tag, $function_to_add, $priority, $accepted_args );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $idx = _test_filter_build_unique_id( $tag, $function_to_add, $priority );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $idx = _test_filter_build_unique_id( $tag, $function_to_add, $priority );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $wp_filter[ $tag ][ $priority ][ $idx ] = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'function' => $function_to_add,
</span><span class="cx" style="display: block; padding: 0 10px"> 'accepted_args' => $accepted_args,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -62,10 +69,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Generates a unique function ID based on the given arguments.
</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 $tag Unused. The name of the filter to build ID for.
- * @param object|array $function The function to generate ID for.
- * @param int $priority Unused. The priority.
- * @return string Unique function ID.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @see _wp_filter_build_unique_id()
+ *
+ * @param string $tag Unused. The name of the filter to build ID for.
+ * @param callable $function The function to generate ID for.
+ * @param int $priority Unused. The order in which the functions
+ * associated with a particular action are executed.
+ * @return string Unique function ID for usage as array key.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function _test_filter_build_unique_id( $tag, $function, $priority ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_string( $function ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -80,9 +90,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_object( $function[0] ) ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Object class calling.
</ins><span class="cx" style="display: block; padding: 0 10px"> return spl_object_hash( $function[0] ) . $function[1];
</span><span class="cx" style="display: block; padding: 0 10px"> } elseif ( is_string( $function[0] ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Static Calling.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Static calling.
</ins><span class="cx" style="display: block; padding: 0 10px"> return $function[0] . $function[1];
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>