<!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>[19702] trunk: Fix mistakes in parameter documentation and add some missing param docs.</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, #logmsg > ol { margin-left: 0; 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/19702">19702</a></dd>
<dt>Author</dt> <dd>duck_</dd>
<dt>Date</dt> <dd>2012-01-06 18:31:43 +0000 (Fri, 06 Jan 2012)</dd>
</dl>
<h3>Log Message</h3>
<pre>Fix mistakes in parameter documentation and add some missing param docs. See <a href="http://core.trac.wordpress.org/ticket/19756">#19756</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkwpadminincludesscreenphp">trunk/wp-admin/includes/screen.php</a></li>
<li><a href="#trunkwpincludescategorytemplatephp">trunk/wp-includes/category-template.php</a></li>
<li><a href="#trunkwpincludespostphp">trunk/wp-includes/post.php</a></li>
<li><a href="#trunkwpincludesuserphp">trunk/wp-includes/user.php</a></li>
<li><a href="#trunkwploginphp">trunk/wp-login.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkwpadminincludesscreenphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-admin/includes/screen.php (19701 => 19702)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/includes/screen.php 2012-01-06 18:23:51 UTC (rev 19701)
+++ trunk/wp-admin/includes/screen.php 2012-01-06 18:31:43 UTC (rev 19702)
</span><span class="lines">@@ -565,7 +565,8 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 3.3.0
</span><span class="cx"> *
</span><del>- * @param string
</del><ins>+ * @param string $option Option ID.
+ * @param mixed $key Optional. Specific array key for when the option is an array.
</ins><span class="cx"> */
</span><span class="cx"> public function get_option( $option, $key = false ) {
</span><span class="cx"> if ( ! isset( $this->_options[ $option ] ) )
</span></span></pre></div>
<a id="trunkwpincludescategorytemplatephp"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/category-template.php (19701 => 19702)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/category-template.php 2012-01-06 18:23:51 UTC (rev 19701)
+++ trunk/wp-includes/category-template.php 2012-01-06 18:31:43 UTC (rev 19702)
</span><span class="lines">@@ -227,7 +227,7 @@
</span><span class="cx"> * @since 1.2.0
</span><span class="cx"> *
</span><span class="cx"> * @param int|string|array $category Category ID, name or slug, or array of said.
</span><del>- * @param int|object $_post Optional. Post to check instead of the current post. (since 2.7.0)
</del><ins>+ * @param int|object $post Optional. Post to check instead of the current post. (since 2.7.0)
</ins><span class="cx"> * @return bool True if the current post is in any of the given categories.
</span><span class="cx"> */
</span><span class="cx"> function in_category( $category, $post = null ) {
</span><span class="lines">@@ -1050,6 +1050,7 @@
</span><span class="cx"> * @since 2.8
</span><span class="cx"> *
</span><span class="cx"> * @param int $term Optional. Term ID. Will use global term ID by default.
</span><ins>+ * @param string $taxonomy Optional taxonomy name. Defaults to 'post_tag'.
</ins><span class="cx"> * @return string Term description, available.
</span><span class="cx"> */
</span><span class="cx"> function term_description( $term = 0, $taxonomy = 'post_tag' ) {
</span><span class="lines">@@ -1156,7 +1157,7 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 3.1.0
</span><span class="cx"> *
</span><del>- * @param string|int|array $tag Optional. The category name/term_id/slug or array of them to check for.
</del><ins>+ * @param string|int|array $category Optional. The category name/term_id/slug or array of them to check for.
</ins><span class="cx"> * @param int|object $post Optional. Post to check instead of the current post.
</span><span class="cx"> * @return bool True if the current post has any of the given categories (or any category, if no category specified).
</span><span class="cx"> */
</span></span></pre></div>
<a id="trunkwpincludespostphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/post.php (19701 => 19702)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/post.php 2012-01-06 18:23:51 UTC (rev 19701)
+++ trunk/wp-includes/post.php 2012-01-06 18:31:43 UTC (rev 19702)
</span><span class="lines">@@ -2887,6 +2887,7 @@
</span><span class="cx"> *
</span><span class="cx"> * @param int $post_id Post ID.
</span><span class="cx"> * @param string $tags The tags to set for the post, separated by commas.
</span><ins>+ * @param string $taxonomy Taxonomy name. Defaults to 'post_tag'.
</ins><span class="cx"> * @param bool $append If true, don't delete existing tags, just add on. If false, replace the tags with the new tags.
</span><span class="cx"> * @return mixed Array of affected term IDs. WP_Error or false on failure.
</span><span class="cx"> */
</span></span></pre></div>
<a id="trunkwpincludesuserphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/user.php (19701 => 19702)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/user.php 2012-01-06 18:23:51 UTC (rev 19701)
+++ trunk/wp-includes/user.php 2012-01-06 18:31:43 UTC (rev 19702)
</span><span class="lines">@@ -164,11 +164,12 @@
</span><span class="cx"> * Number of posts written by a list of users.
</span><span class="cx"> *
</span><span class="cx"> * @since 3.0.0
</span><del>- * @param array $user_ids Array of user IDs.
</del><ins>+ *
+ * @param array $users Array of user IDs.
</ins><span class="cx"> * @param string|array $post_type Optional. Post type to check. Defaults to post.
</span><span class="cx"> * @return array Amount of posts each user has written.
</span><span class="cx"> */
</span><del>-function count_many_users_posts($users, $post_type = 'post' ) {
</del><ins>+function count_many_users_posts( $users, $post_type = 'post' ) {
</ins><span class="cx"> global $wpdb;
</span><span class="cx">
</span><span class="cx"> $count = array();
</span></span></pre></div>
<a id="trunkwploginphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-login.php (19701 => 19702)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-login.php 2012-01-06 18:23:51 UTC (rev 19701)
+++ trunk/wp-login.php 2012-01-06 18:31:43 UTC (rev 19702)
</span><span class="lines">@@ -239,8 +239,7 @@
</span><span class="cx"> *
</span><span class="cx"> * @param string $key Hash to validate sending user's password
</span><span class="cx"> * @param string $login The user login
</span><del>- *
- * @return object|WP_Error
</del><ins>+ * @return object|WP_Error User's database row on success, error object for invalid keys
</ins><span class="cx"> */
</span><span class="cx"> function check_password_reset_key($key, $login) {
</span><span class="cx"> global $wpdb;
</span><span class="lines">@@ -264,9 +263,8 @@
</span><span class="cx"> /**
</span><span class="cx"> * Handles resetting the user's password.
</span><span class="cx"> *
</span><del>- * @uses $wpdb WordPress Database object
- *
- * @param string $key Hash to validate sending user's password
</del><ins>+ * @param object $user The user
+ * @param string $new_pass New password for the user in plaintext
</ins><span class="cx"> */
</span><span class="cx"> function reset_password($user, $new_pass) {
</span><span class="cx"> do_action('password_reset', $user, $new_pass);
</span></span></pre>
</div>
</div>
</body>
</html>