enmi-conf.org: comparison wp/wp-includes/user.php

equal deleted inserted replaced

-:346c88efed21
+:5e2f62d02dcd
 <?php
 /**
 * WordPress User API
 *
 * @package WordPress
+* @subpackage Users
 */
 /**
 * Authenticate user with remember capability.
 *
 * set for a longer period depending on if the 'remember' credential is set to
 * true.
 *
 * @since 2.5.0
 *
-* @param array $credentials Optional. User info in order to sign on.
+* @param array       $credentials   Optional. User info in order to sign on.
-* @param bool $secure_cookie Optional. Whether to use secure cookie.
+* @param string|bool $secure_cookie Optional. Whether to use secure cookie.
-* @return object Either WP_Error on failure, or WP_User on success.
+* @return WP_User|WP_Error WP_User on success, WP_Error on failure.
 */
-function wp_signon( $credentials = '', $secure_cookie = '' ) {
+function wp_signon( $credentials = array(), $secure_cookie = '' ) {
 	if ( empty($credentials) ) {
 		if ( ! empty($_POST['log']) )
 			$credentials['user_login'] = $_POST['log'];
 		if ( ! empty($_POST['pwd']) )
 			$credentials['user_password'] = $_POST['pwd'];
 	if ( !empty($credentials['remember']) )
 		$credentials['remember'] = true;
 	else
 		$credentials['remember'] = false;
-	// TODO do we deprecate the wp_authentication action?
+	/**
-	do_action_ref_array('wp_authenticate', array(&$credentials['user_login'], &$credentials['user_password']));
+	 * Fires before the user is authenticated.
+	 *
+	 * The variables passed to the callbacks are passed by reference,
+	 * and can be modified by callback functions.
+	 *
+	 * @since 1.5.1
+	 *
+	 * @todo Decide whether to deprecate the wp_authenticate action.
+	 *
+	 * @param string $user_login    Username, passed by reference.
+	 * @param string $user_password User password, passed by reference.
+	 */
+	do_action_ref_array( 'wp_authenticate', array( &$credentials['user_login'], &$credentials['user_password'] ) );
 	if ( '' === $secure_cookie )
 		$secure_cookie = is_ssl();
-	$secure_cookie = apply_filters('secure_signon_cookie', $secure_cookie, $credentials);
+	/**
+	 * Filter whether to use a secure sign-on cookie.
+	 *
+	 * @since 3.1.0
+	 *
+	 * @param bool  $secure_cookie Whether to use a secure sign-on cookie.
+	 * @param array $credentials {
+	 *     Array of entered sign-on data.
+	 *
+	 *     @type string $user_login    Username.
+	 *     @type string $user_password Password entered.
+	 *     @type bool   $remember      Whether to 'remember' the user. Increases the time
+	 *                                 that the cookie will be kept. Default false.
+	 * }
+	 */
+	$secure_cookie = apply_filters( 'secure_signon_cookie', $secure_cookie, $credentials );
 	global $auth_secure_cookie; // XXX ugly hack to pass this to wp_authenticate_cookie
 	$auth_secure_cookie = $secure_cookie;
 	add_filter('authenticate', 'wp_authenticate_cookie', 30, 3);
 		return $user;
 	}
 	wp_set_auth_cookie($user->ID, $credentials['remember'], $secure_cookie);
-	do_action('wp_login', $user->user_login, $user);
+	/**
+	 * Fires after the user has successfully logged in.
+	 *
+	 * @since 1.5.0
+	 *
+	 * @param string  $user_login Username.
+	 * @param WP_User $user       WP_User object of the logged-in user.
+	 */
+	do_action( 'wp_login', $user->user_login, $user );
 	return $user;
 }
 /**
 * Authenticate the user using the username and password.
-*/
+*
-add_filter('authenticate', 'wp_authenticate_username_password', 20, 3);
+* @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.
+*/
 function wp_authenticate_username_password($user, $username, $password) {
-	if ( is_a($user, 'WP_User') ) { return $user; }
+	if ( $user instanceof WP_User ) {
+		return $user;
+	}
 	if ( empty($username) || empty($password) ) {
 		if ( is_wp_error( $user ) )
 			return $user;
 	}
 	$user = get_user_by('login', $username);
 	if ( !$user )
-		return new WP_Error( 'invalid_username', sprintf( __( '<strong>ERROR</strong>: Invalid username. <a href="%s" title="Password Lost and Found">Lost your password</a>?' ), wp_lostpassword_url() ) );
+		return new WP_Error( 'invalid_username', sprintf( __( '<strong>ERROR</strong>: Invalid username. <a href="%s">Lost your password?</a>' ), wp_lostpassword_url() ) );
-	$user = apply_filters('wp_authenticate_user', $user, $password);
+	/**
+	 * Filter whether the given user can be authenticated with the provided $password.
+	 *
+	 * @since 2.5.0
+	 *
+	 * @param WP_User|WP_Error $user     WP_User or WP_Error object if a previous
+	 *                                   callback failed authentication.
+	 * @param string           $password Password to check against the user.
+	 */
+	$user = apply_filters( 'wp_authenticate_user', $user, $password );
 	if ( is_wp_error($user) )
 		return $user;
 	if ( !wp_check_password($password, $user->user_pass, $user->ID) )
-		return new WP_Error( 'incorrect_password', sprintf( __( '<strong>ERROR</strong>: The password you entered for the username <strong>%1$s</strong> is incorrect. <a href="%2$s" title="Password Lost and Found">Lost your password</a>?' ),
+		return new WP_Error( 'incorrect_password', sprintf( __( '<strong>ERROR</strong>: The password you entered for the username <strong>%1$s</strong> is incorrect. <a href="%2$s">Lost your password?</a>' ),
 		$username, wp_lostpassword_url() ) );
 	return $user;
 }
 /**
 * Authenticate the user using the WordPress auth cookie.
+*
+* @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 not empty, cancels the cookie authentication.
+* @param string                $password Password. If not empty, cancels the cookie authentication.
+* @return WP_User|WP_Error WP_User on success, WP_Error on failure.
 */
 function wp_authenticate_cookie($user, $username, $password) {
-	if ( is_a($user, 'WP_User') ) { return $user; }
+	if ( $user instanceof WP_User ) {
+		return $user;
+	}
 	if ( empty($username) && empty($password) ) {
 		$user_id = wp_validate_auth_cookie();
 		if ( $user_id )
 			return new WP_User($user_id);
 	return $user;
 }
 /**
-* For multisite blogs, check if the authenticated user has been marked as a
+* For Multisite blogs, check if the authenticated user has been marked as a
 * spammer, or if the user's primary blog has been marked as spam.
 *
 * @since 3.7.0
+*
+* @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.
 */
 function wp_authenticate_spam_check( $user ) {
-	if ( $user && is_a( $user, 'WP_User' ) && is_multisite() ) {
+	if ( $user instanceof WP_User && is_multisite() ) {
+		/**
+		 * Filter whether the user has been marked as a spammer.
+		 *
+		 * @since 3.7.0
+		 *
+		 * @param bool    $spammed Whether the user is considered a spammer.
+		 * @param WP_User $user    User to check against.
+		 */
 		$spammed = apply_filters( 'check_is_user_spammed', is_user_spammy(), $user );
 		if ( $spammed )
 			return new WP_Error( 'spammer_account', __( '<strong>ERROR</strong>: Your account has been marked as a spammer.' ) );
 	}
 	return $user;
 }
 /**
+* Validate the logged-in cookie.
+*
+* Checks the logged-in cookie if the previous auth cookie could not be
+* validated and parsed.
+*
+* This is a callback for the determine_current_user filter, rather than API.
+*
+* @since 3.9.0
+*
+* @param int|bool $user_id The user ID (or false) as received from the
+*                       determine_current_user filter.
+* @return int|bool User ID if validated, false otherwise. If a user ID from
+*                  an earlier filter callback is received, that value is returned.
+*/
+function wp_validate_logged_in_cookie( $user_id ) {
+	if ( $user_id ) {
+		return $user_id;
+	}
+	if ( is_blog_admin() || is_network_admin() || empty( $_COOKIE[LOGGED_IN_COOKIE] ) ) {
+		return false;
+	}
+	return wp_validate_auth_cookie( $_COOKIE[LOGGED_IN_COOKIE], 'logged_in' );
+}
+/**
 * Number of posts user has written.
 *
 * @since 3.0.0
-* @uses $wpdb WordPress database object for queries.
+* @since 4.1.0 Added `$post_type` argument.
 *
-* @param int $userid User ID.
+* @global wpdb $wpdb WordPress database object for queries.
-* @return int Amount of posts user has written.
+*
-*/
+* @param int    $userid    User ID.
-function count_user_posts($userid) {
+* @param string $post_type Optional. Post type to count the number of posts for. Default 'post'.
+* @return int Number of posts the user has written in this post type.
+*/
+function count_user_posts( $userid, $post_type = 'post' ) {
 	global $wpdb;
-	$where = get_posts_by_author_sql('post', true, $userid);
+	$where = get_posts_by_author_sql( $post_type, true, $userid );
 	$count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->posts $where" );
-	return apply_filters('get_usernumposts', $count, $userid);
+	/**
+	 * Filter the number of posts a user has written.
+	 *
+	 * @since 2.7.0
+	 * @since 4.1.0 Added `$post_type` argument.
+	 *
+	 * @param int    $count     The user's post count.
+	 * @param int    $userid    User ID.
+	 * @param string $post_type Post type to count the number of posts for.
+	 */
+	return apply_filters( 'get_usernumposts', $count, $userid, $post_type );
 }
 /**
 * Number of posts written by a list of users.
 *
 /**
 * Get the current user's ID
 *
 * @since MU
-*
-* @uses wp_get_current_user
 *
 * @return int The current user's ID
 */
 function get_current_user_id() {
 	if ( ! function_exists( 'wp_get_current_user' ) )
 * object as the third parameter.
 *
 * The option will first check for the per site name and then the per Network name.
 *
 * @since 2.0.0
-* @uses $wpdb WordPress database object for queries.
+*
-* @uses apply_filters() Calls 'get_user_option_$option' hook with result,
+* @global wpdb $wpdb WordPress database object for queries.
-*		option parameter, and user data object.
+*
-*
+* @param string $option     User option name.
-* @param string $option User option name.
+* @param int    $user       Optional. User ID.
-* @param int $user Optional. User ID.
+* @param string $deprecated Use get_option() to check for an option in the options table.
-* @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.
-* @return mixed
 */
 function get_user_option( $option, $user = 0, $deprecated = '' ) {
 	global $wpdb;
 	if ( !empty( $deprecated ) )
 	elseif ( $user->has_prop( $option ) ) // User specific and cross-blog
 		$result = $user->get( $option );
 	else
 		$result = false;
-	return apply_filters("get_user_option_{$option}", $result, $option, $user);
+	/**
+	 * Filter a specific user option value.
+	 *
+	 * The dynamic portion of the hook name, `$option`, refers to the user option name.
+	 *
+	 * @since 2.5.0
+	 *
+	 * @param mixed   $result Value for the user's option.
+	 * @param string  $option Name of the option being retrieved.
+	 * @param WP_User $user   WP_User object of the user whose option is being retrieved.
+	 */
+	return apply_filters( "get_user_option_{$option}", $result, $option, $user );
 }
 /**
 * Update user option with global blog capability.
 *
 * it will prepend the WordPress table prefix to the option name.
 *
 * Deletes the user option if $newvalue is empty.
 *
 * @since 2.0.0
-* @uses $wpdb WordPress database object for queries
+*
-*
+* @global wpdb $wpdb WordPress database object for queries.
-* @param int $user_id User ID
+*
+* @param int    $user_id     User ID.
 * @param string $option_name User option name.
-* @param mixed $newvalue User option value.
+* @param mixed  $newvalue    User option value.
-* @param bool $global Optional. Whether option name is global or blog specific. Default false (blog specific).
+* @param bool   $global      Optional. Whether option name is global or blog specific.
-* @return unknown
+*                            Default false (blog specific).
+* @return int|bool User meta ID if the option didn't exist, true on successful update,
+*                  false on failure.
 */
 function update_user_option( $user_id, $option_name, $newvalue, $global = false ) {
 	global $wpdb;
 	if ( !$global )
 * User options are just like user metadata except that they have support for
 * global blog options. If the 'global' parameter is false, which it is by default
 * it will prepend the WordPress table prefix to the option name.
 *
 * @since 3.0.0
-* @uses $wpdb WordPress database object for queries
+*
-*
+* @global wpdb $wpdb WordPress database object for queries.
-* @param int $user_id User ID
+*
+* @param int    $user_id     User ID
 * @param string $option_name User option name.
-* @param bool $global Optional. Whether option name is global or blog specific. Default false (blog specific).
+* @param bool   $global      Optional. Whether option name is global or blog specific.
-* @return unknown
+*                            Default false (blog specific).
+* @return bool True on success, false on failure.
 */
 function delete_user_option( $user_id, $option_name, $global = false ) {
 	global $wpdb;
 	if ( !$global )
 /**
 * WordPress User Query class.
 *
 * @since 3.1.0
+*
+* @see WP_User_Query::prepare_query() for information on accepted arguments.
 */
 class WP_User_Query {
 	/**
 	 * Query vars, after parsing
 	 *
 	 * @since 3.5.0
 	 * @access public
 	 * @var array
 	 */
-	var $query_vars = array();
+	public $query_vars = array();
 	/**
 	 * List of found user ids
 	 *
 	 * @since 3.1.0
 	 * @access private
 	 * @var array
 	 */
-	var $results;
+	private $results;
 	/**
 	 * Total number of found users for the current query
 	 *
 	 * @since 3.1.0
 	 * @access private
 	 * @var int
 	 */
-	var $total_users = 0;
+	private $total_users = 0;
+	/**
+	 * Metadata query container.
+	 *
+	 * @since 4.2.0
+	 * @access public
+	 * @var object WP_Meta_Query
+	 */
+	public $meta_query = false;
+	private $compat_fields = array( 'results', 'total_users' );
 	// SQL clauses
-	var $query_fields;
+	public $query_fields;
-	var $query_from;
+	public $query_from;
-	var $query_where;
+	public $query_where;
-	var $query_orderby;
+	public $query_orderby;
-	var $query_limit;
+	public $query_limit;
 	/**
-	 * PHP5 constructor
+	 * PHP5 constructor.
 	 *
 	 * @since 3.1.0
 	 *
-	 * @param string|array $args The query variables
+	 * @param null|string|array $args Optional. The query variables.
-	 * @return WP_User_Query
+	 */
-	 */
+	public function __construct( $query = null ) {
-	function __construct( $query = null ) {
+		if ( ! empty( $query ) ) {
-		if ( !empty( $query ) ) {
+			$this->prepare_query( $query );
+			$this->query();
+		}
+	}
+	/**
+	 * Prepare the query variables.
+	 *
+	 * @since 3.1.0
+	 * @since 4.2.0 Added 'meta_value_num' support for `$orderby` parameter. Added multi-dimensional array syntax
+	 *              for `$orderby` parameter.
+	 * @access public
+	 *
+	 * @param string|array $query {
+	 *     Optional. Array or string of Query parameters.
+	 *
+	 *     @type int          $blog_id         The site ID. Default is the global blog id.
+	 *     @type string       $role            Role name. Default empty.
+	 *     @type string       $meta_key        User meta key. Default empty.
+	 *     @type string       $meta_value      User meta value. Default empty.
+	 *     @type string       $meta_compare    Comparison operator to test the `$meta_value`. Accepts '=', '!=',
+	 *                                         '>', '>=', '<', '<=', 'LIKE', 'NOT LIKE', 'IN', 'NOT IN', 'BETWEEN',
+	 *                                         'NOT BETWEEN', 'EXISTS', 'NOT EXISTS', 'REGEXP', 'NOT REGEXP',
+	 *                                         or 'RLIKE'. Default '='.
+	 *     @type array        $include         An array of user IDs to include. Default empty array.
+	 *     @type array        $exclude         An array of user IDs to exclude. Default empty array.
+	 *     @type string       $search          Search keyword. Searches for possible string matches on columns.
+	 *                                         When `$search_columns` is left empty, it tries to determine which
+	 *                                         column to search in based on search string. Default empty.
+	 *     @type array        $search_columns  Array of column names to be searched. Accepts 'ID', 'login',
+	 *                                         'nicename', 'email', 'url'. Default empty array.
+	 *     @type string|array $orderby         Field(s) to sort the retrieved users by. May be a single value,
+	 *                                         an array of values, or a multi-dimensional array with fields as keys
+	 *                                         and orders ('ASC' or 'DESC') as values. Accepted values are'ID',
+	 *                                         'display_name' (or 'name'), 'user_login' (or 'login'),
+	 *                                         'user_nicename' (or 'nicename'), 'user_email' (or 'email'),
+	 *                                         'user_url' (or 'url'), 'user_registered' (or 'registered'),
+	 *                                         'post_count', 'meta_value', 'meta_value_num', the value of
+	 *                                         `$meta_key`, or an array key of `$meta_query`. To use 'meta_value'
+	 *                                         or 'meta_value_num', `$meta_key` must be also be defined.
+	 *                                         Default 'user_login'.
+	 *     @type string       $order           Designates ascending or descending order of users. Order values
+	 *                                         passed as part of an `$orderby` array take precedence over this
+	 *                                         parameter. Accepts 'ASC', 'DESC'. Default 'ASC'.
+	 *     @type int          $offset          Number of users to offset in retrieved results. Can be used in
+	 *                                         conjunction with pagination. Default 0.
+	 *     @type int          $number          Number of users to limit the query for. Can be used in conjunction
+	 *                                         with pagination. Value -1 (all) is not supported.
+	 *                                         Default empty (all users).
+	 *     @type bool         $count_total     Whether to count the total number of users found. If pagination is not
+	 *                                         needed, setting this to false can improve performance. Default true.
+	 *     @type string|array $fields          Which fields to return. Single or all fields (string), or array
+	 *                                         of fields. Accepts 'ID', 'display_name', 'login', 'nicename', 'email',
+	 *                                         'url', 'registered'. Use 'all' for all fields and 'all_with_meta' to
+	 *                                         include meta fields. Default 'all'.
+	 *     @type string       $who             Type of users to query. Accepts 'authors'. Default empty (all users).
+	 * }
+	 */
+	public function prepare_query( $query = array() ) {
+		global $wpdb;
+		if ( empty( $this->query_vars ) || ! empty( $query ) ) {
+			$this->query_limit = null;
 			$this->query_vars = wp_parse_args( $query, array(
 				'blog_id' => $GLOBALS['blog_id'],
 				'role' => '',
 				'meta_key' => '',
 				'meta_value' => '',
 				'number' => '',
 				'count_total' => true,
 				'fields' => 'all',
 				'who' => ''
 			) );
+		}
-			$this->prepare_query();
-			$this->query();
+		/**
-		}
+		 * Fires before the WP_User_Query has been parsed.
-	}
+		 *
+		 * The passed WP_User_Query object contains the query variables, not
-	/**
+		 * yet passed into SQL.
-	 * Prepare the query variables
+		 *
-	 *
+		 * @since 4.0.0
-	 * @since 3.1.0
+		 *
-	 * @access private
+		 * @param WP_User_Query $this The current WP_User_Query instance,
-	 */
+		 *                            passed by reference.
-	function prepare_query() {
+		 */
-		global $wpdb;
+		do_action( 'pre_get_users', $this );
 		$qv =& $this->query_vars;
 		if ( is_array( $qv['fields'] ) ) {
 			$qv['fields'] = array_unique( $qv['fields'] );
 			$this->query_fields = 'SQL_CALC_FOUND_ROWS ' . $this->query_fields;
 		$this->query_from = "FROM $wpdb->users";
 		$this->query_where = "WHERE 1=1";
+		// Parse and sanitize 'include', for use by 'orderby' as well as 'include' below.
+		if ( ! empty( $qv['include'] ) ) {
+			$include = wp_parse_id_list( $qv['include'] );
+		} else {
+			$include = false;
+		}
+		$blog_id = 0;
+		if ( isset( $qv['blog_id'] ) ) {
+			$blog_id = absint( $qv['blog_id'] );
+		}
+		if ( isset( $qv['who'] ) && 'authors' == $qv['who'] && $blog_id ) {
+			$qv['meta_key'] = $wpdb->get_blog_prefix( $blog_id ) . 'user_level';
+			$qv['meta_value'] = 0;
+			$qv['meta_compare'] = '!=';
+			$qv['blog_id'] = $blog_id = 0; // Prevent extra meta query
+		}
+		// Meta query.
+		$this->meta_query = new WP_Meta_Query();
+		$this->meta_query->parse_query_vars( $qv );
+		$role = '';
+		if ( isset( $qv['role'] ) ) {
+			$role = trim( $qv['role'] );
+		}
+		if ( $blog_id && ( $role || is_multisite() ) ) {
+			$cap_meta_query = array();
+			$cap_meta_query['key'] = $wpdb->get_blog_prefix( $blog_id ) . 'capabilities';
+			if ( $role ) {
+				$cap_meta_query['value'] = '"' . $role . '"';
+				$cap_meta_query['compare'] = 'like';
+			}
+			if ( empty( $this->meta_query->queries ) ) {
+				$this->meta_query->queries = array( $cap_meta_query );
+			} elseif ( ! in_array( $cap_meta_query, $this->meta_query->queries, true ) ) {
+				// Append the cap query to the original queries and reparse the query.
+				$this->meta_query->queries = array(
+					'relation' => 'AND',
+					array( $this->meta_query->queries, $cap_meta_query ),
+				);
+			}
+			$this->meta_query->parse_query_vars( $this->meta_query->queries );
+		}
+		if ( ! empty( $this->meta_query->queries ) ) {
+			$clauses = $this->meta_query->get_sql( 'user', $wpdb->users, 'ID', $this );
+			$this->query_from .= $clauses['join'];
+			$this->query_where .= $clauses['where'];
+			if ( 'OR' == $this->meta_query->relation ) {
+				$this->query_fields = 'DISTINCT ' . $this->query_fields;
+			}
+		}
 		// sorting
-		if ( isset( $qv['orderby'] ) ) {
+		$qv['order'] = isset( $qv['order'] ) ? strtoupper( $qv['order'] ) : '';
-			if ( in_array( $qv['orderby'], array('nicename', 'email', 'url', 'registered') ) ) {
+		$order = $this->parse_order( $qv['order'] );
-				$orderby = 'user_' . $qv['orderby'];
-			} elseif ( in_array( $qv['orderby'], array('user_nicename', 'user_email', 'user_url', 'user_registered') ) ) {
+		if ( empty( $qv['orderby'] ) ) {
-				$orderby = $qv['orderby'];
+			// Default order is by 'user_login'.
-			} elseif ( 'name' == $qv['orderby'] || 'display_name' == $qv['orderby'] ) {
+			$ordersby = array( 'user_login' => $order );
-				$orderby = 'display_name';
+		} else if ( is_array( $qv['orderby'] ) ) {
-			} elseif ( 'post_count' == $qv['orderby'] ) {
+			$ordersby = $qv['orderby'];
-				// todo: avoid the JOIN
+		} else {
-				$where = get_posts_by_author_sql('post');
+			// 'orderby' values may be a comma- or space-separated list.
-				$this->query_from .= " LEFT OUTER JOIN (
+			$ordersby = preg_split( '/[,\s]+/', $qv['orderby'] );
-					SELECT post_author, COUNT(*) as post_count
+		}
-					FROM $wpdb->posts
-					$where
+		$orderby_array = array();
-					GROUP BY post_author
+		foreach ( $ordersby as $_key => $_value ) {
-				) p ON ({$wpdb->users}.ID = p.post_author)
+			if ( ! $_value ) {
-				";
+				continue;
-				$orderby = 'post_count';
+			}
-			} elseif ( 'ID' == $qv['orderby'] || 'id' == $qv['orderby'] ) {
-				$orderby = 'ID';
+			if ( is_int( $_key ) ) {
-			} elseif ( 'meta_value' == $qv['orderby'] ) {
+				// Integer key means this is a flat array of 'orderby' fields.
-				$orderby = "$wpdb->usermeta.meta_value";
+				$_orderby = $_value;
+				$_order = $order;
 			} else {
-				$orderby = 'user_login';
+				// Non-integer key means this the key is the field and the value is ASC/DESC.
+				$_orderby = $_key;
+				$_order = $_value;
 			}
-		}
+			$parsed = $this->parse_orderby( $_orderby );
-		if ( empty( $orderby ) )
-			$orderby = 'user_login';
+			if ( ! $parsed ) {
+				continue;
-		$qv['order'] = isset( $qv['order'] ) ? strtoupper( $qv['order'] ) : '';
+			}
-		if ( 'ASC' == $qv['order'] )
-			$order = 'ASC';
+			$orderby_array[] = $parsed . ' ' . $this->parse_order( $_order );
-		else
+		}
-			$order = 'DESC';
-		$this->query_orderby = "ORDER BY $orderby $order";
+		// If no valid clauses were found, order by user_login.
+		if ( empty( $orderby_array ) ) {
+			$orderby_array[] = "user_login $order";
+		}
+		$this->query_orderby = 'ORDER BY ' . implode( ', ', $orderby_array );
 		// limit
 		if ( isset( $qv['number'] ) && $qv['number'] ) {
 			if ( $qv['offset'] )
 				$this->query_limit = $wpdb->prepare("LIMIT %d, %d", $qv['offset'], $qv['number']);
 					$search_columns = array('user_url');
 				else
 					$search_columns = array('user_login', 'user_nicename');
 			}
+			/**
+			 * Filter the columns to search in a WP_User_Query search.
+			 *
+			 * The default columns depend on the search term, and include 'user_email',
+			 * 'user_login', 'ID', 'user_url', and 'user_nicename'.
+			 *
+			 * @since 3.6.0
+			 *
+			 * @param array         $search_columns Array of column names to be searched.
+			 * @param string        $search         Text being searched.
+			 * @param WP_User_Query $this           The current WP_User_Query instance.
+			 */
 			$search_columns = apply_filters( 'user_search_columns', $search_columns, $search, $this );
 			$this->query_where .= $this->get_search_sql( $search, $search_columns, $wild );
 		}
-		$blog_id = 0;
+		if ( ! empty( $include ) ) {
-		if ( isset( $qv['blog_id'] ) )
+			// Sanitized earlier.
-			$blog_id = absint( $qv['blog_id'] );
+			$ids = implode( ',', $include );
-		if ( isset( $qv['who'] ) && 'authors' == $qv['who'] && $blog_id ) {
-			$qv['meta_key'] = $wpdb->get_blog_prefix( $blog_id ) . 'user_level';
-			$qv['meta_value'] = 0;
-			$qv['meta_compare'] = '!=';
-			$qv['blog_id'] = $blog_id = 0; // Prevent extra meta query
-		}
-		$role = '';
-		if ( isset( $qv['role'] ) )
-			$role = trim( $qv['role'] );
-		if ( $blog_id && ( $role || is_multisite() ) ) {
-			$cap_meta_query = array();
-			$cap_meta_query['key'] = $wpdb->get_blog_prefix( $blog_id ) . 'capabilities';
-			if ( $role ) {
-				$cap_meta_query['value'] = '"' . $role . '"';
-				$cap_meta_query['compare'] = 'like';
-			}
-			$qv['meta_query'][] = $cap_meta_query;
-		}
-		$meta_query = new WP_Meta_Query();
-		$meta_query->parse_query_vars( $qv );
-		if ( !empty( $meta_query->queries ) ) {
-			$clauses = $meta_query->get_sql( 'user', $wpdb->users, 'ID', $this );
-			$this->query_from .= $clauses['join'];
-			$this->query_where .= $clauses['where'];
-			if ( 'OR' == $meta_query->relation )
-				$this->query_fields = 'DISTINCT ' . $this->query_fields;
-		}
-		if ( ! empty( $qv['include'] ) ) {
-			$ids = implode( ',', wp_parse_id_list( $qv['include'] ) );
 			$this->query_where .= " AND $wpdb->users.ID IN ($ids)";
 		} elseif ( ! empty( $qv['exclude'] ) ) {
 			$ids = implode( ',', wp_parse_id_list( $qv['exclude'] ) );
 			$this->query_where .= " AND $wpdb->users.ID NOT IN ($ids)";
 		}
+		// Date queries are allowed for the user_registered field.
+		if ( ! empty( $qv['date_query'] ) && is_array( $qv['date_query'] ) ) {
+			$date_query = new WP_Date_Query( $qv['date_query'], 'user_registered' );
+			$this->query_where .= $date_query->get_sql();
+		}
+		/**
+		 * Fires after the WP_User_Query has been parsed, and before
+		 * the query is executed.
+		 *
+		 * The passed WP_User_Query object contains SQL parts formed
+		 * from parsing the given query.
+		 *
+		 * @since 3.1.0
+		 *
+		 * @param WP_User_Query $this The current WP_User_Query instance,
+		 *                            passed by reference.
+		 */
 		do_action_ref_array( 'pre_user_query', array( &$this ) );
 	}
 	/**
-	 * Execute the query, with the current variables
+	 * Execute the query, with the current variables.
 	 *
 	 * @since 3.1.0
-	 * @access private
+	 *
-	 */
+	 * @global wpdb $wpdb WordPress database object for queries.
-	function query() {
+	 */
+	public function query() {
 		global $wpdb;
 		$qv =& $this->query_vars;
+		$query = "SELECT $this->query_fields $this->query_from $this->query_where $this->query_orderby $this->query_limit";
 		if ( is_array( $qv['fields'] ) || 'all' == $qv['fields'] ) {
-			$this->results = $wpdb->get_results("SELECT $this->query_fields $this->query_from $this->query_where $this->query_orderby $this->query_limit");
+			$this->results = $wpdb->get_results( $query );
 		} else {
-			$this->results = $wpdb->get_col("SELECT $this->query_fields $this->query_from $this->query_where $this->query_orderby $this->query_limit");
+			$this->results = $wpdb->get_col( $query );
 		}
+		/**
+		 * Filter SELECT FOUND_ROWS() query for the current WP_User_Query instance.
+		 *
+		 * @since 3.2.0
+		 *
+		 * @global wpdb $wpdb WordPress database abstraction object.
+		 *
+		 * @param string $sql The SELECT FOUND_ROWS() query for the current WP_User_Query.
+		 */
 		if ( isset( $qv['count_total'] ) && $qv['count_total'] )
 			$this->total_users = $wpdb->get_var( apply_filters( 'found_users_query', 'SELECT FOUND_ROWS()' ) );
 		if ( !$this->results )
 			return;
 				$r[ $userid ] = new WP_User( $userid, '', $qv['blog_id'] );
 			$this->results = $r;
 		} elseif ( 'all' == $qv['fields'] ) {
 			foreach ( $this->results as $key => $user ) {
-				$this->results[ $key ] = new WP_User( $user );
+				$this->results[ $key ] = new WP_User( $user, '', $qv['blog_id'] );
 			}
 		}
 	}
 	/**
 	 * @access public
 	 *
 	 * @param string $query_var Query variable key.
 	 * @return mixed
 	 */
-	function get( $query_var ) {
+	public function get( $query_var ) {
 		if ( isset( $this->query_vars[$query_var] ) )
 			return $this->query_vars[$query_var];
 		return null;
 	}
 	 * @access public
 	 *
 	 * @param string $query_var Query variable key.
 	 * @param mixed $value Query variable value.
 	 */
-	function set( $query_var, $value ) {
+	public function set( $query_var, $value ) {
 		$this->query_vars[$query_var] = $value;
 	}
-	/*
+	/**
 	 * Used internally to generate an SQL string for searching across multiple columns
 	 *
 	 * @access protected
 	 * @since 3.1.0
 	 *
 	 * @param array $cols
 	 * @param bool $wild Whether to allow wildcard searches. Default is false for Network Admin, true for
 	 *  single site. Single site allows leading and trailing wildcards, Network Admin only trailing.
 	 * @return string
 	 */
-	function get_search_sql( $string, $cols, $wild = false ) {
+	protected function get_search_sql( $string, $cols, $wild = false ) {
-		$string = esc_sql( $string );
+		global $wpdb;
 		$searches = array();
 		$leading_wild = ( 'leading' == $wild || 'both' == $wild ) ? '%' : '';
 		$trailing_wild = ( 'trailing' == $wild || 'both' == $wild ) ? '%' : '';
+		$like = $leading_wild . $wpdb->esc_like( $string ) . $trailing_wild;
 		foreach ( $cols as $col ) {
-			if ( 'ID' == $col )
+			if ( 'ID' == $col ) {
-				$searches[] = "$col = '$string'";
+				$searches[] = $wpdb->prepare( "$col = %s", $string );
-			else
+			} else {
-				$searches[] = "$col LIKE '$leading_wild" . like_escape($string) . "$trailing_wild'";
+				$searches[] = $wpdb->prepare( "$col LIKE %s", $like );
+			}
 		}
 		return ' AND (' . implode(' OR ', $searches) . ')';
 	}
 	/**
-	 * Return the list of users
+	 * Return the list of users.
 	 *
 	 * @since 3.1.0
 	 * @access public
 	 *
-	 * @return array
+	 * @return array Array of results.
 	 */
-	function get_results() {
+	public function get_results() {
 		return $this->results;
 	}
 	/**
-	 * Return the total number of users for the current query
+	 * Return the total number of users for the current query.
 	 *
 	 * @since 3.1.0
 	 * @access public
 	 *
-	 * @return array
+	 * @return int Number of total users.
 	 */
-	function get_total() {
+	public function get_total() {
 		return $this->total_users;
 	}
+	/**
+	 * Parse and sanitize 'orderby' keys passed to the user query.
+	 *
+	 * @since 4.2.0
+	 * @access protected
+	 *
+	 * @global wpdb $wpdb WordPress database abstraction object.
+	 *
+	 * @param string $orderby Alias for the field to order by.
+	 * @return string|bool Value to used in the ORDER clause, if `$orderby` is valid. False otherwise.
+	 */
+	protected function parse_orderby( $orderby ) {
+		global $wpdb;
+		$meta_query_clauses = $this->meta_query->get_clauses();
+		$_orderby = '';
+		if ( in_array( $orderby, array( 'login', 'nicename', 'email', 'url', 'registered' ) ) ) {
+			$_orderby = 'user_' . $orderby;
+		} elseif ( in_array( $orderby, array( 'user_login', 'user_nicename', 'user_email', 'user_url', 'user_registered' ) ) ) {
+			$_orderby = $orderby;
+		} elseif ( 'name' == $orderby || 'display_name' == $orderby ) {
+			$_orderby = 'display_name';
+		} elseif ( 'post_count' == $orderby ) {
+			// todo: avoid the JOIN
+			$where = get_posts_by_author_sql( 'post' );
+			$this->query_from .= " LEFT OUTER JOIN (
+				SELECT post_author, COUNT(*) as post_count
+				FROM $wpdb->posts
+				$where
+				GROUP BY post_author
+			) p ON ({$wpdb->users}.ID = p.post_author)
+			";
+			$_orderby = 'post_count';
+		} elseif ( 'ID' == $orderby || 'id' == $orderby ) {
+			$_orderby = 'ID';
+		} elseif ( 'meta_value' == $orderby || $this->get( 'meta_key' ) == $orderby ) {
+			$_orderby = "$wpdb->usermeta.meta_value";
+		} elseif ( 'meta_value_num' == $orderby ) {
+			$_orderby = "$wpdb->usermeta.meta_value+0";
+		} elseif ( 'include' === $orderby && ! empty( $this->query_vars['include'] ) ) {
+			$include = wp_parse_id_list( $this->query_vars['include'] );
+			$include_sql = implode( ',', $include );
+			$_orderby = "FIELD( $wpdb->users.ID, $include_sql )";
+		} elseif ( isset( $meta_query_clauses[ $orderby ] ) ) {
+			$meta_clause = $meta_query_clauses[ $orderby ];
+			$_orderby = sprintf( "CAST(%s.meta_value AS %s)", esc_sql( $meta_clause['alias'] ), esc_sql( $meta_clause['cast'] ) );
+		}
+		return $_orderby;
+	}
+	/**
+	 * Parse an 'order' query variable and cast it to ASC or DESC as necessary.
+	 *
+	 * @since 4.2.0
+	 * @access protected
+	 *
+	 * @param string $order The 'order' query variable.
+	 * @return string The sanitized 'order' query variable.
+	 */
+	protected function parse_order( $order ) {
+		if ( ! is_string( $order ) || empty( $order ) ) {
+			return 'DESC';
+		}
+		if ( 'ASC' === strtoupper( $order ) ) {
+			return 'ASC';
+		} else {
+			return 'DESC';
+		}
+	}
+	/**
+	 * Make private properties readable for backwards compatibility.
+	 *
+	 * @since 4.0.0
+	 * @access public
+	 *
+	 * @param string $name Property to get.
+	 * @return mixed Property.
+	 */
+	public function __get( $name ) {
+		if ( in_array( $name, $this->compat_fields ) ) {
+			return $this->$name;
+		}
+	}
+	/**
+	 * Make private properties settable for backwards compatibility.
+	 *
+	 * @since 4.0.0
+	 * @access public
+	 *
+	 * @param string $name  Property to check if set.
+	 * @param mixed  $value Property value.
+	 * @return mixed Newly-set property.
+	 */
+	public function __set( $name, $value ) {
+		if ( in_array( $name, $this->compat_fields ) ) {
+			return $this->$name = $value;
+		}
+	}
+	/**
+	 * Make private properties checkable for backwards compatibility.
+	 *
+	 * @since 4.0.0
+	 * @access public
+	 *
+	 * @param string $name Property to check if set.
+	 * @return bool Whether the property is set.
+	 */
+	public function __isset( $name ) {
+		if ( in_array( $name, $this->compat_fields ) ) {
+			return isset( $this->$name );
+		}
+	}
+	/**
+	 * Make private properties un-settable for backwards compatibility.
+	 *
+	 * @since 4.0.0
+	 * @access public
+	 *
+	 * @param string $name Property to unset.
+	 */
+	public function __unset( $name ) {
+		if ( in_array( $name, $this->compat_fields ) ) {
+			unset( $this->$name );
+		}
+	}
+	/**
+	 * Make private/protected methods readable for backwards compatibility.
+	 *
+	 * @since 4.0.0
+	 * @access public
+	 *
+	 * @param callable $name      Method to call.
+	 * @param array    $arguments Arguments to pass when calling.
+	 * @return mixed|bool Return value of the callback, false otherwise.
+	 */
+	public function __call( $name, $arguments ) {
+		if ( 'get_search_sql' === $name ) {
+			return call_user_func_array( array( $this, $name ), $arguments );
+		}
+		return false;
+	}
 }
 /**
 * Retrieve list of users matching criteria.
 *
 * @since 3.1.0
-* @uses $wpdb
+*
-* @uses WP_User_Query See for default arguments and information.
+* @see WP_User_Query
 *
-* @param array $args Optional.
+* @param array $args Optional. Arguments to retrieve users. See {@see WP_User_Query::prepare_query()}
+*                    for more information on accepted arguments.
 * @return array List of users.
 */
 function get_users( $args = array() ) {
 	$args = wp_parse_args( $args );
 /**
 * Get the blogs a user belongs to.
 *
 * @since 3.0.0
 *
-* @param int $user_id User ID
+* @global wpdb $wpdb WordPress database object for queries.
-* @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.
+* @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.
 */
 function get_blogs_of_user( $user_id, $all = false ) {
 	global $wpdb;
 	$user_id = (int) $user_id;
 				'deleted'     => 0
 			);
 		}
 	}
+	/**
+	 * Filter the list of blogs a user belongs to.
+	 *
+	 * @since MU
+	 *
+	 * @param array $blogs   An array of blog objects belonging to the user.
+	 * @param int   $user_id User ID.
+	 * @param bool  $all     Whether the returned blogs array should contain all blogs, including
+	 *                       those marked 'deleted', 'archived', or 'spam'. Default false.
+	 */
 	return apply_filters( 'get_blogs_of_user', $blogs, $user_id, $all );
 }
 /**
 * Find out whether a user is a member of a given blog.
 *
 * @since MU 1.1
-* @uses get_blogs_of_user()
 *
 * @param int $user_id Optional. The unique ID of the user. Defaults to the current user.
 * @param int $blog_id Optional. ID of the blog to check. Defaults to the current site.
 * @return bool
 */
 * Add meta data field to a user.
 *
 * Post meta data is called "Custom Fields" on the Administration Screens.
 *
 * @since 3.0.0
-* @uses add_metadata()
+* @link https://codex.wordpress.org/Function_Reference/add_user_meta
-* @link http://codex.wordpress.org/Function_Reference/add_user_meta
+*
-*
+* @param int $user_id User ID.
-* @param int $user_id Post ID.
 * @param string $meta_key Metadata name.
 * @param mixed $meta_value Metadata value.
 * @param bool $unique Optional, default is false. Whether the same key should not be added.
 * @return int|bool Meta ID on success, false on failure.
 */
 * You can match based on the key, or key and value. Removing based on key and
 * value, will keep from removing duplicate metadata with the same key. It also
 * allows removing all metadata matching key, if needed.
 *
 * @since 3.0.0
-* @uses delete_metadata()
+* @link https://codex.wordpress.org/Function_Reference/delete_user_meta
-* @link http://codex.wordpress.org/Function_Reference/delete_user_meta
 *
 * @param int $user_id user ID
 * @param string $meta_key Metadata name.
 * @param mixed $meta_value Optional. Metadata value.
 * @return bool True on success, false on failure.
 /**
 * Retrieve user meta field for a user.
 *
 * @since 3.0.0
-* @uses get_metadata()
+* @link https://codex.wordpress.org/Function_Reference/get_user_meta
-* @link http://codex.wordpress.org/Function_Reference/get_user_meta
+*
-*
+* @param int $user_id User ID.
-* @param int $user_id Post ID.
 * @param string $key Optional. The meta key to retrieve. By default, returns data for all keys.
 * @param bool $single Whether to return a single value.
 * @return mixed Will be an array if $single is false. Will be value of meta data field if $single
 *  is true.
 */
 * same key and user ID.
 *
 * If the meta field for the user does not exist, it will be added.
 *
 * @since 3.0.0
-* @uses update_metadata
+* @link https://codex.wordpress.org/Function_Reference/update_user_meta
-* @link http://codex.wordpress.org/Function_Reference/update_user_meta
+*
-*
+* @param int $user_id User ID.
-* @param int $user_id Post ID.
 * @param string $meta_key Metadata key.
 * @param mixed $meta_value Metadata value.
 * @param mixed $prev_value Optional. Previous value to check before removing.
-* @return bool True on success, false on failure.
+* @return int|bool Meta ID if the key didn't exist, true on successful update, false on failure.
 */
 function update_user_meta($user_id, $meta_key, $meta_value, $prev_value = '') {
 	return update_metadata('user', $user_id, $meta_key, $meta_value, $prev_value);
 }
 		$avail_roles = $wp_roles->get_names();
 		// Build a CPU-intensive query that will return concise information.
 		$select_count = array();
 		foreach ( $avail_roles as $this_role => $name ) {
-			$select_count[] = "COUNT(NULLIF(`meta_value` LIKE '%\"" . like_escape( $this_role ) . "\"%', false))";
+			$select_count[] = $wpdb->prepare( "COUNT(NULLIF(`meta_value` LIKE %s, false))", '%' . $wpdb->esc_like( '"' . $this_role . '"' ) . '%');
 		}
 		$select_count = implode(', ', $select_count);
 		// Add the meta_value index to the selection list, then run the query.
 		$row = $wpdb->get_row( "SELECT $select_count, COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$blog_prefix}capabilities'", ARRAY_N );
 * setting the 'echo' argument. The 'include' and 'exclude' arguments do not
 * need to be used; all users will be displayed in that case. Only one can be
 * used, either 'include' or 'exclude', but not both.
 *
 * The available arguments are as follows:
-* <ol>
-* <li>show_option_all - Text to show all and whether HTML option exists.</li>
-* <li>show_option_none - Text for show none and whether HTML option exists.</li>
-* <li>hide_if_only_one_author - Don't create the dropdown if there is only one user.</li>
-* <li>orderby - SQL order by clause for what order the users appear. Default is 'display_name'.</li>
-* <li>order - Default is 'ASC'. Can also be 'DESC'.</li>
-* <li>include - User IDs to include.</li>
-* <li>exclude - User IDs to exclude.</li>
-* <li>multi - Default is 'false'. Whether to skip the ID attribute on the 'select' element. A 'true' value is overridden when id argument is set.</li>
-* <li>show - Default is 'display_name'. User table column to display. If the selected item is empty then the user_login will be displayed in parentheses</li>
-* <li>echo - Default is '1'. Whether to display or retrieve content.</li>
-* <li>selected - Which User ID is selected.</li>
-* <li>include_selected - Always include the selected user ID in the dropdown. Default is false.</li>
-* <li>name - Default is 'user'. Name attribute of select element.</li>
-* <li>id - Default is the value of the 'name' parameter. ID attribute of select element.</li>
-* <li>class - Class attribute of select element.</li>
-* <li>blog_id - ID of blog (Multisite only). Defaults to ID of current blog.</li>
-* <li>who - Which users to query. Currently only 'authors' is supported. Default is all users.</li>
-* </ol>
 *
 * @since 2.3.0
-* @uses $wpdb WordPress database object for queries
+*
-*
+* @global wpdb $wpdb WordPress database object for queries.
-* @param string|array $args Optional. Override defaults.
+*
+* @param array|string $args {
+*     Optional. Array or string of arguments to generate a drop-down of users.
+*     {@see WP_User_Query::prepare_query() for additional available arguments.
+*
+*     @type string       $show_option_all         Text to show as the drop-down default (all).
+*                                                 Default empty.
+*     @type string       $show_option_none        Text to show as the drop-down default when no
+*                                                 users were found. Default empty.
+*     @type int|string   $option_none_value       Value to use for $show_option_non when no users
+*                                                 were found. Default -1.
+*     @type string       $hide_if_only_one_author Whether to skip generating the drop-down
+*                                                 if only one user was found. Default empty.
+*     @type string       $orderby                 Field to order found users by. Accepts user fields.
+*                                                 Default 'display_name'.
+*     @type string       $order                   Whether to order users in ascending or descending
+*                                                 order. Accepts 'ASC' (ascending) or 'DESC' (descending).
+*                                                 Default 'ASC'.
+*     @type array|string $include                 Array or comma-separated list of user IDs to include.
+*                                                 Default empty.
+*     @type array|string $exclude                 Array or comma-separated list of user IDs to exclude.
+*                                                 Default empty.
+*     @type bool|int     $multi                   Whether to skip the ID attribute on the 'select' element.
+*                                                 Accepts 1|true or 0|false. Default 0|false.
+*     @type string       $show                    User table column to display. If the selected item is empty
+*                                                 then the 'user_login' will be displayed in parentheses.
+*                                                 Accepts user fields. Default 'display_name'.
+*     @type int|bool     $echo                    Whether to echo or return the drop-down. Accepts 1|true (echo)
+*                                                 or 0|false (return). Default 1|true.
+*     @type int          $selected                Which user ID should be selected. Default 0.
+*     @type bool         $include_selected        Whether to always include the selected user ID in the drop-
+*                                                 down. Default false.
+*     @type string       $name                    Name attribute of select element. Default 'user'.
+*     @type string       $id                      ID attribute of the select element. Default is the value of $name.
+*     @type string       $class                   Class attribute of the select element. Default empty.
+*     @type int          $blog_id                 ID of blog (Multisite only). Default is ID of the current blog.
+*     @type string       $who                     Which type of users to query. Accepts only an empty string or
+*                                                 'authors'. Default empty.
+* }
 * @return string|null Null on display. String of HTML content on retrieve.
 */
 function wp_dropdown_users( $args = '' ) {
 	$defaults = array(
 		'show_option_all' => '', 'show_option_none' => '', 'hide_if_only_one_author' => '',
 		'orderby' => 'display_name', 'order' => 'ASC',
 		'include' => '', 'exclude' => '', 'multi' => 0,
 		'show' => 'display_name', 'echo' => 1,
 		'selected' => 0, 'name' => 'user', 'class' => '', 'id' => '',
-		'blog_id' => $GLOBALS['blog_id'], 'who' => '', 'include_selected' => false
+		'blog_id' => $GLOBALS['blog_id'], 'who' => '', 'include_selected' => false,
+		'option_none_value' => -1
 	);
 	$defaults['selected'] = is_author() ? get_query_var( 'author' ) : 0;
 	$r = wp_parse_args( $args, $defaults );
-	extract( $r, EXTR_SKIP );
+	$show = $r['show'];
+	$show_option_all = $r['show_option_all'];
+	$show_option_none = $r['show_option_none'];
+	$option_none_value = $r['option_none_value'];
 	$query_args = wp_array_slice_assoc( $r, array( 'blog_id', 'include', 'exclude', 'orderby', 'order', 'who' ) );
 	$query_args['fields'] = array( 'ID', 'user_login', $show );
 	$users = get_users( $query_args );
 	$output = '';
-	if ( !empty($users) && ( empty($hide_if_only_one_author) || count($users) > 1 ) ) {
+	if ( ! empty( $users ) && ( empty( $r['hide_if_only_one_author'] ) || count( $users ) > 1 ) ) {
-		$name = esc_attr( $name );
+		$name = esc_attr( $r['name'] );
-		if ( $multi && ! $id )
+		if ( $r['multi'] && ! $r['id'] ) {
 			$id = '';
-		else
+		} else {
-			$id = $id ? " id='" . esc_attr( $id ) . "'" : " id='$name'";
+			$id = $r['id'] ? " id='" . esc_attr( $r['id'] ) . "'" : " id='$name'";
+		}
-		$output = "<select name='{$name}'{$id} class='$class'>\n";
+		$output = "<select name='{$name}'{$id} class='" . $r['class'] . "'>\n";
-		if ( $show_option_all )
+		if ( $show_option_all ) {
 			$output .= "\t<option value='0'>$show_option_all</option>\n";
+		}
 		if ( $show_option_none ) {
-			$_selected = selected( -1, $selected, false );
+			$_selected = selected( $option_none_value, $r['selected'], false );
-			$output .= "\t<option value='-1'$_selected>$show_option_none</option>\n";
+			$output .= "\t<option value='" . esc_attr( $option_none_value ) . "'$_selected>$show_option_none</option>\n";
 		}
 		$found_selected = false;
 		foreach ( (array) $users as $user ) {
 			$user->ID = (int) $user->ID;
-			$_selected = selected( $user->ID, $selected, false );
+			$_selected = selected( $user->ID, $r['selected'], false );
-			if ( $_selected )
+			if ( $_selected ) {
 				$found_selected = true;
-			$display = !empty($user->$show) ? $user->$show : '('. $user->user_login . ')';
+			}
-			$output .= "\t<option value='$user->ID'$_selected>" . esc_html($display) . "</option>\n";
+			$display = ! empty( $user->$show ) ? $user->$show : '('. $user->user_login . ')';
-		}
+			$output .= "\t<option value='$user->ID'$_selected>" . esc_html( $display ) . "</option>\n";
+		}
-		if ( $include_selected && ! $found_selected && ( $selected > 0 ) ) {
-			$user = get_userdata( $selected );
+		if ( $r['include_selected'] && ! $found_selected && ( $r['selected'] > 0 ) ) {
-			$_selected = selected( $user->ID, $selected, false );
+			$user = get_userdata( $r['selected'] );
-			$display = !empty($user->$show) ? $user->$show : '('. $user->user_login . ')';
+			$_selected = selected( $user->ID, $r['selected'], false );
-			$output .= "\t<option value='$user->ID'$_selected>" . esc_html($display) . "</option>\n";
+			$display = ! empty( $user->$show ) ? $user->$show : '('. $user->user_login . ')';
+			$output .= "\t<option value='$user->ID'$_selected>" . esc_html( $display ) . "</option>\n";
 		}
 		$output .= "</select>";
 	}
-	$output = apply_filters('wp_dropdown_users', $output);
+	/**
+	 * Filter the wp_dropdown_users() HTML output.
-	if ( $echo )
+	 *
-		echo $output;
+	 * @since 2.3.0
+	 *
-	return $output;
+	 * @param string $output HTML output generated by wp_dropdown_users().
+	 */
+	$html = apply_filters( 'wp_dropdown_users', $output );
+	if ( $r['echo'] ) {
+		echo $html;
+	}
+	return $html;
 }
 /**
 * Sanitize user field based on context.
 *
 * Possible context values are:  'raw', 'edit', 'db', 'display', 'attribute' and 'js'. The
 * 'display' context is used by default. 'attribute' and 'js' contexts are treated like 'display'
 * when calling filters.
 *
 * @since 2.3.0
-* @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.
 *
 * @param string $field The user Object field name.
 * @param mixed $value The user Object value.
 * @param int $user_id user ID.
 * @param string $context How to sanitize user fields. Looks for 'raw', 'edit', 'db', 'display',
 	$prefixed = false !== strpos( $field, 'user_' );
 	if ( 'edit' == $context ) {
 		if ( $prefixed ) {
-			$value = apply_filters("edit_{$field}", $value, $user_id);
+			/** This filter is documented in wp-includes/post.php */
+			$value = apply_filters( "edit_{$field}", $value, $user_id );
 		} else {
-			$value = apply_filters("edit_user_{$field}", $value, $user_id);
+			/**
+			 * Filter a user field value in the 'edit' context.
+			 *
+			 * The dynamic portion of the hook name, `$field`, refers to the prefixed user
+			 * field being filtered, such as 'user_login', 'user_email', 'first_name', etc.
+			 *
+			 * @since 2.9.0
+			 *
+			 * @param mixed $value   Value of the prefixed user field.
+			 * @param int   $user_id User ID.
+			 */
+			$value = apply_filters( "edit_user_{$field}", $value, $user_id );
 		}
 		if ( 'description' == $field )
 			$value = esc_html( $value ); // textarea_escaped?
 		else
 			$value = esc_attr($value);
-	} else if ( 'db' == $context ) {
+	} elseif ( 'db' == $context ) {
 		if ( $prefixed ) {
-			$value = apply_filters("pre_{$field}", $value);
+			/** This filter is documented in wp-includes/post.php */
+			$value = apply_filters( "pre_{$field}", $value );
 		} else {
-			$value = apply_filters("pre_user_{$field}", $value);
+			/**
+			 * Filter the value of a user field in the 'db' context.
+			 *
+			 * The dynamic portion of the hook name, `$field`, refers to the prefixed user
+			 * field being filtered, such as 'user_login', 'user_email', 'first_name', etc.
+			 *
+			 * @since 2.9.0
+			 *
+			 * @param mixed $value Value of the prefixed user field.
+			 */
+			$value = apply_filters( "pre_user_{$field}", $value );
 		}
 	} else {
 		// Use display filters by default.
-		if ( $prefixed )
+		if ( $prefixed ) {
-			$value = apply_filters($field, $value, $user_id, $context);
-		else
+			/** This filter is documented in wp-includes/post.php */
-			$value = apply_filters("user_{$field}", $value, $user_id, $context);
+			$value = apply_filters( $field, $value, $user_id, $context );
+		} else {
+			/**
+			 * Filter the value of a user field in a standard context.
+			 *
+			 * The dynamic portion of the hook name, `$field`, refers to the prefixed user
+			 * field being filtered, such as 'user_login', 'user_email', 'first_name', etc.
+			 *
+			 * @since 2.9.0
+			 *
+			 * @param mixed  $value   The user object value to sanitize.
+			 * @param int    $user_id User ID.
+			 * @param string $context The context to filter within.
+			 */
+			$value = apply_filters( "user_{$field}", $value, $user_id, $context );
+		}
 	}
 	if ( 'user_url' == $field )
 		$value = esc_url($value);
-	if ( 'attribute' == $context )
+	if ( 'attribute' == $context ) {
-		$value = esc_attr($value);
+		$value = esc_attr( $value );
-	else if ( 'js' == $context )
+	} elseif ( 'js' == $context ) {
-		$value = esc_js($value);
+		$value = esc_js( $value );
+	}
 	return $value;
 }
 /**
 * Update all user caches
 /**
 * Checks whether the given email exists.
 *
 * @since 2.1.0
-* @uses $wpdb
 *
 * @param string $email Email.
 * @return bool|int The user's ID on success, and false on failure.
 */
 function email_exists( $email ) {
 	return false;
 }
 /**
-* Checks whether an username is valid.
+* Checks whether a username is valid.
 *
 * @since 2.0.1
-* @uses apply_filters() Calls 'validate_username' hook on $valid check and $username as parameters
 *
 * @param string $username Username.
 * @return bool Whether username given is valid
 */
 function validate_username( $username ) {
 	$sanitized = sanitize_user( $username, true );
 	$valid = ( $sanitized == $username );
+	/**
+	 * Filter whether the provided username is valid or not.
+	 *
+	 * @since 2.0.1
+	 *
+	 * @param bool   $valid    Whether given username is valid.
+	 * @param string $username Username to check.
+	 */
 	return apply_filters( 'validate_username', $valid, $username );
 }
 /**
-* Insert an user into the database.
+* Insert a user into the database.
-*
-* Can update a current user or insert a new user based on whether the user's ID
-* is present.
-*
-* Can be used to update the user's info (see below), set the user's role, and
-* set the user's preference on whether they want the rich editor on.
 *
 * Most of the $userdata array fields have filters associated with the values.
 * The exceptions are 'rich_editing', 'role', 'jabber', 'aim', 'yim',
 * 'user_registered', and 'ID'. The filters have the prefix 'pre_user_' followed
 * by the field name. An example using 'description' would have the filter
 * called, 'pre_user_description' that can be hooked into.
 *
-* The $userdata array can contain the following fields:
-* 'ID' - An integer that will be used for updating an existing user.
-* 'user_pass' - A string that contains the plain text password for the user.
-* 'user_login' - A string that contains the user's username for logging in.
-* 'user_nicename' - A string that contains a URL-friendly name for the user.
-*		The default is the user's username.
-* 'user_url' - A string containing the user's URL for the user's web site.
-* 'user_email' - A string containing the user's email address.
-* 'display_name' - A string that will be shown on the site. Defaults to user's
-*		username. It is likely that you will want to change this, for appearance.
-* 'nickname' - The user's nickname, defaults to the user's username.
-* 'first_name' - The user's first name.
-* 'last_name' - The user's last name.
-* 'description' - A string containing content about the user.
-* 'rich_editing' - A string for whether to enable the rich editor. False
-*		if not empty.
-* 'user_registered' - The date the user registered. Format is 'Y-m-d H:i:s'.
-* 'role' - A string used to set the user's role.
-* 'jabber' - User's Jabber account.
-* 'aim' - User's AOL IM account.
-* 'yim' - User's Yahoo IM account.
-*
 * @since 2.0.0
-* @uses $wpdb WordPress database layer.
+*
-* @uses apply_filters() Calls filters for most of the $userdata fields with the prefix 'pre_user'. See note above.
+* @global wpdb $wpdb WordPress database object for queries.
-* @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
+* @param array $userdata {
-*
+*     An array, object, or WP_User object of user data arguments.
-* @param mixed $userdata An array of user data or a user object of type stdClass or WP_User.
+*
-* @return int|WP_Error The newly created user's ID or a WP_Error object if the user could not be created.
+*     @type int         $ID              User ID. If supplied, the user will be updated.
+*     @type string      $user_pass       The plain-text user password.
+*     @type string      $user_login      The user's login username.
+*     @type string      $user_nicename   The URL-friendly user name.
+*     @type string      $user_url        The user URL.
+*     @type string      $user_email      The user email address.
+*     @type string      $display_name    The user's display name.
+*                                        Default is the the user's username.
+*     @type string      $nickname        The user's nickname. Default
+*                                        Default is the the user's username.
+*     @type string      $first_name      The user's first name. For new users, will be used
+*                                        to build $display_name if unspecified.
+*     @type stirng      $last_name       The user's last name. For new users, will be used
+*                                        to build $display_name if unspecified.
+*     @type string|bool $rich_editing    Whether to enable the rich-editor for the user. False
+*                                        if not empty.
+*     @type string      $user_registered Date the user registered. Format is 'Y-m-d H:i:s'.
+*     @type string      $role            User's role.
+*     @type string      $jabber          User's Jabber account username.
+*     @type string      $aim             User's AIM account username.
+*     @type string      $yim             User's Yahoo! messenger username.
+* }
+* @return int|WP_Error The newly created user's ID or a WP_Error object if the user could not
+*                      be created.
 */
 function wp_insert_user( $userdata ) {
 	global $wpdb;
-	if ( is_a( $userdata, 'stdClass' ) )
+	if ( $userdata instanceof stdClass ) {
 		$userdata = get_object_vars( $userdata );
-	elseif ( is_a( $userdata, 'WP_User' ) )
+	} elseif ( $userdata instanceof WP_User ) {
 		$userdata = $userdata->to_array();
+	}
-	extract( $userdata, EXTR_SKIP );
 	// Are we updating or creating?
-	if ( !empty($ID) ) {
+	if ( ! empty( $userdata['ID'] ) ) {
-		$ID = (int) $ID;
+		$ID = (int) $userdata['ID'];
 		$update = true;
 		$old_user_data = WP_User::get_data_by( 'id', $ID );
+		// hashed in wp_update_user(), plaintext if called directly
+		$user_pass = $userdata['user_pass'];
 	} else {
 		$update = false;
 		// Hash the password
-		$user_pass = wp_hash_password($user_pass);
+		$user_pass = wp_hash_password( $userdata['user_pass'] );
 	}
-	$user_login = sanitize_user($user_login, true);
+	$sanitized_user_login = sanitize_user( $userdata['user_login'], true );
-	$user_login = apply_filters('pre_user_login', $user_login);
+	/**
+	 * Filter a username after it has been sanitized.
+	 *
+	 * This filter is called before the user is created or updated.
+	 *
+	 * @since 2.0.3
+	 *
+	 * @param string $sanitized_user_login Username after it has been sanitized.
+	 */
+	$pre_user_login = apply_filters( 'pre_user_login', $sanitized_user_login );
 	//Remove any non-printable chars from the login string to see if we have ended up with an empty username
-	$user_login = trim($user_login);
+	$user_login = trim( $pre_user_login );
-	if ( empty($user_login) )
+	if ( empty( $user_login ) ) {
 		return new WP_Error('empty_user_login', __('Cannot create a user with an empty login name.') );
+	}
-	if ( !$update && username_exists( $user_login ) )
+	if ( ! $update && username_exists( $user_login ) ) {
 		return new WP_Error( 'existing_user_login', __( 'Sorry, that username already exists!' ) );
+	}
-	if ( empty($user_nicename) )
-		$user_nicename = sanitize_title( $user_login );
+	// If a nicename is provided, remove unsafe user characters before
-	$user_nicename = apply_filters('pre_user_nicename', $user_nicename);
+	// using it. Otherwise build a nicename from the user_login.
+	if ( ! empty( $userdata['user_nicename'] ) ) {
-	if ( empty($user_url) )
+		$user_nicename = sanitize_user( $userdata['user_nicename'], true );
-		$user_url = '';
+	} else {
-	$user_url = apply_filters('pre_user_url', $user_url);
+		$user_nicename = $user_login;
+	}
-	if ( empty($user_email) )
-		$user_email = '';
+	$user_nicename = sanitize_title( $user_nicename );
-	$user_email = apply_filters('pre_user_email', $user_email);
+	// Store values to save in user meta.
-	if ( !$update && ! defined( 'WP_IMPORTING' ) && email_exists($user_email) )
+	$meta = array();
+	/**
+	 * Filter a user's nicename before the user is created or updated.
+	 *
+	 * @since 2.0.3
+	 *
+	 * @param string $user_nicename The user's nicename.
+	 */
+	$user_nicename = apply_filters( 'pre_user_nicename', $user_nicename );
+	$raw_user_url = empty( $userdata['user_url'] ) ? '' : $userdata['user_url'];
+	/**
+	 * Filter a user's URL before the user is created or updated.
+	 *
+	 * @since 2.0.3
+	 *
+	 * @param string $raw_user_url The user's URL.
+	 */
+	$user_url = apply_filters( 'pre_user_url', $raw_user_url );
+	$raw_user_email = empty( $userdata['user_email'] ) ? '' : $userdata['user_email'];
+	/**
+	 * Filter a user's email before the user is created or updated.
+	 *
+	 * @since 2.0.3
+	 *
+	 * @param string $raw_user_email The user's email.
+	 */
+	$user_email = apply_filters( 'pre_user_email', $raw_user_email );
+	/*
+	 * If there is no update, just check for `email_exists`. If there is an update,
+	 * check if current email and new email are the same, or not, and check `email_exists`
+	 * accordingly.
+	 */
+	if ( ( ! $update || ( ! empty( $old_user_data ) && $user_email !== $old_user_data->user_email ) )
+		&& ! defined( 'WP_IMPORTING' )
+		&& email_exists( $user_email )
+	) {
 		return new WP_Error( 'existing_user_email', __( 'Sorry, that email address is already used!' ) );
+	}
-	if ( empty($nickname) )
+	$nickname = empty( $userdata['nickname'] ) ? $user_login : $userdata['nickname'];
-		$nickname = $user_login;
-	$nickname = apply_filters('pre_user_nickname', $nickname);
+	/**
+	 * Filter a user's nickname before the user is created or updated.
-	if ( empty($first_name) )
+	 *
-		$first_name = '';
+	 * @since 2.0.3
-	$first_name = apply_filters('pre_user_first_name', $first_name);
+	 *
+	 * @param string $nickname The user's nickname.
-	if ( empty($last_name) )
+	 */
-		$last_name = '';
+	$meta['nickname'] = apply_filters( 'pre_user_nickname', $nickname );
-	$last_name = apply_filters('pre_user_last_name', $last_name);
+	$first_name = empty( $userdata['first_name'] ) ? '' : $userdata['first_name'];
-	if ( empty( $display_name ) ) {
-		if ( $update )
+	/**
+	 * Filter a user's first name before the user is created or updated.
+	 *
+	 * @since 2.0.3
+	 *
+	 * @param string $first_name The user's first name.
+	 */
+	$meta['first_name'] = apply_filters( 'pre_user_first_name', $first_name );
+	$last_name = empty( $userdata['last_name'] ) ? '' : $userdata['last_name'];
+	/**
+	 * Filter a user's last name before the user is created or updated.
+	 *
+	 * @since 2.0.3
+	 *
+	 * @param string $last_name The user's last name.
+	 */
+	$meta['last_name'] = apply_filters( 'pre_user_last_name', $last_name );
+	if ( empty( $userdata['display_name'] ) ) {
+		if ( $update ) {
 			$display_name = $user_login;
-		elseif ( $first_name && $last_name )
+		} elseif ( $meta['first_name'] && $meta['last_name'] ) {
 			/* translators: 1: first name, 2: last name */
-			$display_name = sprintf( _x( '%1$s %2$s', 'Display name based on first name and last name' ), $first_name, $last_name );
+			$display_name = sprintf( _x( '%1$s %2$s', 'Display name based on first name and last name' ), $meta['first_name'], $meta['last_name'] );
-		elseif ( $first_name )
+		} elseif ( $meta['first_name'] ) {
-			$display_name = $first_name;
+			$display_name = $meta['first_name'];
-		elseif ( $last_name )
+		} elseif ( $meta['last_name'] ) {
-			$display_name = $last_name;
+			$display_name = $meta['last_name'];
-		else
+		} else {
 			$display_name = $user_login;
-	}
+		}
+	} else {
+		$display_name = $userdata['display_name'];
+	}
+	/**
+	 * Filter a user's display name before the user is created or updated.
+	 *
+	 * @since 2.0.3
+	 *
+	 * @param string $display_name The user's display name.
+	 */
 	$display_name = apply_filters( 'pre_user_display_name', $display_name );
-	if ( empty($description) )
+	$description = empty( $userdata['description'] ) ? '' : $userdata['description'];
-		$description = '';
-	$description = apply_filters('pre_user_description', $description);
+	/**
+	 * Filter a user's description before the user is created or updated.
-	if ( empty($rich_editing) )
+	 *
-		$rich_editing = 'true';
+	 * @since 2.0.3
+	 *
-	if ( empty($comment_shortcuts) )
+	 * @param string $description The user's description.
-		$comment_shortcuts = 'false';
+	 */
+	$meta['description'] = apply_filters( 'pre_user_description', $description );
-	if ( empty($admin_color) )
-		$admin_color = 'fresh';
+	$meta['rich_editing'] = empty( $userdata['rich_editing'] ) ? 'true' : $userdata['rich_editing'];
-	$admin_color = preg_replace('|[^a-z0-9 _.\-@]|i', '', $admin_color);
+	$meta['comment_shortcuts'] = empty( $userdata['comment_shortcuts'] ) ? 'false' : $userdata['comment_shortcuts'];
-	if ( empty($use_ssl) )
-		$use_ssl = 0;
+	$admin_color = empty( $userdata['admin_color'] ) ? 'fresh' : $userdata['admin_color'];
+	$meta['admin_color'] = preg_replace( '|[^a-z0-9 _.\-@]|i', '', $admin_color );
-	if ( empty($user_registered) )
-		$user_registered = gmdate('Y-m-d H:i:s');
+	$meta['use_ssl'] = empty( $userdata['use_ssl'] ) ? 0 : $userdata['use_ssl'];
-	if ( empty($show_admin_bar_front) )
+	$user_registered = empty( $userdata['user_registered'] ) ? gmdate( 'Y-m-d H:i:s' ) : $userdata['user_registered'];
-		$show_admin_bar_front = 'true';
+	$meta['show_admin_bar_front'] = empty( $userdata['show_admin_bar_front'] ) ? 'true' : $userdata['show_admin_bar_front'];
 	$user_nicename_check = $wpdb->get_var( $wpdb->prepare("SELECT ID FROM $wpdb->users WHERE user_nicename = %s AND user_login != %s LIMIT 1" , $user_nicename, $user_login));
 	if ( $user_nicename_check ) {
 		$suffix = 2;
 			$suffix++;
 		}
 		$user_nicename = $alt_user_nicename;
 	}
-	$data = compact( 'user_pass', 'user_email', 'user_url', 'user_nicename', 'display_name', 'user_registered' );
+	$compacted = compact( 'user_pass', 'user_email', 'user_url', 'user_nicename', 'display_name', 'user_registered' );
-	$data = wp_unslash( $data );
+	$data = wp_unslash( $compacted );
 	if ( $update ) {
+		if ( $user_email !== $old_user_data->user_email ) {
+			$data['user_activation_key'] = '';
+		}
 		$wpdb->update( $wpdb->users, $data, compact( 'ID' ) );
 		$user_id = (int) $ID;
 	} else {
 		$wpdb->insert( $wpdb->users, $data + compact( 'user_login' ) );
 		$user_id = (int) $wpdb->insert_id;
 	}
 	$user = new WP_User( $user_id );
-	foreach ( _get_additional_user_keys( $user ) as $key ) {
+	// Update user meta.
-		if ( isset( $$key ) )
+	foreach ( $meta as $key => $value ) {
-			update_user_meta( $user_id, $key, $$key );
+		update_user_meta( $user_id, $key, $value );
 	}
-	if ( isset($role) )
+	foreach ( wp_get_user_contact_methods( $user ) as $key => $value ) {
-		$user->set_role($role);
+		if ( isset( $userdata[ $key ] ) ) {
-	elseif ( !$update )
+			update_user_meta( $user_id, $key, $userdata[ $key ] );
+		}
+	}
+	if ( isset( $userdata['role'] ) ) {
+		$user->set_role( $userdata['role'] );
+	} elseif ( ! $update ) {
 		$user->set_role(get_option('default_role'));
+	}
-	wp_cache_delete($user_id, 'users');
+	wp_cache_delete( $user_id, 'users' );
-	wp_cache_delete($user_login, 'userlogins');
+	wp_cache_delete( $user_login, 'userlogins' );
-	if ( $update )
+	if ( $update ) {
-		do_action('profile_update', $user_id, $old_user_data);
+		/**
-	else
+		 * Fires immediately after an existing user is updated.
-		do_action('user_register', $user_id);
+		 *
+		 * @since 2.0.0
+		 *
+		 * @param int    $user_id       User ID.
+		 * @param object $old_user_data Object containing user's data prior to update.
+		 */
+		do_action( 'profile_update', $user_id, $old_user_data );
+	} else {
+		/**
+		 * Fires immediately after a new user is registered.
+		 *
+		 * @since 1.5.0
+		 *
+		 * @param int $user_id User ID.
+		 */
+		do_action( 'user_register', $user_id );
+	}
 	return $user_id;
 }
 /**
-* Update an user in the database.
+* Update a user in the database.
 *
 * It is possible to update a user's password by specifying the 'user_pass'
 * value in the $userdata parameter array.
 *
 * If current user's password is being updated, then the cookies will be
 * cleared.
 *
 * @since 2.0.0
-* @see wp_insert_user() For what fields can be set in $userdata
+*
-* @uses wp_insert_user() Used to update existing user or add new one if user doesn't exist already
+* @see wp_insert_user() For what fields can be set in $userdata.
 *
 * @param mixed $userdata An array of user data or a user object of type stdClass or WP_User.
 * @return int|WP_Error The updated user's ID or a WP_Error object if the user could not be updated.
 */
 function wp_update_user($userdata) {
-	if ( is_a( $userdata, 'stdClass' ) )
+	if ( $userdata instanceof stdClass ) {
 		$userdata = get_object_vars( $userdata );
-	elseif ( is_a( $userdata, 'WP_User' ) )
+	} elseif ( $userdata instanceof WP_User ) {
 		$userdata = $userdata->to_array();
+	}
-	$ID = (int) $userdata['ID'];
+	$ID = isset( $userdata['ID'] ) ? (int) $userdata['ID'] : 0;
+	if ( ! $ID ) {
+		return new WP_Error( 'invalid_user_id', __( 'Invalid user ID.' ) );
+	}
 	// First, get all of the original fields
 	$user_obj = get_userdata( $ID );
-	if ( ! $user_obj )
+	if ( ! $user_obj ) {
 		return new WP_Error( 'invalid_user_id', __( 'Invalid user ID.' ) );
+	}
 	$user = $user_obj->to_array();
 	// Add additional custom fields
 	foreach ( _get_additional_user_keys( $user_obj ) as $key ) {
 	// Update the cookies if the password changed.
 	$current_user = wp_get_current_user();
 	if ( $current_user->ID == $ID ) {
 		if ( isset($plaintext_pass) ) {
 			wp_clear_auth_cookie();
-			wp_set_auth_cookie($ID);
+			// Here we calculate the expiration length of the current auth cookie and compare it to the default expiration.
+			// If it's greater than this, then we know the user checked 'Remember Me' when they logged in.
+			$logged_in_cookie    = wp_parse_auth_cookie( '', 'logged_in' );
+			/** This filter is documented in wp-includes/pluggable.php */
+			$default_cookie_life = apply_filters( 'auth_cookie_expiration', ( 2 * DAY_IN_SECONDS ), $ID, false );
+			$remember            = ( ( $logged_in_cookie['expiration'] - time() ) > $default_cookie_life );
+			wp_set_auth_cookie( $ID, $remember );
 		}
 	}
 	return $user_id;
 }
 /**
-* A simpler way of inserting an user into the database.
+* A simpler way of inserting a user into the database.
 *
 * Creates a new user with just the username, password, and email. For more
-* complex user creation use wp_insert_user() to specify more information.
+* complex user creation use {@see wp_insert_user()} to specify more information.
 *
 * @since 2.0.0
 * @see wp_insert_user() More complete way to create a new user
 *
 * @param string $username The user's username.
 * @param string $password The user's password.
-* @param string $email The user's email (optional).
+* @param string $email    Optional. The user's email. Default empty.
 * @return int The new user's ID.
 */
 function wp_create_user($username, $password, $email = '') {
 	$user_login = wp_slash( $username );
 	$user_email = wp_slash( $email    );
 * Return a list of meta keys that wp_insert_user() is supposed to set.
 *
 * @since 3.3.0
 * @access private
 *
-* @param object $user WP_User instance.
+* @param WP_User $user WP_User instance.
 * @return array
 */
 function _get_additional_user_keys( $user ) {
 	$keys = array( 'first_name', 'last_name', 'nickname', 'description', 'rich_editing', 'comment_shortcuts', 'admin_color', 'use_ssl', 'show_admin_bar_front' );
 	return array_merge( $keys, array_keys( wp_get_user_contact_methods( $user ) ) );
 	 * Filter the user contact methods.
 	 *
 	 * @since 2.9.0
 	 *
 	 * @param array   $methods Array of contact methods and their labels.
-	 * @param WP_User $user    Optional. WP_User object.
+	 * @param WP_User $user    WP_User object.
 	 */
 	return apply_filters( 'user_contactmethods', $methods, $user );
 }
 /**
 * @since 2.9.0
 * @access private
 */
 function _wp_get_user_contactmethods( $user = null ) {
 	return wp_get_user_contact_methods( $user );
+}
+/**
+* Gets the text suggesting how to create strong passwords.
+*
+* @since 4.1.0
+*
+* @return string The password hint text.
+*/
+function wp_get_password_hint() {
+	$hint = __( 'Hint: The password should be at least seven characters long. To make it stronger, use upper and lower case letters, numbers, and symbols like ! " ? $ % ^ &amp; ).' );
+	/**
+	 * Filter the text describing the site's password complexity policy.
+	 *
+	 * @since 4.1.0
+	 *
+	 * @param string $hint The password hint text.
+	 */
+	return apply_filters( 'password_hint', $hint );
 }
 /**
 * Retrieves a user row based on password reset key and login
 *
 * A key is considered 'expired' if it exactly matches the value of the
 * user_activation_key field, rather than being matched after going through the
 * hashing process. This field is now hashed; old values are no longer accepted
 * but have a different WP_Error code so good user feedback can be provided.
 *
-* @uses $wpdb WordPress Database object
+* @global wpdb         $wpdb      WordPress database object for queries.
+* @global PasswordHash $wp_hasher Portable PHP password hashing framework instance.
 *
 * @param string $key       Hash to validate sending user's password.
 * @param string $login     The user login.
 * @return WP_User|WP_Error WP_User object on success, WP_Error object for invalid or expired keys.
 */
 	$row = $wpdb->get_row( $wpdb->prepare( "SELECT ID, user_activation_key FROM $wpdb->users WHERE user_login = %s", $login ) );
 	if ( ! $row )
 		return new WP_Error('invalid_key', __('Invalid key'));
 	if ( empty( $wp_hasher ) ) {
-		require_once ABSPATH . 'wp-includes/class-phpass.php';
+		require_once ABSPATH . WPINC . '/class-phpass.php';
 		$wp_hasher = new PasswordHash( 8, true );
 	}
 	if ( $wp_hasher->CheckPassword( $key, $row->user_activation_key ) )
 		return get_userdata( $row->ID );
 *
 * @param object $user The user
 * @param string $new_pass New password for the user in plaintext
 */
 function reset_password( $user, $new_pass ) {
+	/**
+	 * Fires before the user's password is reset.
+	 *
+	 * @since 1.5.0
+	 *
+	 * @param object $user     The user.
+	 * @param string $new_pass New user password.
+	 */
 	do_action( 'password_reset', $user, $new_pass );
 	wp_set_password( $new_pass, $user->ID );
 	update_user_option( $user->ID, 'default_password_nag', false, true );
 */
 function register_new_user( $user_login, $user_email ) {
 	$errors = new WP_Error();
 	$sanitized_user_login = sanitize_user( $user_login );
+	/**
+	 * Filter the email address of a user being registered.
+	 *
+	 * @since 2.1.0
+	 *
+	 * @param string $user_email The email address of the new user.
+	 */
 	$user_email = apply_filters( 'user_registration_email', $user_email );
 	// Check the username
 	if ( $sanitized_user_login == '' ) {
 		$errors->add( 'empty_username', __( '<strong>ERROR</strong>: Please enter a username.' ) );
 		$user_email = '';
 	} elseif ( email_exists( $user_email ) ) {
 		$errors->add( 'email_exists', __( '<strong>ERROR</strong>: This email is already registered, please choose another one.' ) );
 	}
+	/**
+	 * Fires when submitting registration form data, before the user is created.
+	 *
+	 * @since 2.1.0
+	 *
+	 * @param string   $sanitized_user_login The submitted username after being sanitized.
+	 * @param string   $user_email           The submitted email.
+	 * @param WP_Error $errors               Contains any errors with submitted username and email,
+	 *                                       e.g., an empty field, an invalid username or email,
+	 *                                       or an existing username or email.
+	 */
 	do_action( 'register_post', $sanitized_user_login, $user_email, $errors );
+	/**
+	 * Filter the errors encountered when a new user is being registered.
+	 *
+	 * The filtered WP_Error object may, for example, contain errors for an invalid
+	 * or existing username or email address. A WP_Error object should always returned,
+	 * but may or may not contain errors.
+	 *
+	 * If any errors are present in $errors, this will abort the user's registration.
+	 *
+	 * @since 2.1.0
+	 *
+	 * @param WP_Error $errors               A WP_Error object containing any errors encountered
+	 *                                       during registration.
+	 * @param string   $sanitized_user_login User's username after it has been sanitized.
+	 * @param string   $user_email           User's email.
+	 */
 	$errors = apply_filters( 'registration_errors', $errors, $sanitized_user_login, $user_email );
 	if ( $errors->get_error_code() )
 		return $errors;
 	wp_new_user_notification( $user_id, $user_pass );
 	return $user_id;
 }
+/**
+* Retrieve the current session token from the logged_in cookie.
+*
+* @since 4.0.0
+*
+* @return string Token.
+*/
+function wp_get_session_token() {
+	$cookie = wp_parse_auth_cookie( '', 'logged_in' );
+	return ! empty( $cookie['token'] ) ? $cookie['token'] : '';
+}
+/**
+* Retrieve a list of sessions for the current user.
+*
+* @since 4.0.0
+* @return array Array of sessions.
+*/
+function wp_get_all_sessions() {
+	$manager = WP_Session_Tokens::get_instance( get_current_user_id() );
+	return $manager->get_all();
+}
+/**
+* Remove the current session token from the database.
+*
+* @since 4.0.0
+*/
+function wp_destroy_current_session() {
+	$token = wp_get_session_token();
+	if ( $token ) {
+		$manager = WP_Session_Tokens::get_instance( get_current_user_id() );
+		$manager->destroy( $token );
+	}
+}
+/**
+* Remove all but the current session token for the current user for the database.
+*
+* @since 4.0.0
+*/
+function wp_destroy_other_sessions() {
+	$token = wp_get_session_token();
+	if ( $token ) {
+		$manager = WP_Session_Tokens::get_instance( get_current_user_id() );
+		$manager->destroy_others( $token );
+	}
+}
+/**
+* Remove all session tokens for the current user from the database.
+*
+* @since 4.0.0
+*/
+function wp_destroy_all_sessions() {
+	$manager = WP_Session_Tokens::get_instance( get_current_user_id() );
+	$manager->destroy_all();
+}

changeset 5	5e2f62d02dcd
parent 0	d970ebf37754
child 7	cf61fcea0001