<!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>[28891] trunk/src/wp-includes/plugin.php: General phpDoc fixes 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/28891">28891</a></dd>
<dt>Author</dt> <dd>DrewAPicture</dd>
<dt>Date</dt> <dd>2014-06-29 09:18:41 +0000 (Sun, 29 Jun 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>General phpDoc fixes 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 (28890 => 28891)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/plugin.php 2014-06-29 09:15:08 UTC (rev 28890)
+++ trunk/src/wp-includes/plugin.php 2014-06-29 09:18:41 UTC (rev 28891)
</span><span class="lines">@@ -35,7 +35,7 @@
</span><span class="cx"> $wp_current_filter = array();
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Hooks a function or method to a specific filter action.
</del><ins>+ * Hook a function or method to a specific filter action.
</ins><span class="cx"> *
</span><span class="cx"> * WordPress offers filter hooks to allow plugins to modify
</span><span class="cx"> * various types of internal data at runtime.
</span><span class="lines">@@ -63,11 +63,12 @@
</span><span class="cx"> * is valid. It is up to you to take care. This is done for optimization purposes,
</span><span class="cx"> * so everything is as quick as possible.
</span><span class="cx"> *
</span><ins>+ * @since 0.71
+ *
</ins><span class="cx"> * @global array $wp_filter A multidimensional array of all hooks and the callbacks hooked to them.
</span><del>- * @global array $merged_filters Tracks the tags that need to be merged for later. If the hook is added, it doesn't need to run through that process.
</del><ins>+ * @global array $merged_filters Tracks the tags that need to be merged for later. If the hook is added,
+ * it doesn't need to run through that process.
</ins><span class="cx"> *
</span><del>- * @since 0.71
- *
</del><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><span class="cx"> * @param int $priority Optional. Used to specify the order in which the functions
</span><span class="lines">@@ -92,14 +93,16 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 2.5.0
</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"> *
</span><span class="cx"> * @param string $tag The name of the filter hook.
</span><span class="cx"> * @param callback|bool $function_to_check Optional. The callback to check for. Default false.
</span><del>- * @return mixed 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>+ * @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.
</ins><span class="cx"> */
</span><span class="cx"> function has_filter($tag, $function_to_check = false) {
</span><span class="cx"> global $wp_filter;
</span><span class="lines">@@ -144,12 +147,12 @@
</span><span class="cx"> * $value = apply_filters( 'example_filter', 'filter me', $arg1, $arg2 );
</span><span class="cx"> * </code>
</span><span class="cx"> *
</span><ins>+ * @since 0.71
+ *
</ins><span class="cx"> * @global array $wp_filter Stores all of the filters.
</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>- * @since 0.71
- *
</del><span class="cx"> * @param string $tag The name of the filter hook.
</span><span class="cx"> * @param mixed $value The value on which the filters hooked to <tt>$tag</tt> are applied on.
</span><span class="cx"> * @param mixed $var Additional variables passed to the functions hooked to <tt>$tag</tt>.
</span><span class="lines">@@ -160,7 +163,7 @@
</span><span class="cx">
</span><span class="cx"> $args = array();
</span><span class="cx">
</span><del>- // Do 'all' actions first
</del><ins>+ // Do 'all' actions first.
</ins><span class="cx"> if ( isset($wp_filter['all']) ) {
</span><span class="cx"> $wp_current_filter[] = $tag;
</span><span class="cx"> $args = func_get_args();
</span><span class="lines">@@ -176,7 +179,7 @@
</span><span class="cx"> if ( !isset($wp_filter['all']) )
</span><span class="cx"> $wp_current_filter[] = $tag;
</span><span class="cx">
</span><del>- // Sort
</del><ins>+ // Sort.
</ins><span class="cx"> if ( !isset( $merged_filters[ $tag ] ) ) {
</span><span class="cx"> ksort($wp_filter[$tag]);
</span><span class="cx"> $merged_filters[ $tag ] = true;
</span><span class="lines">@@ -208,12 +211,13 @@
</span><span class="cx"> * functions hooked to <tt>$tag</tt> are supplied using an array.
</span><span class="cx"> *
</span><span class="cx"> * @since 3.0.0
</span><del>- * @global array $wp_filter Stores all of the filters
- * @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
</del><span class="cx"> *
</span><ins>+ * @global array $wp_filter Stores all of the filters
+ * @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"> * @param string $tag The name of the filter hook.
</span><del>- * @param array $args The arguments supplied to the functions hooked to <tt>$tag</tt>.
</del><ins>+ * @param array $args The arguments supplied to the functions hooked to $tag.
</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">@@ -349,7 +353,9 @@
</span><span class="cx"> *
</span><span class="cx"> * The function current_filter() only returns the most recent filter or action
</span><span class="cx"> * being executed. did_action() returns true once the action is initially
</span><del>- * processed. This function allows detection for any filter currently being
</del><ins>+ * processed.
+ *
+ * This function allows detection for any filter currently being
</ins><span class="cx"> * executed (despite not being the most recent filter to fire, in the case of
</span><span class="cx"> * hooks called from hook callbacks) to be verified.
</span><span class="cx"> *
</span><span class="lines">@@ -361,7 +367,7 @@
</span><span class="cx"> *
</span><span class="cx"> * @param null|string $filter Optional. Filter to check. Defaults to null, which
</span><span class="cx"> * checks if any filter is currently being run.
</span><del>- * @return bool Whether the filter is currently in the stack
</del><ins>+ * @return bool Whether the filter is currently in the stack.
</ins><span class="cx"> */
</span><span class="cx"> function doing_filter( $filter = null ) {
</span><span class="cx"> global $wp_current_filter;
</span><span class="lines">@@ -396,10 +402,10 @@
</span><span class="cx"> * one or more of its PHP functions are executed at these points, using the
</span><span class="cx"> * Action API.
</span><span class="cx"> *
</span><ins>+ * @since 1.2.0
+ *
</ins><span class="cx"> * @uses add_filter() Adds an action. Parameter list and functionality are the same.
</span><span class="cx"> *
</span><del>- * @since 1.2.0
- *
</del><span class="cx"> * @param string $tag The name of the action to which the $function_to_add is hooked.
</span><span class="cx"> * @param callback $function_to_add The name of the function you wish to be called.
</span><span class="cx"> * @param int $priority Optional. Used to specify the order in which the functions
</span><span class="lines">@@ -424,17 +430,17 @@
</span><span class="cx"> * You can pass extra arguments to the hooks, much like you can with
</span><span class="cx"> * apply_filters().
</span><span class="cx"> *
</span><del>- * @see apply_filters() This function works similar with the exception that
- * nothing is returned and only the functions or methods are called.
- *
</del><span class="cx"> * @since 1.2.0
</span><span class="cx"> *
</span><del>- * @global array $wp_filter Stores all of the filters
</del><ins>+ * @see apply_filters() This function works similar with the exception that nothing
+ * is returned and only the functions or methods are called.
+ * @global array $wp_filter Stores all of the filters
</ins><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.
- * @return null Will return null if $tag does not exist in $wp_filter array
</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. Default empty.
+ * @return null Will return null if $tag does not exist in $wp_filter array.
</ins><span class="cx"> */
</span><span class="cx"> function do_action($tag, $arg = '') {
</span><span class="cx"> global $wp_filter, $wp_actions, $merged_filters, $wp_current_filter;
</span><span class="lines">@@ -494,7 +500,7 @@
</span><span class="cx"> * @global array $wp_actions Increments the amount of times action was triggered.
</span><span class="cx"> *
</span><span class="cx"> * @param string $tag The name of the action hook.
</span><del>- * @return int The number of times action hook <tt>$tag</tt> is fired
</del><ins>+ * @return int The number of times action hook $tag is fired.
</ins><span class="cx"> */
</span><span class="cx"> function did_action($tag) {
</span><span class="cx"> global $wp_actions;
</span><span class="lines">@@ -508,12 +514,11 @@
</span><span class="cx"> /**
</span><span class="cx"> * Execute functions hooked on a specific action hook, specifying arguments in an array.
</span><span class="cx"> *
</span><del>- * @see do_action() This function is identical, but the arguments passed to the
- * functions hooked to <tt>$tag</tt> are supplied using an array.
- *
</del><span class="cx"> * @since 2.1.0
</span><span class="cx"> *
</span><del>- * @global array $wp_filter Stores all of the filters
</del><ins>+ * @see do_action() This function is identical, but the arguments passed to the
+ * functions hooked to $tag< are supplied using an array.
+ * @global array $wp_filter Stores all of the filters
</ins><span class="cx"> * @global array $wp_actions Increments the amount of times action was triggered.
</span><span class="cx"> *
</span><span class="cx"> * @param string $tag The name of the action to be executed.
</span><span class="lines">@@ -571,10 +576,12 @@
</span><span class="cx"> *
</span><span class="cx"> * @param string $tag The name of the action hook.
</span><span class="cx"> * @param callback|bool $function_to_check Optional. The callback to check for. Default false.
</span><del>- * @return mixed 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>+ * @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.
</ins><span class="cx"> */
</span><span class="cx"> function has_action($tag, $function_to_check = false) {
</span><span class="cx"> return has_filter($tag, $function_to_check);
</span><span class="lines">@@ -622,11 +629,10 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 1.5.0
</span><span class="cx"> *
</span><del>- * @access private
</del><ins>+ * @uses WP_PLUGIN_DIR, WPMU_PLUGIN_DIR
</ins><span class="cx"> *
</span><span class="cx"> * @param string $file The filename of plugin.
</span><span class="cx"> * @return string The name of a plugin.
</span><del>- * @uses WP_PLUGIN_DIR
</del><span class="cx"> */
</span><span class="cx"> function plugin_basename( $file ) {
</span><span class="cx"> global $wp_plugin_paths;
</span><span class="lines">@@ -683,24 +689,24 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Gets the filesystem directory path (with trailing slash) for the plugin __FILE__ passed in
</del><ins>+ * Get the filesystem directory path (with trailing slash) for the plugin __FILE__ passed in.
</ins><span class="cx"> *
</span><span class="cx"> * @since 2.8.0
</span><span class="cx"> *
</span><del>- * @param string $file The filename of the plugin (__FILE__)
- * @return string the filesystem path of the directory that contains the plugin
</del><ins>+ * @param string $file The filename of the plugin (__FILE__).
+ * @return string the filesystem path of the directory that contains the plugin.
</ins><span class="cx"> */
</span><span class="cx"> function plugin_dir_path( $file ) {
</span><span class="cx"> return trailingslashit( dirname( $file ) );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Gets the URL directory path (with trailing slash) for the plugin __FILE__ passed in
</del><ins>+ * Get the URL directory path (with trailing slash) for the plugin __FILE__ passed in.
</ins><span class="cx"> *
</span><span class="cx"> * @since 2.8.0
</span><span class="cx"> *
</span><del>- * @param string $file The filename of the plugin (__FILE__)
- * @return string the URL path of the directory that contains the plugin
</del><ins>+ * @param string $file The filename of the plugin (__FILE__).
+ * @return string the URL path of the directory that contains the plugin.
</ins><span class="cx"> */
</span><span class="cx"> function plugin_dir_url( $file ) {
</span><span class="cx"> return trailingslashit( plugins_url( '', $file ) );
</span><span class="lines">@@ -721,8 +727,8 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 2.0.0
</span><span class="cx"> *
</span><del>- * @param string $file The filename of the plugin including the path.
- * @param callback $function the function hooked to the 'activate_PLUGIN' action.
</del><ins>+ * @param string $file The filename of the plugin including the path.
+ * @param callback $function The function hooked to the 'activate_PLUGIN' action.
</ins><span class="cx"> */
</span><span class="cx"> function register_activation_hook($file, $function) {
</span><span class="cx"> $file = plugin_basename($file);
</span><span class="lines">@@ -744,8 +750,8 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 2.0.0
</span><span class="cx"> *
</span><del>- * @param string $file The filename of the plugin including the path.
- * @param callback $function the function hooked to the 'deactivate_PLUGIN' action.
</del><ins>+ * @param string $file The filename of the plugin including the path.
+ * @param callback $function The function hooked to the 'deactivate_PLUGIN' action.
</ins><span class="cx"> */
</span><span class="cx"> function register_deactivation_hook($file, $function) {
</span><span class="cx"> $file = plugin_basename($file);
</span><span class="lines">@@ -774,8 +780,9 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 2.7.0
</span><span class="cx"> *
</span><del>- * @param string $file
- * @param callback $callback The callback to run when the hook is called. Must be a static method or function.
</del><ins>+ * @param string $file Plugin file.
+ * @param callback $callback The callback to run when the hook is called. Must be
+ * a static method or function.
</ins><span class="cx"> */
</span><span class="cx"> function register_uninstall_hook( $file, $callback ) {
</span><span class="cx"> if ( is_array( $callback ) && is_object( $callback[0] ) ) {
</span><span class="lines">@@ -783,16 +790,19 @@
</span><span class="cx"> return;
</span><span class="cx"> }
</span><span class="cx">
</span><del>- // The option should not be autoloaded, because it is not needed in most
- // cases. Emphasis should be put on using the 'uninstall.php' way of
- // uninstalling the plugin.
</del><ins>+ /*
+ * The option should not be autoloaded, because it is not needed in most
+ * cases. Emphasis should be put on using the 'uninstall.php' way of
+ * uninstalling the plugin.
+ */
</ins><span class="cx"> $uninstallable_plugins = (array) get_option('uninstall_plugins');
</span><span class="cx"> $uninstallable_plugins[plugin_basename($file)] = $callback;
</span><ins>+
</ins><span class="cx"> update_option('uninstall_plugins', $uninstallable_plugins);
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Calls the 'all' hook, which will process the functions hooked into it.
</del><ins>+ * Call the 'all' hook, which will process the functions hooked into it.
</ins><span class="cx"> *
</span><span class="cx"> * The 'all' hook passes all of the arguments or parameters that were used for
</span><span class="cx"> * the hook, which this function was called for.
</span><span class="lines">@@ -805,7 +815,7 @@
</span><span class="cx"> * @since 2.5.0
</span><span class="cx"> * @access private
</span><span class="cx"> *
</span><del>- * @uses $wp_filter Used to process all of the functions in the 'all' hook
</del><ins>+ * @uses $wp_filter Used to process all of the functions in the 'all' hook.
</ins><span class="cx"> *
</span><span class="cx"> * @param array $args The collected parameters from the hook that was called.
</span><span class="cx"> */
</span><span class="lines">@@ -838,15 +848,21 @@
</span><span class="cx"> * Functions and static method callbacks are just returned as strings and
</span><span class="cx"> * shouldn't have any speed penalty.
</span><span class="cx"> *
</span><del>- * @access private
- * @since 2.2.3
</del><span class="cx"> * @link http://trac.wordpress.org/ticket/3875
</span><span class="cx"> *
</span><del>- * @global array $wp_filter Storage for all of the filters and actions
- * @param string $tag Used in counting how many hooks were applied
</del><ins>+ * @since 2.2.3
+ * @access private
+ *
+ * @global array $wp_filter Storage for all of the filters and actions.
+ *
+ * @param string $tag Used in counting how many hooks were applied
</ins><span class="cx"> * @param callback $function Used for creating unique id
</span><del>- * @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|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>+ * @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|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.
</ins><span class="cx"> */
</span><span class="cx"> function _wp_filter_build_unique_id($tag, $function, $priority) {
</span><span class="cx"> global $wp_filter;
</span></span></pre>
</div>
</div>
</body>
</html>