<!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>[28888] trunk/src/wp-includes/plugin.php: More tweaks to @param docs in wp-includes/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">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/28888">28888</a></dd>
<dt>Author</dt> <dd>SergeyBiryukov</dd>
<dt>Date</dt> <dd>2014-06-29 08:41:38 +0000 (Sun, 29 Jun 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>More tweaks to @param docs in wp-includes/plugin.php.
see <a href="http://core.trac.wordpress.org/ticket/28516">#28516</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>Modified: trunk/src/wp-includes/plugin.php (28887 => 28888)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/plugin.php 2014-06-28 23:02:05 UTC (rev 28887)
+++ trunk/src/wp-includes/plugin.php 2014-06-29 08:41:38 UTC (rev 28888)
</span><span class="lines">@@ -70,10 +70,12 @@
</span><span class="cx"> *
</span><span class="cx"> * @param string $tag The name of the filter to hook the $function_to_add callback to.
</span><span class="cx"> * @param callback $function_to_add The callback to be run when the filter is applied.
</span><del>- * @param int $priority (optional) 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.
</del><ins>+ * @param int $priority Optional. Used to specify the order in which the functions
+ * associated with a particular action are executed. Default 10.
+ * 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.
+ * @param int $accepted_args Optional. The number of arguments the function accepts. Default 1.
</ins><span class="cx"> * @return boolean true
</span><span class="cx"> */
</span><span class="cx"> function add_filter( $tag, $function_to_add, $priority = 10, $accepted_args = 1 ) {
</span><span class="lines">@@ -92,8 +94,8 @@
</span><span class="cx"> *
</span><span class="cx"> * @global array $wp_filter Stores all of the filters
</span><span class="cx"> *
</span><del>- * @param string $tag The name of the filter hook.
- * @param bool|callback $function_to_check optional.
</del><ins>+ * @param string $tag The name of the filter hook.
+ * @param bool|callback $function_to_check Optional. The callback to check for. Default false.
</ins><span class="cx"> * @return mixed If $function_to_check is omitted, returns boolean for whether the hook has anything registered.
</span><span class="cx"> * When checking a specific function, the priority of that hook is returned, or false if the function is not attached.
</span><span class="cx"> * When using the $function_to_check argument, this function may return a non-boolean value that evaluates to false
</span><span class="lines">@@ -142,15 +144,15 @@
</span><span class="cx"> * $value = apply_filters( 'example_filter', 'filter me', $arg1, $arg2 );
</span><span class="cx"> * </code>
</span><span class="cx"> *
</span><del>- * @global array $wp_filter Stores all of the filters
</del><ins>+ * @global array $wp_filter Stores all of the filters.
</ins><span class="cx"> * @global array $merged_filters Merges the filter hooks using this function.
</span><del>- * @global array $wp_current_filter stores the list of current filters with the current one last
</del><ins>+ * @global array $wp_current_filter Stores the list of current filters with the current one last.
</ins><span class="cx"> *
</span><span class="cx"> * @since 0.71
</span><span class="cx"> *
</span><del>- * @param string $tag The name of the filter hook.
- * @param mixed $value The value on which the filters hooked to <tt>$tag</tt> are applied on.
- * @param mixed $var Additional variables passed to the functions hooked to <tt>$tag</tt>.
</del><ins>+ * @param string $tag The name of the filter hook.
+ * @param mixed $value The value on which the filters hooked to <tt>$tag</tt> are applied on.
+ * @param mixed $var Additional variables passed to the functions hooked to <tt>$tag</tt>.
</ins><span class="cx"> * @return mixed The filtered value after all hooked functions are applied to it.
</span><span class="cx"> */
</span><span class="cx"> function apply_filters( $tag, $value ) {
</span><span class="lines">@@ -210,8 +212,8 @@
</span><span class="cx"> * @global array $merged_filters Merges the filter hooks using this function.
</span><span class="cx"> * @global array $wp_current_filter stores the list of current filters with the current one last
</span><span class="cx"> *
</span><del>- * @param string $tag The name of the filter hook.
- * @param array $args The arguments supplied to the functions hooked to <tt>$tag</tt>
</del><ins>+ * @param string $tag The name of the filter hook.
+ * @param array $args The arguments supplied to the functions hooked to <tt>$tag</tt>.
</ins><span class="cx"> * @return mixed The filtered value after all hooked functions are applied to it.
</span><span class="cx"> */
</span><span class="cx"> function apply_filters_ref_array($tag, $args) {
</span><span class="lines">@@ -266,9 +268,9 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 1.2.0
</span><span class="cx"> *
</span><del>- * @param string $tag The filter hook to which the function to be removed is hooked.
</del><ins>+ * @param string $tag The filter hook to which the function to be removed is hooked.
</ins><span class="cx"> * @param callback $function_to_remove The name of the function which should be removed.
</span><del>- * @param int $priority optional. The priority of the function (default: 10).
</del><ins>+ * @param int $priority Optional. The priority of the function. Default 10.
</ins><span class="cx"> * @return boolean Whether the function existed before it was removed.
</span><span class="cx"> */
</span><span class="cx"> function remove_filter( $tag, $function_to_remove, $priority = 10 ) {
</span><span class="lines">@@ -295,8 +297,8 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 2.7.0
</span><span class="cx"> *
</span><del>- * @param string $tag The filter to remove hooks from.
- * @param bool|int $priority The priority number to remove.
</del><ins>+ * @param string $tag The filter to remove hooks from.
+ * @param bool|int $priority Optional. The priority number to remove. Default false.
</ins><span class="cx"> * @return bool True when finished.
</span><span class="cx"> */
</span><span class="cx"> function remove_all_filters( $tag, $priority = false ) {
</span><span class="lines">@@ -398,10 +400,14 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 1.2.0
</span><span class="cx"> *
</span><del>- * @param string $tag The name of the action to which the $function_to_add is hooked.
</del><ins>+ * @param string $tag The name of the action to which the $function_to_add is hooked.
</ins><span class="cx"> * @param callback $function_to_add The name of the function you wish to be called.
</span><del>- * @param int $priority optional. Used to specify the order in which the functions associated with a particular action are executed (default: 10). 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.
- * @param int $accepted_args optional. The number of arguments the function accept (default 1).
</del><ins>+ * @param int $priority Optional. Used to specify the order in which the functions
+ * associated with a particular action are executed. Default 10.
+ * 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.
+ * @param int $accepted_args Optional. The number of arguments the function accept. Default 1.
</ins><span class="cx"> * @return bool Will always return true.
</span><span class="cx"> */
</span><span class="cx"> function add_action($tag, $function_to_add, $priority = 10, $accepted_args = 1) {
</span><span class="lines">@@ -426,8 +432,8 @@
</span><span class="cx"> * @global array $wp_filter Stores all of the filters
</span><span class="cx"> * @global array $wp_actions Increments the amount of times action was triggered.
</span><span class="cx"> *
</span><del>- * @param string $tag The name of the action to be executed.
- * @param mixed $arg,... Optional additional arguments which are passed on to the functions hooked to the action.
</del><ins>+ * @param string $tag The name of the action to be executed.
+ * @param mixed $arg, ... Optional. Additional arguments which are passed on to the functions hooked to the action.
</ins><span class="cx"> * @return null Will return null if $tag does not exist in $wp_filter array
</span><span class="cx"> */
</span><span class="cx"> function do_action($tag, $arg = '') {
</span><span class="lines">@@ -510,8 +516,8 @@
</span><span class="cx"> * @global array $wp_filter Stores all of the filters
</span><span class="cx"> * @global array $wp_actions Increments the amount of times action was triggered.
</span><span class="cx"> *
</span><del>- * @param string $tag The name of the action to be executed.
- * @param array $args The arguments supplied to the functions hooked to <tt>$tag</tt>
</del><ins>+ * @param string $tag The name of the action to be executed.
+ * @param array $args The arguments supplied to the functions hooked to <tt>$tag</tt>
</ins><span class="cx"> * @return null Will return null if $tag does not exist in $wp_filter array
</span><span class="cx"> */
</span><span class="cx"> function do_action_ref_array($tag, $args) {
</span><span class="lines">@@ -563,8 +569,8 @@
</span><span class="cx"> *
</span><span class="cx"> * @see has_filter() has_action() is an alias of has_filter().
</span><span class="cx"> *
</span><del>- * @param string $tag The name of the action hook.
- * @param bool|callback $function_to_check optional.
</del><ins>+ * @param string $tag The name of the action hook.
+ * @param bool|callback $function_to_check Optional. The callback to check for. Default false.
</ins><span class="cx"> * @return mixed If $function_to_check is omitted, returns boolean for whether the hook has anything registered.
</span><span class="cx"> * When checking a specific function, the priority of that hook is returned, or false if the function is not attached.
</span><span class="cx"> * When using the $function_to_check argument, this function may return a non-boolean value that evaluates to false
</span><span class="lines">@@ -583,9 +589,9 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 1.2.0
</span><span class="cx"> *
</span><del>- * @param string $tag The action hook to which the function to be removed is hooked.
</del><ins>+ * @param string $tag The action hook to which the function to be removed is hooked.
</ins><span class="cx"> * @param callback $function_to_remove The name of the function which should be removed.
</span><del>- * @param int $priority optional The priority of the function (default: 10).
</del><ins>+ * @param int $priority Optional. The priority of the function. Default 10.
</ins><span class="cx"> * @return boolean Whether the function is removed.
</span><span class="cx"> */
</span><span class="cx"> function remove_action( $tag, $function_to_remove, $priority = 10 ) {
</span><span class="lines">@@ -597,8 +603,8 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 2.7.0
</span><span class="cx"> *
</span><del>- * @param string $tag The action to remove hooks from.
- * @param bool|int $priority The priority number to remove them from.
</del><ins>+ * @param string $tag The action to remove hooks from.
+ * @param bool|int $priority The priority number to remove them from. Default false.
</ins><span class="cx"> * @return bool True when finished.
</span><span class="cx"> */
</span><span class="cx"> function remove_all_actions($tag, $priority = false) {
</span></span></pre>
</div>
</div>
</body>
</html>