<!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>[27353] trunk/src/wp-includes/user.php: Inline documentation improvements for wp-includes/user.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/27353">27353</a></dd>
<dt>Author</dt> <dd>DrewAPicture</dd>
<dt>Date</dt> <dd>2014-03-02 19:39:38 +0000 (Sun, 02 Mar 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Inline documentation improvements for wp-includes/user.php.
Props morganestes, SergeyBiryukov.
Fixes <a href="http://core.trac.wordpress.org/ticket/26148">#26148</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesuserphp">trunk/src/wp-includes/user.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesuserphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/user.php (27352 => 27353)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/user.php 2014-03-02 19:00:50 UTC (rev 27352)
+++ trunk/src/wp-includes/user.php 2014-03-02 19:39:38 UTC (rev 27353)
</span><span class="lines">@@ -3,6 +3,7 @@
</span><span class="cx"> * WordPress User API
</span><span class="cx"> *
</span><span class="cx"> * @package WordPress
</span><ins>+ * @subpackage Users
</ins><span class="cx"> */
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -20,7 +21,7 @@
</span><span class="cx"> *
</span><span class="cx"> * @param array $credentials Optional. User info in order to sign on.
</span><span class="cx"> * @param bool $secure_cookie Optional. Whether to use secure cookie.
</span><del>- * @return object Either WP_Error on failure, or WP_User on success.
</del><ins>+ * @return WP_User|WP_Error WP_User on success, WP_Error on failure.
</ins><span class="cx"> */
</span><span class="cx"> function wp_signon( $credentials = array(), $secure_cookie = '' ) {
</span><span class="cx"> if ( empty($credentials) ) {
</span><span class="lines">@@ -37,7 +38,6 @@
</span><span class="cx"> else
</span><span class="cx"> $credentials['remember'] = false;
</span><span class="cx">
</span><del>- // TODO do we deprecate the wp_authentication action?
</del><span class="cx"> /**
</span><span class="cx"> * Fires before the user is authenticated.
</span><span class="cx"> *
</span><span class="lines">@@ -46,6 +46,8 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 1.5.1
</span><span class="cx"> *
</span><ins>+ * @todo Decide whether to deprecate the wp_authenticate action.
+ *
</ins><span class="cx"> * @param string $user_login Username, passed by reference.
</span><span class="cx"> * @param string $user_password User password, passed by reference.
</span><span class="cx"> */
</span><span class="lines">@@ -101,6 +103,13 @@
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="cx"> * Authenticate the user using the username and password.
</span><ins>+ *
+ * @since 2.8.0
+ *
+ * @param WP_User|WP_Error|null $user WP_User or WP_Error object from a previous callback. Default null.
+ * @param string $username Username for authentication.
+ * @param string $password Password for authentication.
+ * @return WP_User|WP_Error WP_User on success, WP_Error on failure.
</ins><span class="cx"> */
</span><span class="cx"> function wp_authenticate_username_password($user, $username, $password) {
</span><span class="cx"> if ( is_a( $user, 'WP_User' ) ) {
</span><span class="lines">@@ -149,6 +158,13 @@
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="cx"> * Authenticate the user using the WordPress auth cookie.
</span><ins>+ *
+ * @since 2.8.0
+ *
+ * @param WP_User|WP_Error|null $user WP_User or WP_Error object from a previous callback. Default null.
+ * @param string $username Username. If passed, cancels the cookie authentication.
+ * @param string $password Password. If passed, cancels the cookie authentication.
+ * @return WP_User|WP_Error WP_User on success, WP_Error on failure.
</ins><span class="cx"> */
</span><span class="cx"> function wp_authenticate_cookie($user, $username, $password) {
</span><span class="cx"> if ( is_a( $user, 'WP_User' ) ) {
</span><span class="lines">@@ -177,10 +193,13 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * For multisite blogs, check if the authenticated user has been marked as a
</del><ins>+ * For Multisite blogs, check if the authenticated user has been marked as a
</ins><span class="cx"> * spammer, or if the user's primary blog has been marked as spam.
</span><span class="cx"> *
</span><span class="cx"> * @since 3.7.0
</span><ins>+ *
+ * @param WP_User|WP_Error|null $user WP_User or WP_Error object from a previous callback. Default null.
+ * @return WP_User|WP_Error WP_User on success, WP_Error if the user is considered a spammer.
</ins><span class="cx"> */
</span><span class="cx"> function wp_authenticate_spam_check( $user ) {
</span><span class="cx"> if ( $user && is_a( $user, 'WP_User' ) && is_multisite() ) {
</span><span class="lines">@@ -204,8 +223,9 @@
</span><span class="cx"> * Number of posts user has written.
</span><span class="cx"> *
</span><span class="cx"> * @since 3.0.0
</span><del>- * @uses $wpdb WordPress database object for queries.
</del><span class="cx"> *
</span><ins>+ * @global wpdb $wpdb WordPress database object for queries.
+ *
</ins><span class="cx"> * @param int $userid User ID.
</span><span class="cx"> * @return int Amount of posts user has written.
</span><span class="cx"> */
</span><span class="lines">@@ -291,14 +311,13 @@
</span><span class="cx"> * The option will first check for the per site name and then the per Network name.
</span><span class="cx"> *
</span><span class="cx"> * @since 2.0.0
</span><del>- * @uses $wpdb WordPress database object for queries.
- * @uses apply_filters() Calls 'get_user_option_$option' hook with result,
- * option parameter, and user data object.
</del><span class="cx"> *
</span><del>- * @param string $option User option name.
- * @param int $user Optional. User ID.
- * @param bool $deprecated Use get_option() to check for an option in the options table.
- * @return mixed
</del><ins>+ * @global wpdb $wpdb WordPress database object for queries.
+ *
+ * @param string $option User option name.
+ * @param int $user Optional. User ID.
+ * @param bool $deprecated Use get_option() to check for an option in the options table.
+ * @return mixed User option value on success, false on failure.
</ins><span class="cx"> */
</span><span class="cx"> function get_user_option( $option, $user = 0, $deprecated = '' ) {
</span><span class="cx"> global $wpdb;
</span><span class="lines">@@ -344,13 +363,16 @@
</span><span class="cx"> * Deletes the user option if $newvalue is empty.
</span><span class="cx"> *
</span><span class="cx"> * @since 2.0.0
</span><del>- * @uses $wpdb WordPress database object for queries
</del><span class="cx"> *
</span><del>- * @param int $user_id User ID
</del><ins>+ * @global wpdb $wpdb WordPress database object for queries.
+ *
+ * @param int $user_id User ID.
</ins><span class="cx"> * @param string $option_name User option name.
</span><del>- * @param mixed $newvalue User option value.
- * @param bool $global Optional. Whether option name is global or blog specific. Default false (blog specific).
- * @return unknown
</del><ins>+ * @param mixed $newvalue User option value.
+ * @param bool $global Optional. Whether option name is global or blog specific.
+ * Default false (blog specific).
+ * @return int|bool User meta ID if the option didn't exist, true on successful update,
+ * false on failure.
</ins><span class="cx"> */
</span><span class="cx"> function update_user_option( $user_id, $option_name, $newvalue, $global = false ) {
</span><span class="cx"> global $wpdb;
</span><span class="lines">@@ -369,12 +391,14 @@
</span><span class="cx"> * it will prepend the WordPress table prefix to the option name.
</span><span class="cx"> *
</span><span class="cx"> * @since 3.0.0
</span><del>- * @uses $wpdb WordPress database object for queries
</del><span class="cx"> *
</span><del>- * @param int $user_id User ID
</del><ins>+ * @global wpdb $wpdb WordPress database object for queries.
+ *
+ * @param int $user_id User ID
</ins><span class="cx"> * @param string $option_name User option name.
</span><del>- * @param bool $global Optional. Whether option name is global or blog specific. Default false (blog specific).
- * @return unknown
</del><ins>+ * @param bool $global Optional. Whether option name is global or blog specific.
+ * Default false (blog specific).
+ * @return bool True on success, false on failure.
</ins><span class="cx"> */
</span><span class="cx"> function delete_user_option( $user_id, $option_name, $global = false ) {
</span><span class="cx"> global $wpdb;
</span><span class="lines">@@ -426,11 +450,11 @@
</span><span class="cx"> var $query_limit;
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * PHP5 constructor
</del><ins>+ * PHP5 constructor.
</ins><span class="cx"> *
</span><span class="cx"> * @since 3.1.0
</span><span class="cx"> *
</span><del>- * @param string|array $args The query variables
</del><ins>+ * @param string|array $args Optional. The query variables.
</ins><span class="cx"> * @return WP_User_Query
</span><span class="cx"> */
</span><span class="cx"> function __construct( $query = null ) {
</span><span class="lines">@@ -441,11 +465,11 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Prepare the query variables
</del><ins>+ * Prepare the query variables.
</ins><span class="cx"> *
</span><span class="cx"> * @since 3.1.0
</span><span class="cx"> *
</span><del>- * @param string|array $args The query variables
</del><ins>+ * @param string|array $args Optional. The query variables.
</ins><span class="cx"> */
</span><span class="cx"> function prepare_query( $query = array() ) {
</span><span class="cx"> global $wpdb;
</span><span class="lines">@@ -653,9 +677,11 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Execute the query, with the current variables
</del><ins>+ * Execute the query, with the current variables.
</ins><span class="cx"> *
</span><span class="cx"> * @since 3.1.0
</span><ins>+ *
+ * @global wpdb $wpdb WordPress database object for queries.
</ins><span class="cx"> */
</span><span class="cx"> function query() {
</span><span class="cx"> global $wpdb;
</span><span class="lines">@@ -758,24 +784,24 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Return the list of users
</del><ins>+ * Return the list of users.
</ins><span class="cx"> *
</span><span class="cx"> * @since 3.1.0
</span><span class="cx"> * @access public
</span><span class="cx"> *
</span><del>- * @return array
</del><ins>+ * @return array Array of results.
</ins><span class="cx"> */
</span><span class="cx"> function get_results() {
</span><span class="cx"> return $this->results;
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Return the total number of users for the current query
</del><ins>+ * Return the total number of users for the current query.
</ins><span class="cx"> *
</span><span class="cx"> * @since 3.1.0
</span><span class="cx"> * @access public
</span><span class="cx"> *
</span><del>- * @return array
</del><ins>+ * @return array Array of total users.
</ins><span class="cx"> */
</span><span class="cx"> function get_total() {
</span><span class="cx"> return $this->total_users;
</span><span class="lines">@@ -786,10 +812,10 @@
</span><span class="cx"> * Retrieve list of users matching criteria.
</span><span class="cx"> *
</span><span class="cx"> * @since 3.1.0
</span><del>- * @uses $wpdb
</del><ins>+ *
</ins><span class="cx"> * @uses WP_User_Query See for default arguments and information.
</span><span class="cx"> *
</span><del>- * @param array $args Optional.
</del><ins>+ * @param array $args Optional. Array of arguments.
</ins><span class="cx"> * @return array List of users.
</span><span class="cx"> */
</span><span class="cx"> function get_users( $args = array() ) {
</span><span class="lines">@@ -807,9 +833,13 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 3.0.0
</span><span class="cx"> *
</span><del>- * @param int $user_id User ID
- * @param bool $all Whether to retrieve all blogs, or only blogs that are not marked as deleted, archived, or spam.
- * @return array A list of the user's blogs. An empty array if the user doesn't exist or belongs to no blogs.
</del><ins>+ * @global wpdb $wpdb WordPress database object for queries.
+ *
+ * @param int $user_id User ID
+ * @param bool $all Whether to retrieve all blogs, or only blogs that are not
+ * marked as deleted, archived, or spam.
+ * @return array A list of the user's blogs. An empty array if the user doesn't exist
+ * or belongs to no blogs.
</ins><span class="cx"> */
</span><span class="cx"> function get_blogs_of_user( $user_id, $all = false ) {
</span><span class="cx"> global $wpdb;
</span><span class="lines">@@ -1154,9 +1184,12 @@
</span><span class="cx"> * </ol>
</span><span class="cx"> *
</span><span class="cx"> * @since 2.3.0
</span><del>- * @uses $wpdb WordPress database object for queries
</del><span class="cx"> *
</span><del>- * @param string|array $args Optional. Override defaults.
</del><ins>+ * @global wpdb $wpdb WordPress database object for queries.
+ *
+ * @todo Hash-notate arguments array.
+ *
+ * @param string|array $args Optional. Array of user arguments.
</ins><span class="cx"> * @return string|null Null on display. String of HTML content on retrieve.
</span><span class="cx"> */
</span><span class="cx"> function wp_dropdown_users( $args = '' ) {
</span><span class="lines">@@ -1239,12 +1272,6 @@
</span><span class="cx"> * when calling filters.
</span><span class="cx"> *
</span><span class="cx"> * @since 2.3.0
</span><del>- * @uses apply_filters() Calls 'edit_$field' passing $value and $user_id if $context == 'edit'.
- * $field is prefixed with 'user_' if it isn't already.
- * @uses apply_filters() Calls 'pre_$field' passing $value if $context == 'db'. $field is prefixed with
- * 'user_' if it isn't already.
- * @uses apply_filters() Calls '$field' passing $value, $user_id and $context if $context == anything
- * other than 'raw', 'edit' and 'db'. $field is prefixed with 'user_' if it isn't already.
</del><span class="cx"> *
</span><span class="cx"> * @param string $field The user Object field name.
</span><span class="cx"> * @param mixed $value The user Object value.
</span><span class="lines">@@ -1268,9 +1295,11 @@
</span><span class="cx">
</span><span class="cx"> if ( 'edit' == $context ) {
</span><span class="cx"> if ( $prefixed ) {
</span><ins>+
</ins><span class="cx"> /** This filter is documented in wp-includes/post.php */
</span><span class="cx"> $value = apply_filters( "edit_{$field}", $value, $user_id );
</span><span class="cx"> } else {
</span><ins>+
</ins><span class="cx"> /**
</span><span class="cx"> * Filter a user field value in the 'edit' context.
</span><span class="cx"> *
</span><span class="lines">@@ -1294,6 +1323,7 @@
</span><span class="cx"> /** This filter is documented in wp-includes/post.php */
</span><span class="cx"> $value = apply_filters( "pre_{$field}", $value );
</span><span class="cx"> } else {
</span><ins>+
</ins><span class="cx"> /**
</span><span class="cx"> * Filter the value of a user field in the 'db' context.
</span><span class="cx"> *
</span><span class="lines">@@ -1308,10 +1338,12 @@
</span><span class="cx"> }
</span><span class="cx"> } else {
</span><span class="cx"> // Use display filters by default.
</span><del>- if ( $prefixed ){
</del><ins>+ if ( $prefixed ) {
+
</ins><span class="cx"> /** This filter is documented in wp-includes/post.php */
</span><span class="cx"> $value = apply_filters( $field, $value, $user_id, $context );
</span><del>- }else{
</del><ins>+ } else {
+
</ins><span class="cx"> /**
</span><span class="cx"> * Filter the value of a user field in a standard context.
</span><span class="cx"> *
</span><span class="lines">@@ -1393,7 +1425,6 @@
</span><span class="cx"> * Checks whether the given email exists.
</span><span class="cx"> *
</span><span class="cx"> * @since 2.1.0
</span><del>- * @uses $wpdb
</del><span class="cx"> *
</span><span class="cx"> * @param string $email Email.
</span><span class="cx"> * @return bool|int The user's ID on success, and false on failure.
</span><span class="lines">@@ -1460,11 +1491,11 @@
</span><span class="cx"> * 'yim' - User's Yahoo IM account.
</span><span class="cx"> *
</span><span class="cx"> * @since 2.0.0
</span><del>- * @uses $wpdb WordPress database layer.
- * @uses apply_filters() Calls filters for most of the $userdata fields with the prefix 'pre_user'. See note above.
- * @uses do_action() Calls 'profile_update' hook when updating giving the user's ID
- * @uses do_action() Calls 'user_register' hook when creating a new user giving the user's ID
</del><span class="cx"> *
</span><ins>+ * @global wpdb $wpdb WordPress database object for queries.
+ *
+ * @todo Hash-notate arguments array.
+ *
</ins><span class="cx"> * @param mixed $userdata An array of user data or a user object of type stdClass or WP_User.
</span><span class="cx"> * @return int|WP_Error The newly created user's ID or a WP_Error object if the user could not be created.
</span><span class="cx"> */
</span><span class="lines">@@ -1490,6 +1521,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> $user_login = sanitize_user($user_login, true);
</span><ins>+
</ins><span class="cx"> /**
</span><span class="cx"> * Filter a username after it has been sanitized.
</span><span class="cx"> *
</span><span class="lines">@@ -1512,6 +1544,7 @@
</span><span class="cx">
</span><span class="cx"> if ( empty($user_nicename) )
</span><span class="cx"> $user_nicename = sanitize_title( $user_login );
</span><ins>+
</ins><span class="cx"> /**
</span><span class="cx"> * Filter a user's nicename before the user is created or updated.
</span><span class="cx"> *
</span><span class="lines">@@ -1523,6 +1556,7 @@
</span><span class="cx">
</span><span class="cx"> if ( empty($user_url) )
</span><span class="cx"> $user_url = '';
</span><ins>+
</ins><span class="cx"> /**
</span><span class="cx"> * Filter a user's URL before the user is created or updated.
</span><span class="cx"> *
</span><span class="lines">@@ -1534,6 +1568,7 @@
</span><span class="cx">
</span><span class="cx"> if ( empty($user_email) )
</span><span class="cx"> $user_email = '';
</span><ins>+
</ins><span class="cx"> /**
</span><span class="cx"> * Filter a user's email before the user is created or updated.
</span><span class="cx"> *
</span><span class="lines">@@ -1548,6 +1583,7 @@
</span><span class="cx">
</span><span class="cx"> if ( empty($nickname) )
</span><span class="cx"> $nickname = $user_login;
</span><ins>+
</ins><span class="cx"> /**
</span><span class="cx"> * Filter a user's nickname before the user is created or updated.
</span><span class="cx"> *
</span><span class="lines">@@ -1559,6 +1595,7 @@
</span><span class="cx">
</span><span class="cx"> if ( empty($first_name) )
</span><span class="cx"> $first_name = '';
</span><ins>+
</ins><span class="cx"> /**
</span><span class="cx"> * Filter a user's first name before the user is created or updated.
</span><span class="cx"> *
</span><span class="lines">@@ -1570,6 +1607,7 @@
</span><span class="cx">
</span><span class="cx"> if ( empty($last_name) )
</span><span class="cx"> $last_name = '';
</span><ins>+
</ins><span class="cx"> /**
</span><span class="cx"> * Filter a user's last name before the user is created or updated.
</span><span class="cx"> *
</span><span class="lines">@@ -1592,6 +1630,7 @@
</span><span class="cx"> else
</span><span class="cx"> $display_name = $user_login;
</span><span class="cx"> }
</span><ins>+
</ins><span class="cx"> /**
</span><span class="cx"> * Filter a user's display name before the user is created or updated.
</span><span class="cx"> *
</span><span class="lines">@@ -1603,6 +1642,7 @@
</span><span class="cx">
</span><span class="cx"> if ( empty($description) )
</span><span class="cx"> $description = '';
</span><ins>+
</ins><span class="cx"> /**
</span><span class="cx"> * Filter a user's description before the user is created or updated.
</span><span class="cx"> *
</span><span class="lines">@@ -1703,8 +1743,9 @@
</span><span class="cx"> * cleared.
</span><span class="cx"> *
</span><span class="cx"> * @since 2.0.0
</span><del>- * @see wp_insert_user() For what fields can be set in $userdata
</del><span class="cx"> *
</span><ins>+ * @see wp_insert_user() For what fields can be set in $userdata.
+ *
</ins><span class="cx"> * @param mixed $userdata An array of user data or a user object of type stdClass or WP_User.
</span><span class="cx"> * @return int|WP_Error The updated user's ID or a WP_Error object if the user could not be updated.
</span><span class="cx"> */
</span><span class="lines">@@ -1841,7 +1882,7 @@
</span><span class="cx"> * hashing process. This field is now hashed; old values are no longer accepted
</span><span class="cx"> * but have a different WP_Error code so good user feedback can be provided.
</span><span class="cx"> *
</span><del>- * @uses $wpdb WordPress Database object
</del><ins>+ * @global wpdb $wpdb WordPress database object for queries.
</ins><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></span></pre>
</div>
</div>
</body>
</html>