<!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>[49196] trunk/src: Docs: Improve the docs for the globals that are used in the actions and filters API.</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/49196">49196</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/49196","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>2020-10-18 19:17:29 +0000 (Sun, 18 Oct 2020)</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 the docs for the globals that are used in the actions and filters API.
See <a href="https://core.trac.wordpress.org/ticket/50531">#50531</a>, <a href="https://core.trac.wordpress.org/ticket/50768">#50768</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesclasswpimporterphp">trunk/src/wp-admin/includes/class-wp-importer.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="trunksrcwpadminincludesclasswpimporterphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/class-wp-importer.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/class-wp-importer.php 2020-10-18 17:37:19 UTC (rev 49195)
+++ trunk/src/wp-admin/includes/class-wp-importer.php 2020-10-18 19:17:29 UTC (rev 49196)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -261,7 +261,7 @@
</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="cx" style="display: block; padding: 0 10px"> * @global wpdb $wpdb WordPress database abstraction object.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @global array $wp_actions
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global int[] $wp_actions
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function stop_the_insanity() {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wpdb, $wp_actions;
</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 2020-10-18 17:37:19 UTC (rev 49195)
+++ trunk/src/wp-includes/plugin.php 2020-10-18 19:17:29 UTC (rev 49196)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -25,8 +25,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> require __DIR__ . '/class-wp-hook.php';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /** @var WP_Hook[] $wp_filter */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-global $wp_filter, $wp_actions, $wp_current_filter;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+global $wp_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">+/** @var int[] $wp_actions */
+global $wp_actions;
+
+/** @var string[] $wp_current_filter */
+global $wp_current_filter;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $wp_filter ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $wp_filter = WP_Hook::build_preinitialized_hooks( $wp_filter );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -93,7 +99,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 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 WP_Hook[] $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="lines" style="display: block; padding: 0 10px; color: #888">@@ -119,7 +125,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 and actions.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global WP_Hook[] $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,8 +176,8 @@
</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 and actions.
- * @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 WP_Hook[] $wp_filter Stores all of the filters and actions.
+ * @global string[] $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 mixed $value The value to filter.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -218,8 +224,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 and actions.
- * @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 WP_Hook[] $wp_filter Stores all of the filters and actions.
+ * @global string[] $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 +272,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 and actions.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global WP_Hook[] $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 +298,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 and actions.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global WP_Hook[] $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">@@ -316,7 +322,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_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 string[] $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"> * @return string Hook name of the current filter or action.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -351,7 +357,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @see current_filter()
</span><span class="cx" style="display: block; padding: 0 10px"> * @see did_action()
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @global array $wp_current_filter Current filter.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global string[] $wp_current_filter Current filter.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param null|string $filter Optional. Filter to check. Defaults to null, which
</span><span class="cx" style="display: block; padding: 0 10px"> * checks if any filter is currently being run.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -433,9 +439,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 and actions.
- * @global array $wp_actions Increments the amount of times action was triggered.
- * @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 WP_Hook[] $wp_filter Stores all of the filters and actions.
+ * @global int[] $wp_actions Stores the number of times each action was triggered.
+ * @global string[] $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">@@ -485,7 +491,7 @@
</span><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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @global array $wp_actions Increments the amount of times action was triggered.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global int[] $wp_actions Stores the number of times each action was triggered.
</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 hook.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return int The number of times action hook $tag is fired.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -507,10 +513,11 @@
</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 and actions.
- * @global array $wp_actions Increments the amount of times action was triggered.
- * @global array $wp_current_filter Stores the list of current filters with the current one last.
</del><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global WP_Hook[] $wp_filter Stores all of the filters and actions.
+ * @global int[] $wp_actions Stores the number of times each action was triggered.
+ * @global string[] $wp_current_filter Stores the list of current filters with the current one last.
+ *
</ins><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="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -865,7 +872,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 and actions.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global WP_Hook[] $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></pre>
</div>
</div>
</body>
</html>