<!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>[45420] trunk/src/wp-includes: Docs: Improve and correct documentation for hook-related variadic 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/45420">45420</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/45420","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>2019-05-25 22:51:14 +0000 (Sat, 25 May 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: Improve and correct documentation for hook-related variadic functions.
See <a href="https://core.trac.wordpress.org/ticket/37402">#37402</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 2019-05-25 22:26:22 UTC (rev 45419)
+++ trunk/src/wp-includes/class-wp-hook.php 2019-05-25 22:51:14 UTC (rev 45420)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -253,12 +253,12 @@
</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"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Calls the callback functions added to a filter hook.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Calls the callback functions that have been added to a filter hook.
</ins><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><span class="cx" style="display: block; padding: 0 10px"> * @param mixed $value The value to filter.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $args Arguments to pass to callbacks.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $args Additional parameters to pass to the callback functions.
</ins><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"> public function apply_filters( $value, $args ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -299,11 +299,11 @@
</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"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Executes the callback functions hooked on a specific action hook.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Calls the callback functions that have been added to an action hook.
</ins><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 mixed $args Arguments to pass to the hook callbacks.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $args Parameters to pass to the callback functions.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function do_action( $args ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->doing_action = true;
</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-05-25 22:26:22 UTC (rev 45419)
+++ trunk/src/wp-includes/plugin.php 2019-05-25 22:51:14 UTC (rev 45420)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -141,16 +141,18 @@
</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"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Call the functions added to a filter hook.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Calls the callback functions that have been added to a filter hook.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * The callback functions attached to filter hook $tag are invoked by calling
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The callback functions attached to the filter hook are invoked by calling
</ins><span class="cx" style="display: block; padding: 0 10px"> * this function. This function can be used to create a new filter hook by
</span><span class="cx" style="display: block; padding: 0 10px"> * simply calling this function with the name of the new hook specified using
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * the $tag parameter.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * the `$tag` parameter.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * The function allows for additional arguments to be added and passed to hooks.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The function also allows for multiple additional arguments to be passed to hooks.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * // Our filter callback function
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Example usage:
+ *
+ * // The filter callback function
</ins><span class="cx" style="display: block; padding: 0 10px"> * function example_callback( $string, $arg1, $arg2 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> * // (maybe) modify $string
</span><span class="cx" style="display: block; padding: 0 10px"> * return $string;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -158,9 +160,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * add_filter( 'example_filter', 'example_callback', 10, 3 );
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * /*
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * * Apply the filters by calling the 'example_callback' function we
- * * "hooked" to 'example_filter' using the add_filter() function above.
- * * - 'example_filter' is the filter hook $tag
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * * Apply the filters by calling the 'example_callback()' function that's
+ * * hooked onto `example_filter` above.
+ * *
+ * * - 'example_filter' is the filter hook
</ins><span class="cx" style="display: block; padding: 0 10px"> * * - 'filter me' is the value being filtered
</span><span class="cx" style="display: block; padding: 0 10px"> * * - $arg1 and $arg2 are the additional arguments passed to the callback.
</span><span class="cx" style="display: block; padding: 0 10px"> * $value = apply_filters( 'example_filter', 'filter me', $arg1, $arg2 );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -170,9 +173,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @global array $wp_filter Stores all of the filters.
</span><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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $tag The name of the filter hook.
- * @param mixed $value The value on which the filters hooked to `$tag` are applied on.
- * @param mixed ...$var Additional variables passed to the functions hooked to `$tag`.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $tag The name of the filter hook.
+ * @param mixed $value The value to filter.
+ * @param mixed ...$args Additional parameters to pass to the callback functions.
</ins><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( $tag, $value ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -213,7 +216,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"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Execute functions hooked on a specific filter hook, specifying arguments in an array.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Calls the callback functions that have been added to a filter hook, specifying arguments in an array.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -413,8 +416,24 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * possible to create new action hooks by simply calling this function,
</span><span class="cx" style="display: block; padding: 0 10px"> * specifying the name of the new hook using the `$tag` parameter.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * You can pass extra arguments to the hooks, much like you can with apply_filters().
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * You can pass extra arguments to the hooks, much like you can with `apply_filters()`.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Example usage:
+ *
+ * // The action callback function
+ * function example_callback( $arg1, $arg2 ) {
+ * // (maybe) do something with the args
+ * }
+ * add_action( 'example_action', 'example_callback', 10, 2 );
+ *
+ * /*
+ * * Trigger the actions by calling the 'example_callback()' function that's
+ * * hooked onto `example_action` above.
+ * *
+ * * - 'example_action' is the action hook
+ * * - $arg1 and $arg2 are the additional arguments passed to the callback.
+ * $value = apply_actions( 'example_action', $arg1, $arg2 );
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 1.2.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @global array $wp_filter Stores all of the filters
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -488,12 +507,12 @@
</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"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Execute functions hooked on a specific action hook, specifying arguments in an array.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Calls the callback functions that have been added to an action hook, specifying arguments in an array.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.1.0
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * functions hooked to $tag< are supplied using an array.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * functions hooked to `$tag` are supplied using an array.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @global array $wp_filter Stores all of the filters
</span><span class="cx" style="display: block; padding: 0 10px"> * @global array $wp_actions Increments the amount of times action was triggered.
</span><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></pre>
</div>
</div>
</body>
</html>