<!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>[32615] trunk/src/wp-includes/plugin.php: Add missing doc blocks to `plugin.php`.</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 { 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/32615">32615</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/32615","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>wonderboymusic</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-05-27 15:55:35 +0000 (Wed, 27 May 2015)</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'>Add missing doc blocks to `plugin.php`.
`has_filter()` can use strict comparison when checking `$has` internally.
See <a href="https://core.trac.wordpress.org/ticket/32444">#32444</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludespluginphp">trunk/src/wp-includes/plugin.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<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 2015-05-27 15:31:46 UTC (rev 32614)
+++ trunk/src/wp-includes/plugin.php 2015-05-27 15:55:35 UTC (rev 32615)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -76,7 +76,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * and functions with the same priority are executed
</span><span class="cx" style="display: block; padding: 0 10px"> * in the order in which they were added to the action.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $accepted_args Optional. The number of arguments the function accepts. Default 1.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return boolean true
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return true
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function add_filter( $tag, $function_to_add, $priority = 10, $accepted_args = 1 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wp_filter, $merged_filters;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -96,12 +96,12 @@
</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="cx" style="display: block; padding: 0 10px"> * @param callback|bool $function_to_check Optional. The callback to check for. Default false.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return bool|int 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.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return false|int 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" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function has_filter($tag, $function_to_check = false) {
</span><span class="cx" style="display: block; padding: 0 10px"> // Don't reset the internal array pointer
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -124,7 +124,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">- if ( false === $function_to_check || false == $has )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( false === $function_to_check || false === $has )
</ins><span class="cx" style="display: block; padding: 0 10px"> return $has;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( !$idx = _wp_filter_build_unique_id($tag, $function_to_check, false) )
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -288,10 +288,13 @@
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global array $wp_filter Stores all of the filters
+ * @global array $merged_filters Merges the filter hooks using this function.
+ *
</ins><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 callback $function_to_remove The name of the function which should be removed.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $priority Optional. The priority of the function. Default 10.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return boolean Whether the function existed before it was removed.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool Whether the function existed before it was removed.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function remove_filter( $tag, $function_to_remove, $priority = 10 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $function_to_remove = _wp_filter_build_unique_id( $tag, $function_to_remove, $priority );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -317,9 +320,12 @@
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global array $wp_filter Stores all of the filters
+ * @global array $merged_filters Merges the filter hooks using this function.
+ *
</ins><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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return bool True when finished.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return true True when finished.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function remove_all_filters( $tag, $priority = false ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wp_filter, $merged_filters;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -342,6 +348,8 @@
</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><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"> * @return string Hook name of the current filter or action.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function current_filter() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -422,7 +430,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * and functions with the same priority are executed
</span><span class="cx" style="display: block; padding: 0 10px"> * in the order in which they were added to the action.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $accepted_args Optional. The number of arguments the function accept. Default 1.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return bool Will always return true.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return true Will always return true.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function add_action($tag, $function_to_add, $priority = 10, $accepted_args = 1) {
</span><span class="cx" style="display: block; padding: 0 10px"> return add_filter($tag, $function_to_add, $priority, $accepted_args);
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -440,13 +448,14 @@
</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
- * @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 array $wp_filter Stores all of the filters
+ * @global array $wp_actions Increments the amount of times action was triggered.
+ * @global array $merged_filters Merges the filter hooks using this function.
+ * @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="cx" style="display: block; padding: 0 10px"> * functions hooked to the action. Default empty.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return null Will return null if $tag does not exist in $wp_filter array.
</del><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function do_action($tag, $arg = '') {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wp_filter, $wp_actions, $merged_filters, $wp_current_filter;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -524,12 +533,13 @@
</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
- * @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 array $wp_filter Stores all of the filters
+ * @global array $wp_actions Increments the amount of times action was triggered.
+ * @global array $merged_filters Merges the filter hooks using this function.
+ * @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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return null Will return null if `$tag` does not exist in `$wp_filter` array.
</del><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function do_action_ref_array($tag, $args) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wp_filter, $wp_actions, $merged_filters, $wp_current_filter;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -618,7 +628,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $tag The action to remove hooks from.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int|bool $priority The priority number to remove them from. Default false.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return bool True when finished.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return true True when finished.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function remove_all_actions($tag, $priority = false) {
</span><span class="cx" style="display: block; padding: 0 10px"> return remove_all_filters($tag, $priority);
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -635,6 +645,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global array $wp_plugin_paths
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $file The filename of plugin.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string The name of a plugin.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -665,6 +677,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @see plugin_basename()
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global array $wp_plugin_paths
+ *
+ * @staticvar string $wp_plugin_path
+ * @staticvar string $wpmu_plugin_path
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $file Known path to the file.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return bool Whether the path was able to be registered.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -819,6 +836,8 @@
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global array $wp_filter Stores all of the filters
+ *
</ins><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="cx" style="display: block; padding: 0 10px"> function _wp_call_all_hook($args) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -856,15 +875,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @access private
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @global array $wp_filter Storage for all of the filters and actions.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @staticvar int $filter_id_count
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $tag Used in counting how many hooks were applied
</span><span class="cx" style="display: block; padding: 0 10px"> * @param callback $function Used for creating unique id
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int|bool $priority Used in counting how many hooks were applied. If === false
</span><span class="cx" style="display: block; padding: 0 10px"> * and $function is an object reference, we return the unique
</span><span class="cx" style="display: block; padding: 0 10px"> * id only if it already has one, false otherwise.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return string|bool 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">+ * @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.
</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></pre>
</div>
</div>
</body>
</html>