X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/874d2a2f468a0d1e69aab49b1fe2d9d79d3e1142..16e7b37c7914d753890c1a05a9335f3b43751eb8:/wp-includes/user.php diff --git a/wp-includes/user.php b/wp-includes/user.php index 4244642c..02860638 100644 --- a/wp-includes/user.php +++ b/wp-includes/user.php @@ -1,13 +1,13 @@ ERROR: Invalid username. Lost your password?' ), wp_lostpassword_url() ) ); + if ( !$user ) { + return new WP_Error( 'invalid_username', + __( 'ERROR: Invalid username.' ) . + ' ' . + __( 'Lost your password?' ) . + '' + ); + } /** - * Filter whether the given user can be authenticated with the provided $password. + * Filters whether the given user can be authenticated with the provided $password. * * @since 2.5.0 * @@ -149,9 +159,90 @@ function wp_authenticate_username_password($user, $username, $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( __( 'ERROR: The password you entered for the username %1$s is incorrect. Lost your password?' ), - $username, wp_lostpassword_url() ) ); + if ( ! wp_check_password( $password, $user->user_pass, $user->ID ) ) { + return new WP_Error( 'incorrect_password', + sprintf( + /* translators: %s: user name */ + __( 'ERROR: The password you entered for the username %s is incorrect.' ), + '' . $username . '' + ) . + ' ' . + __( 'Lost your password?' ) . + '' + ); + } + + return $user; +} + +/** + * Authenticates a user using the email and password. + * + * @since 4.5.0 + * + * @param WP_User|WP_Error|null $user WP_User or WP_Error object if a previous + * callback failed authentication. + * @param string $email Email address for authentication. + * @param string $password Password for authentication. + * @return WP_User|WP_Error WP_User on success, WP_Error on failure. + */ +function wp_authenticate_email_password( $user, $email, $password ) { + if ( $user instanceof WP_User ) { + return $user; + } + + if ( empty( $email ) || empty( $password ) ) { + if ( is_wp_error( $user ) ) { + return $user; + } + + $error = new WP_Error(); + + if ( empty( $email ) ) { + $error->add( 'empty_username', __( 'ERROR: The email field is empty.' ) ); // Uses 'empty_username' for back-compat with wp_signon() + } + + if ( empty( $password ) ) { + $error->add( 'empty_password', __( 'ERROR: The password field is empty.' ) ); + } + + return $error; + } + + if ( ! is_email( $email ) ) { + return $user; + } + + $user = get_user_by( 'email', $email ); + + if ( ! $user ) { + return new WP_Error( 'invalid_email', + __( 'ERROR: Invalid email address.' ) . + ' ' . + __( 'Lost your password?' ) . + '' + ); + } + + /** This filter is documented in wp-includes/user.php */ + $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( + /* translators: %s: email address */ + __( 'ERROR: The password you entered for the email address %s is incorrect.' ), + '' . $email . '' + ) . + ' ' . + __( 'Lost your password?' ) . + '' + ); + } return $user; } @@ -161,13 +252,15 @@ function wp_authenticate_username_password($user, $username, $password) { * * @since 2.8.0 * + * @global string $auth_secure_cookie + * * @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' ) ) { + if ( $user instanceof WP_User ) { return $user; } @@ -202,16 +295,16 @@ function wp_authenticate_cookie($user, $username, $password) { * @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. + * Filters 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 ); + $spammed = apply_filters( 'check_is_user_spammed', is_user_spammy( $user ), $user ); if ( $spammed ) return new WP_Error( 'spammer_account', __( 'ERROR: Your account has been marked as a spammer.' ) ); @@ -220,19 +313,19 @@ function wp_authenticate_spam_check( $user ) { } /** - * Validate the logged-in cookie. + * Validates 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. + * This is a callback for the {@see 'determine_current_user'} filter, rather than API. * * @since 3.9.0 * - * @param int|bool $user The user ID (or false) as received from the + * @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. + * @return int|false 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 ) { @@ -250,28 +343,37 @@ function wp_validate_logged_in_cookie( $user_id ) { * Number of posts user has written. * * @since 3.0.0 + * @since 4.1.0 Added `$post_type` argument. + * @since 4.3.0 Added `$public_only` argument. Added the ability to pass an array + * of post types to `$post_type`. * - * @global wpdb $wpdb WordPress database object for queries. + * @global wpdb $wpdb WordPress database abstraction object. * - * @param int $userid User ID. - * @return int Amount of posts user has written. + * @param int $userid User ID. + * @param array|string $post_type Optional. Single post type or array of post types to count the number of posts for. Default 'post'. + * @param bool $public_only Optional. Whether to only return counts for public posts. Default false. + * @return string Number of posts the user has written in this post type. */ -function count_user_posts($userid) { +function count_user_posts( $userid, $post_type = 'post', $public_only = false ) { global $wpdb; - $where = get_posts_by_author_sql('post', true, $userid); + $where = get_posts_by_author_sql( $post_type, true, $userid, $public_only ); $count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->posts $where" ); /** - * Filter the number of posts a user has written. + * Filters the number of posts a user has written. * * @since 2.7.0 + * @since 4.1.0 Added `$post_type` argument. + * @since 4.3.1 Added `$public_only` argument. * - * @param int $count The user's post count. - * @param int $userid User ID. + * @param int $count The user's post count. + * @param int $userid User ID. + * @param string|array $post_type Single post type or array of post types to count the number of posts for. + * @param bool $public_only Whether to limit counted posts to public posts. */ - return apply_filters( 'get_usernumposts', $count, $userid ); + return apply_filters( 'get_usernumposts', $count, $userid, $post_type, $public_only ); } /** @@ -279,9 +381,11 @@ function count_user_posts($userid) { * * @since 3.0.0 * - * @param array $users Array of user IDs. - * @param string $post_type Optional. Post type to check. Defaults to post. - * @param bool $public_only Optional. Only return counts for public posts. Defaults to false. + * @global wpdb $wpdb WordPress database abstraction object. + * + * @param array $users Array of user IDs. + * @param string|array $post_type Optional. Single post type or array of post types to check. Defaults to 'post'. + * @param bool $public_only Optional. Only return counts for public posts. Defaults to false. * @return array Amount of posts each user has written. */ function count_many_users_posts( $users, $post_type = 'post', $public_only = false ) { @@ -316,8 +420,6 @@ function count_many_users_posts( $users, $post_type = 'post', $public_only = fal * * @since MU * - * @uses wp_get_current_user - * * @return int The current user's ID */ function get_current_user_id() { @@ -339,18 +441,18 @@ function get_current_user_id() { * * @since 2.0.0 * - * @global wpdb $wpdb WordPress database object for queries. + * @global wpdb $wpdb WordPress database abstraction object. * * @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. + * @param string $deprecated Use get_option() to check for an option in the options table. * @return mixed User option value on success, false on failure. */ function get_user_option( $option, $user = 0, $deprecated = '' ) { global $wpdb; if ( !empty( $deprecated ) ) - _deprecated_argument( __FUNCTION__, '3.0' ); + _deprecated_argument( __FUNCTION__, '3.0.0' ); if ( empty( $user ) ) $user = get_current_user_id(); @@ -367,9 +469,9 @@ function get_user_option( $option, $user = 0, $deprecated = '' ) { $result = false; /** - * Filter a specific user option value. + * Filters a specific user option value. * - * The dynamic portion of the hook name, $option, refers to the user option name. + * The dynamic portion of the hook name, `$option`, refers to the user option name. * * @since 2.5.0 * @@ -391,7 +493,7 @@ function get_user_option( $option, $user = 0, $deprecated = '' ) { * * @since 2.0.0 * - * @global wpdb $wpdb WordPress database object for queries. + * @global wpdb $wpdb WordPress database abstraction object. * * @param int $user_id User ID. * @param string $option_name User option name. @@ -419,7 +521,7 @@ function update_user_option( $user_id, $option_name, $newvalue, $global = false * * @since 3.0.0 * - * @global wpdb $wpdb WordPress database object for queries. + * @global wpdb $wpdb WordPress database abstraction object. * * @param int $user_id User ID * @param string $option_name User option name. @@ -435,498 +537,15 @@ function delete_user_option( $user_id, $option_name, $global = false ) { return delete_user_meta( $user_id, $option_name ); } -/** - * WordPress User Query class. - * - * @since 3.1.0 - */ -class WP_User_Query { - - /** - * Query vars, after parsing - * - * @since 3.5.0 - * @access public - * @var array - */ - public $query_vars = array(); - - /** - * List of found user ids - * - * @since 3.1.0 - * @access private - * @var array - */ - private $results; - - /** - * Total number of found users for the current query - * - * @since 3.1.0 - * @access private - * @var int - */ - private $total_users = 0; - - // SQL clauses - public $query_fields; - public $query_from; - public $query_where; - public $query_orderby; - public $query_limit; - - /** - * PHP5 constructor. - * - * @since 3.1.0 - * - * @param string|array $args Optional. The query variables. - * @return WP_User_Query - */ - public function __construct( $query = null ) { - if ( ! empty( $query ) ) { - $this->prepare_query( $query ); - $this->query(); - } - } - - /** - * Prepare the query variables. - * - * @since 3.1.0 - * - * @param string|array $args Optional. The query variables. - */ - 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' => '', - 'meta_compare' => '', - 'include' => array(), - 'exclude' => array(), - 'search' => '', - 'search_columns' => array(), - 'orderby' => 'login', - 'order' => 'ASC', - 'offset' => '', - 'number' => '', - 'count_total' => true, - 'fields' => 'all', - 'who' => '' - ) ); - } - - /** - * Fires before the WP_User_Query has been parsed. - * - * The passed WP_User_Query object contains the query variables, not - * yet passed into SQL. - * - * @since 4.0.0 - * - * @param WP_User_Query $this The current WP_User_Query instance, - * passed by reference. - */ - do_action( 'pre_get_users', $this ); - - $qv =& $this->query_vars; - - if ( is_array( $qv['fields'] ) ) { - $qv['fields'] = array_unique( $qv['fields'] ); - - $this->query_fields = array(); - foreach ( $qv['fields'] as $field ) { - $field = 'ID' === $field ? 'ID' : sanitize_key( $field ); - $this->query_fields[] = "$wpdb->users.$field"; - } - $this->query_fields = implode( ',', $this->query_fields ); - } elseif ( 'all' == $qv['fields'] ) { - $this->query_fields = "$wpdb->users.*"; - } else { - $this->query_fields = "$wpdb->users.ID"; - } - - if ( isset( $qv['count_total'] ) && $qv['count_total'] ) - $this->query_fields = 'SQL_CALC_FOUND_ROWS ' . $this->query_fields; - - $this->query_from = "FROM $wpdb->users"; - $this->query_where = "WHERE 1=1"; - - // sorting - if ( isset( $qv['orderby'] ) ) { - if ( in_array( $qv['orderby'], array('nicename', 'email', 'url', 'registered') ) ) { - $orderby = 'user_' . $qv['orderby']; - } elseif ( in_array( $qv['orderby'], array('user_nicename', 'user_email', 'user_url', 'user_registered') ) ) { - $orderby = $qv['orderby']; - } elseif ( 'name' == $qv['orderby'] || 'display_name' == $qv['orderby'] ) { - $orderby = 'display_name'; - } elseif ( 'post_count' == $qv['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' == $qv['orderby'] || 'id' == $qv['orderby'] ) { - $orderby = 'ID'; - } elseif ( 'meta_value' == $qv['orderby'] ) { - $orderby = "$wpdb->usermeta.meta_value"; - } else { - $orderby = 'user_login'; - } - } - - if ( empty( $orderby ) ) - $orderby = 'user_login'; - - $qv['order'] = isset( $qv['order'] ) ? strtoupper( $qv['order'] ) : ''; - if ( 'ASC' == $qv['order'] ) - $order = 'ASC'; - else - $order = 'DESC'; - $this->query_orderby = "ORDER BY $orderby $order"; - - // limit - if ( isset( $qv['number'] ) && $qv['number'] ) { - if ( $qv['offset'] ) - $this->query_limit = $wpdb->prepare("LIMIT %d, %d", $qv['offset'], $qv['number']); - else - $this->query_limit = $wpdb->prepare("LIMIT %d", $qv['number']); - } - - $search = ''; - if ( isset( $qv['search'] ) ) - $search = trim( $qv['search'] ); - - if ( $search ) { - $leading_wild = ( ltrim($search, '*') != $search ); - $trailing_wild = ( rtrim($search, '*') != $search ); - if ( $leading_wild && $trailing_wild ) - $wild = 'both'; - elseif ( $leading_wild ) - $wild = 'leading'; - elseif ( $trailing_wild ) - $wild = 'trailing'; - else - $wild = false; - if ( $wild ) - $search = trim($search, '*'); - - $search_columns = array(); - if ( $qv['search_columns'] ) - $search_columns = array_intersect( $qv['search_columns'], array( 'ID', 'user_login', 'user_email', 'user_url', 'user_nicename' ) ); - if ( ! $search_columns ) { - if ( false !== strpos( $search, '@') ) - $search_columns = array('user_email'); - elseif ( is_numeric($search) ) - $search_columns = array('user_login', 'ID'); - elseif ( preg_match('|^https?://|', $search) && ! ( is_multisite() && wp_is_large_network( 'users' ) ) ) - $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 ( 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 - } - - $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( $qv['meta_query'] ) || ! in_array( $cap_meta_query, $qv['meta_query'], true ) ) { - $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)"; - } - - /** - * 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. - * - * @since 3.1.0 - * - * @global wpdb $wpdb WordPress database object for queries. - */ - 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( $query ); - } else { - $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 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; - - if ( 'all_with_meta' == $qv['fields'] ) { - cache_users( $this->results ); - - $r = array(); - foreach ( $this->results as $userid ) - $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 ); - } - } - } - - /** - * Retrieve query variable. - * - * @since 3.5.0 - * @access public - * - * @param string $query_var Query variable key. - * @return mixed - */ - public function get( $query_var ) { - if ( isset( $this->query_vars[$query_var] ) ) - return $this->query_vars[$query_var]; - - return null; - } - - /** - * Set query variable. - * - * @since 3.5.0 - * @access public - * - * @param string $query_var Query variable key. - * @param mixed $value Query variable 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 string $string - * @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 - */ - protected function get_search_sql( $string, $cols, $wild = false ) { - 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 ) { - $searches[] = $wpdb->prepare( "$col = %s", $string ); - } else { - $searches[] = $wpdb->prepare( "$col LIKE %s", $like ); - } - } - - return ' AND (' . implode(' OR ', $searches) . ')'; - } - - /** - * Return the list of users. - * - * @since 3.1.0 - * @access public - * - * @return array Array of results. - */ - public function get_results() { - return $this->results; - } - - /** - * Return the total number of users for the current query. - * - * @since 3.1.0 - * @access public - * - * @return array Array of total users. - */ - public function get_total() { - return $this->total_users; - } - - /** - * 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 ) { - return $this->$name; - } - - /** - * Make private properties settable for backwards compatibility. - * - * @since 4.0.0 - * @access public - * - * @param string $name Property to set. - * @param mixed $value Property value. - * @return mixed Newly-set property. - */ - public function __set( $name, $value ) { - 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 ) { - 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 ) { - 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 ) { - return call_user_func_array( array( $this, $name ), $arguments ); - } -} - /** * Retrieve list of users matching criteria. * * @since 3.1.0 * - * @uses WP_User_Query See for default arguments and information. + * @see WP_User_Query * - * @param array $args Optional. Array of arguments. + * @param array $args Optional. Arguments to retrieve users. See WP_User_Query::prepare_query(). + * for more information on accepted arguments. * @return array List of users. */ function get_users( $args = array() ) { @@ -940,63 +559,70 @@ function get_users( $args = array() ) { } /** - * Get the blogs a user belongs to. + * Get the sites a user belongs to. * * @since 3.0.0 + * @since 4.7.0 Converted to use get_sites(). * - * @global wpdb $wpdb WordPress database object for queries. + * @global wpdb $wpdb WordPress database abstraction object. * * @param int $user_id User ID - * @param bool $all Whether to retrieve all blogs, or only blogs that are not + * @param bool $all Whether to retrieve all sites, or only sites 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. + * @return array A list of the user's sites. An empty array if the user doesn't exist + * or belongs to no sites. */ function get_blogs_of_user( $user_id, $all = false ) { global $wpdb; $user_id = (int) $user_id; - // Logged out users can't have blogs + // Logged out users can't have sites if ( empty( $user_id ) ) return array(); + /** + * Filters the list of a user's sites before it is populated. + * + * Passing a non-null value to the filter will effectively short circuit + * get_blogs_of_user(), returning that value instead. + * + * @since 4.6.0 + * + * @param null|array $sites An array of site objects of which the user is a member. + * @param int $user_id User ID. + * @param bool $all Whether the returned array should contain all sites, including + * those marked 'deleted', 'archived', or 'spam'. Default false. + */ + $sites = apply_filters( 'pre_get_blogs_of_user', null, $user_id, $all ); + + if ( null !== $sites ) { + return $sites; + } + $keys = get_user_meta( $user_id ); if ( empty( $keys ) ) return array(); if ( ! is_multisite() ) { - $blog_id = get_current_blog_id(); - $blogs = array( $blog_id => new stdClass ); - $blogs[ $blog_id ]->userblog_id = $blog_id; - $blogs[ $blog_id ]->blogname = get_option('blogname'); - $blogs[ $blog_id ]->domain = ''; - $blogs[ $blog_id ]->path = ''; - $blogs[ $blog_id ]->site_id = 1; - $blogs[ $blog_id ]->siteurl = get_option('siteurl'); - $blogs[ $blog_id ]->archived = 0; - $blogs[ $blog_id ]->spam = 0; - $blogs[ $blog_id ]->deleted = 0; - return $blogs; + $site_id = get_current_blog_id(); + $sites = array( $site_id => new stdClass ); + $sites[ $site_id ]->userblog_id = $site_id; + $sites[ $site_id ]->blogname = get_option('blogname'); + $sites[ $site_id ]->domain = ''; + $sites[ $site_id ]->path = ''; + $sites[ $site_id ]->site_id = 1; + $sites[ $site_id ]->siteurl = get_option('siteurl'); + $sites[ $site_id ]->archived = 0; + $sites[ $site_id ]->spam = 0; + $sites[ $site_id ]->deleted = 0; + return $sites; } - $blogs = array(); + $site_ids = array(); if ( isset( $keys[ $wpdb->base_prefix . 'capabilities' ] ) && defined( 'MULTISITE' ) ) { - $blog = get_blog_details( 1 ); - if ( $blog && isset( $blog->domain ) && ( $all || ( ! $blog->archived && ! $blog->spam && ! $blog->deleted ) ) ) { - $blogs[ 1 ] = (object) array( - 'userblog_id' => 1, - 'blogname' => $blog->blogname, - 'domain' => $blog->domain, - 'path' => $blog->path, - 'site_id' => $blog->site_id, - 'siteurl' => $blog->siteurl, - 'archived' => 0, - 'spam' => 0, - 'deleted' => 0 - ); - } + $site_ids[] = 1; unset( $keys[ $wpdb->base_prefix . 'capabilities' ] ); } @@ -1007,62 +633,119 @@ function get_blogs_of_user( $user_id, $all = false ) { continue; if ( $wpdb->base_prefix && 0 !== strpos( $key, $wpdb->base_prefix ) ) continue; - $blog_id = str_replace( array( $wpdb->base_prefix, '_capabilities' ), '', $key ); - if ( ! is_numeric( $blog_id ) ) + $site_id = str_replace( array( $wpdb->base_prefix, '_capabilities' ), '', $key ); + if ( ! is_numeric( $site_id ) ) continue; - $blog_id = (int) $blog_id; - $blog = get_blog_details( $blog_id ); - if ( $blog && isset( $blog->domain ) && ( $all || ( ! $blog->archived && ! $blog->spam && ! $blog->deleted ) ) ) { - $blogs[ $blog_id ] = (object) array( - 'userblog_id' => $blog_id, - 'blogname' => $blog->blogname, - 'domain' => $blog->domain, - 'path' => $blog->path, - 'site_id' => $blog->site_id, - 'siteurl' => $blog->siteurl, - 'archived' => 0, - 'spam' => 0, - 'deleted' => 0 + $site_ids[] = (int) $site_id; + } + + $sites = array(); + + if ( ! empty( $site_ids ) ) { + $args = array( + 'number' => '', + 'site__in' => $site_ids, + ); + if ( ! $all ) { + $args['archived'] = 0; + $args['spam'] = 0; + $args['deleted'] = 0; + } + + $_sites = get_sites( $args ); + + foreach ( $_sites as $site ) { + $sites[ $site->id ] = (object) array( + 'userblog_id' => $site->id, + 'blogname' => $site->blogname, + 'domain' => $site->domain, + 'path' => $site->path, + 'site_id' => $site->network_id, + 'siteurl' => $site->siteurl, + 'archived' => $site->archived, + 'mature' => $site->mature, + 'spam' => $site->spam, + 'deleted' => $site->deleted, ); } } /** - * Filter the list of blogs a user belongs to. + * Filters the list of sites a user belongs to. * * @since MU * - * @param array $blogs An array of blog objects belonging to the user. + * @param array $sites An array of site objects belonging to the user. * @param int $user_id User ID. - * @param bool $all Whether the returned blogs array should contain all blogs, including + * @param bool $all Whether the returned sites array should contain all sites, including * those marked 'deleted', 'archived', or 'spam'. Default false. */ - return apply_filters( 'get_blogs_of_user', $blogs, $user_id, $all ); + return apply_filters( 'get_blogs_of_user', $sites, $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 */ function is_user_member_of_blog( $user_id = 0, $blog_id = 0 ) { + global $wpdb; + $user_id = (int) $user_id; $blog_id = (int) $blog_id; - if ( empty( $user_id ) ) + if ( empty( $user_id ) ) { $user_id = get_current_user_id(); + } - if ( empty( $blog_id ) ) + // Technically not needed, but does save calls to get_site and get_user_meta + // in the event that the function is called when a user isn't logged in + if ( empty( $user_id ) ) { + return false; + } else { + $user = get_userdata( $user_id ); + if ( ! $user instanceof WP_User ) { + return false; + } + } + + if ( ! is_multisite() ) { + return true; + } + + if ( empty( $blog_id ) ) { $blog_id = get_current_blog_id(); + } - $blogs = get_blogs_of_user( $user_id ); - return array_key_exists( $blog_id, $blogs ); + $blog = get_site( $blog_id ); + + if ( ! $blog || ! isset( $blog->domain ) || $blog->archived || $blog->spam || $blog->deleted ) { + return false; + } + + $keys = get_user_meta( $user_id ); + if ( empty( $keys ) ) { + return false; + } + + // no underscore before capabilities in $base_capabilities_key + $base_capabilities_key = $wpdb->base_prefix . 'capabilities'; + $site_capabilities_key = $wpdb->base_prefix . $blog_id . '_capabilities'; + + if ( isset( $keys[ $base_capabilities_key ] ) && $blog_id == 1 ) { + return true; + } + + if ( isset( $keys[ $site_capabilities_key ] ) ) { + return true; + } + + return false; } /** @@ -1071,14 +754,13 @@ function is_user_member_of_blog( $user_id = 0, $blog_id = 0 ) { * Post meta data is called "Custom Fields" on the Administration Screens. * * @since 3.0.0 - * @uses add_metadata() - * @link http://codex.wordpress.org/Function_Reference/add_user_meta - * - * @param int $user_id User 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. + * @link https://codex.wordpress.org/Function_Reference/add_user_meta + * + * @param int $user_id User 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|false Meta ID on success, false on failure. */ function add_user_meta($user_id, $meta_key, $meta_value, $unique = false) { return add_metadata('user', $user_id, $meta_key, $meta_value, $unique); @@ -1092,12 +774,11 @@ function add_user_meta($user_id, $meta_key, $meta_value, $unique = false) { * allows removing all metadata matching key, if needed. * * @since 3.0.0 - * @uses delete_metadata() - * @link http://codex.wordpress.org/Function_Reference/delete_user_meta + * @link https://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. + * @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. */ function delete_user_meta($user_id, $meta_key, $meta_value = '') { @@ -1108,14 +789,12 @@ function delete_user_meta($user_id, $meta_key, $meta_value = '') { * Retrieve user meta field for a user. * * @since 3.0.0 - * @uses get_metadata() - * @link http://codex.wordpress.org/Function_Reference/get_user_meta - * - * @param int $user_id User 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. + * @link https://codex.wordpress.org/Function_Reference/get_user_meta + * + * @param int $user_id User 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. */ function get_user_meta($user_id, $key = '', $single = false) { return get_metadata('user', $user_id, $key, $single); @@ -1130,13 +809,12 @@ function get_user_meta($user_id, $key = '', $single = false) { * If the meta field for the user does not exist, it will be added. * * @since 3.0.0 - * @uses update_metadata - * @link http://codex.wordpress.org/Function_Reference/update_user_meta + * @link https://codex.wordpress.org/Function_Reference/update_user_meta * - * @param int $user_id User ID. - * @param string $meta_key Metadata key. - * @param mixed $meta_value Metadata value. - * @param mixed $prev_value Optional. Previous value to check before removing. + * @param int $user_id User 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 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 = '') { @@ -1152,11 +830,15 @@ function update_user_meta($user_id, $meta_key, $meta_value, $prev_value = '') { * Using $strategy = 'memory' this is memory-intensive and should handle around 10^5 users, but see WP Bug #12257. * * @since 3.0.0 + * @since 4.4.0 The number of users with no role is now included in the `none` element. + * + * @global wpdb $wpdb WordPress database abstraction object. + * * @param string $strategy 'time' or 'memory' * @return array Includes a grand total and an array of counts indexed by role strings. */ function count_users($strategy = 'time') { - global $wpdb, $wp_roles; + global $wpdb; // Initialize $id = get_current_blog_id(); @@ -1164,18 +846,14 @@ function count_users($strategy = 'time') { $result = array(); if ( 'time' == $strategy ) { - global $wp_roles; - - if ( ! isset( $wp_roles ) ) - $wp_roles = new WP_Roles(); - - $avail_roles = $wp_roles->get_names(); + $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[] = $wpdb->prepare( "COUNT(NULLIF(`meta_value` LIKE %s, false))", '%' . $wpdb->esc_like( '"' . $this_role . '"' ) . '%'); } + $select_count[] = "COUNT(NULLIF(`meta_value` = 'a:0:{}', false))"; $select_count = implode(', ', $select_count); // Add the meta_value index to the selection list, then run the query. @@ -1191,13 +869,17 @@ function count_users($strategy = 'time') { } } + $role_counts['none'] = (int) $row[$col++]; + // Get the meta_value index from the end of the result set. $total_users = (int) $row[$col]; $result['total_users'] = $total_users; $result['avail_roles'] =& $role_counts; } else { - $avail_roles = array(); + $avail_roles = array( + 'none' => 0, + ); $users_of_blog = $wpdb->get_col( "SELECT meta_value FROM $wpdb->usermeta WHERE meta_key = '{$blog_prefix}capabilities'" ); @@ -1205,6 +887,9 @@ function count_users($strategy = 'time') { $b_roles = maybe_unserialize($caps_meta); if ( ! is_array( $b_roles ) ) continue; + if ( empty( $b_roles ) ) { + $avail_roles['none']++; + } foreach ( $b_roles as $b_role => $val ) { if ( isset($avail_roles[$b_role]) ) { $avail_roles[$b_role]++; @@ -1218,6 +903,10 @@ function count_users($strategy = 'time') { $result['avail_roles'] =& $avail_roles; } + if ( is_multisite() ) { + $result['avail_roles']['none'] = 0; + } + return $result; } @@ -1231,12 +920,13 @@ function count_users($strategy = 'time') { * Used by wp_set_current_user() for back compat. Might be deprecated in the future. * * @since 2.0.4 - * @global string $userdata User description. - * @global string $user_login The user username for logging in - * @global int $user_level The level of the user - * @global int $user_ID The ID of the user - * @global string $user_email The email address of the user - * @global string $user_url The url in the user's profile + * + * @global string $user_login The user username for logging in + * @global object $userdata User data. + * @global int $user_level The level of the user + * @global int $user_ID The ID of the user + * @global string $user_email The email address of the user + * @global string $user_url The url in the user's profile * @global string $user_identity The display name of the user * * @param int $for_user_id Optional. User ID to set up global data. @@ -1276,12 +966,12 @@ function setup_userdata($for_user_id = '') { * The available arguments are as follows: * * @since 2.3.0 - * - * @global wpdb $wpdb WordPress database object for queries. + * @since 4.5.0 Added the 'display_name_with_login' value for 'show'. + * @since 4.7.0 Added the `$role`, `$role__in`, and `$role__not_in` parameters. * * @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. + * 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. @@ -1302,9 +992,11 @@ function setup_userdata($for_user_id = '') { * 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 + * @type string $show User data to display. If the selected item is empty * then the 'user_login' will be displayed in parentheses. - * Accepts user fields. Default 'display_name'. + * Accepts any user field, or 'display_name_with_login' to show + * the display name with user_login in parentheses. + * 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. @@ -1316,8 +1008,15 @@ function setup_userdata($for_user_id = '') { * @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. + * @type string|array $role An array or a comma-separated list of role names that users must + * match to be included in results. Note that this is an inclusive + * list: users must match *each* role. Default empty. + * @type array $role__in An array of role names. Matched users must have at least one of + * these roles. Default empty array. + * @type array $role__not_in An array of role names to exclude. Users matching one or more of + * these roles will not be included in results. Default empty array. * } - * @return string|null Null on display. String of HTML content on retrieve. + * @return string String of HTML content. */ function wp_dropdown_users( $args = '' ) { $defaults = array( @@ -1326,20 +1025,44 @@ function wp_dropdown_users( $args = '' ) { 'include' => '', 'exclude' => '', 'multi' => 0, 'show' => 'display_name', 'echo' => 1, 'selected' => 0, 'name' => 'user', 'class' => '', 'id' => '', - 'blog_id' => $GLOBALS['blog_id'], 'who' => '', 'include_selected' => false, - 'option_none_value' => -1 + 'blog_id' => get_current_blog_id(), 'who' => '', 'include_selected' => false, + 'option_none_value' => -1, + 'role' => '', + 'role__in' => array(), + 'role__not_in' => array(), ); $defaults['selected'] = is_author() ? get_query_var( 'author' ) : 0; - $r = wp_parse_args( $args, $defaults ); - $show = $r['show']; + $r = wp_parse_args( $args, $defaults ); + + $query_args = wp_array_slice_assoc( $r, array( 'blog_id', 'include', 'exclude', 'orderby', 'order', 'who', 'role', 'role__in', 'role__not_in' ) ); + + $fields = array( 'ID', 'user_login' ); + + $show = ! empty( $r['show'] ) ? $r['show'] : 'display_name'; + if ( 'display_name_with_login' === $show ) { + $fields[] = 'display_name'; + } else { + $fields[] = $show; + } + + $query_args['fields'] = $fields; + $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 ); + /** + * Filters the query arguments for the list of users in the dropdown. + * + * @since 4.4.0 + * + * @param array $query_args The query arguments for get_users(). + * @param array $r The arguments passed to wp_dropdown_users() combined with the defaults. + */ + $query_args = apply_filters( 'wp_dropdown_users_args', $query_args, $r ); + $users = get_users( $query_args ); $output = ''; @@ -1361,21 +1084,32 @@ function wp_dropdown_users( $args = '' ) { $output .= "\t\n"; } - $found_selected = false; - foreach ( (array) $users as $user ) { - $user->ID = (int) $user->ID; - $_selected = selected( $user->ID, $r['selected'], false ); - if ( $_selected ) { - $found_selected = true; + if ( $r['include_selected'] && ( $r['selected'] > 0 ) ) { + $found_selected = false; + $r['selected'] = (int) $r['selected']; + foreach ( (array) $users as $user ) { + $user->ID = (int) $user->ID; + if ( $user->ID === $r['selected'] ) { + $found_selected = true; + } + } + + if ( ! $found_selected ) { + $users[] = get_userdata( $r['selected'] ); } - $display = ! empty( $user->$show ) ? $user->$show : '('. $user->user_login . ')'; - $output .= "\t\n"; } - if ( $r['include_selected'] && ! $found_selected && ( $r['selected'] > 0 ) ) { - $user = get_userdata( $r['selected'] ); + foreach ( (array) $users as $user ) { + if ( 'display_name_with_login' === $show ) { + /* translators: 1: display name, 2: user_login */ + $display = sprintf( _x( '%1$s (%2$s)', 'user dropdown' ), $user->display_name, $user->user_login ); + } elseif ( ! empty( $user->$show ) ) { + $display = $user->$show; + } else { + $display = '(' . $user->user_login . ')'; + } + $_selected = selected( $user->ID, $r['selected'], false ); - $display = ! empty( $user->$show ) ? $user->$show : '('. $user->user_login . ')'; $output .= "\t\n"; } @@ -1383,7 +1117,7 @@ function wp_dropdown_users( $args = '' ) { } /** - * Filter the wp_dropdown_users() HTML output. + * Filters the wp_dropdown_users() HTML output. * * @since 2.3.0 * @@ -1406,11 +1140,11 @@ function wp_dropdown_users( $args = '' ) { * * @since 2.3.0 * - * @param string $field The user Object field name. - * @param mixed $value The user Object value. - * @param int $user_id user ID. + * @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', - * 'attribute' and 'js'. + * 'attribute' and 'js'. * @return mixed Sanitized value. */ function sanitize_user_field($field, $value, $user_id, $context) { @@ -1434,9 +1168,9 @@ function sanitize_user_field($field, $value, $user_id, $context) { } else { /** - * Filter a user field value in the 'edit' context. + * Filters a user field value in the 'edit' context. * - * The dynamic portion of the hook name, $field, refers to the prefixed user + * 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 @@ -1451,16 +1185,16 @@ function sanitize_user_field($field, $value, $user_id, $context) { $value = esc_html( $value ); // textarea_escaped? else $value = esc_attr($value); - } else if ( 'db' == $context ) { + } elseif ( 'db' == $context ) { if ( $prefixed ) { /** This filter is documented in wp-includes/post.php */ $value = apply_filters( "pre_{$field}", $value ); } else { /** - * Filter the value of a user field in the 'db' context. + * Filters the value of a user field in the 'db' context. * - * The dynamic portion of the hook name, $field, refers to the prefixed user + * 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 @@ -1478,9 +1212,9 @@ function sanitize_user_field($field, $value, $user_id, $context) { } else { /** - * Filter the value of a user field in a standard context. + * Filters the value of a user field in a standard context. * - * The dynamic portion of the hook name, $field, refers to the prefixed user + * 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 @@ -1496,11 +1230,11 @@ function sanitize_user_field($field, $value, $user_id, $context) { if ( 'user_url' == $field ) $value = esc_url($value); - if ( 'attribute' == $context ) - $value = esc_attr($value); - else if ( 'js' == $context ) - $value = esc_js($value); - + if ( 'attribute' == $context ) { + $value = esc_attr( $value ); + } elseif ( 'js' == $context ) { + $value = esc_js( $value ); + } return $value; } @@ -1509,9 +1243,18 @@ function sanitize_user_field($field, $value, $user_id, $context) { * * @since 3.0.0 * - * @param object $user User object to be cached + * @param object|WP_User $user User object to be cached + * @return bool|null Returns false on failure. */ -function update_user_caches($user) { +function update_user_caches( $user ) { + if ( $user instanceof WP_User ) { + if ( ! $user->exists() ) { + return false; + } + + $user = $user->data; + } + wp_cache_add($user->ID, $user, 'users'); wp_cache_add($user->user_login, $user->ID, 'userlogins'); wp_cache_add($user->user_email, $user->ID, 'useremail'); @@ -1522,6 +1265,7 @@ function update_user_caches($user) { * Clean all user caches * * @since 3.0.0 + * @since 4.4.0 'clean_user_cache' action was added. * * @param WP_User|int $user User object or ID to be cleaned from the cache */ @@ -1536,6 +1280,16 @@ function clean_user_cache( $user ) { wp_cache_delete( $user->user_login, 'userlogins' ); wp_cache_delete( $user->user_email, 'useremail' ); wp_cache_delete( $user->user_nicename, 'userslugs' ); + + /** + * Fires immediately after the given user's cache is cleaned. + * + * @since 4.4.0 + * + * @param int $user_id User ID. + * @param WP_User $user User object. + */ + do_action( 'clean_user_cache', $user->ID, $user ); } /** @@ -1544,14 +1298,13 @@ function clean_user_cache( $user ) { * @since 2.0.0 * * @param string $username Username. - * @return null|int The user's ID on success, and null on failure. + * @return int|false The user's ID on success, and false on failure. */ function username_exists( $username ) { - if ( $user = get_user_by('login', $username ) ) { + if ( $user = get_user_by( 'login', $username ) ) { return $user->ID; - } else { - return null; } + return false; } /** @@ -1560,29 +1313,30 @@ function username_exists( $username ) { * @since 2.1.0 * * @param string $email Email. - * @return bool|int The user's ID on success, and false on failure. + * @return int|false The user's ID on success, and false on failure. */ function email_exists( $email ) { - if ( $user = get_user_by('email', $email) ) + if ( $user = get_user_by( 'email', $email) ) { return $user->ID; - + } 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 + * @since 4.4.0 Empty sanitized usernames are now considered invalid * * @param string $username Username. * @return bool Whether username given is valid */ function validate_username( $username ) { $sanitized = sanitize_user( $username, true ); - $valid = ( $sanitized == $username ); + $valid = ( $sanitized == $username && ! empty( $sanitized ) ); + /** - * Filter whether the provided username is valid or not. + * Filters whether the provided username is valid or not. * * @since 2.0.1 * @@ -1593,42 +1347,53 @@ function validate_username( $username ) { } /** - * Insert an user into the database. + * Insert a user into the database. * - * 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. + * Most of the `$userdata` array fields have filters associated with the values. Exceptions are + * 'ID', 'rich_editing', 'comment_shortcuts', 'admin_color', 'use_ssl', + * 'user_registered', and 'role'. 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. * * @since 2.0.0 + * @since 3.6.0 The `aim`, `jabber`, and `yim` fields were removed as default user contact + * methods for new installs. See wp_get_user_contact_methods(). + * @since 4.7.0 The user's locale can be passed to `$userdata`. * - * @global wpdb $wpdb WordPress database object for queries. + * @global wpdb $wpdb WordPress database abstraction object. * - * @param array $userdata { + * @param array|object|WP_User $userdata { * An array, object, or WP_User object of user data arguments. * - * @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 $date_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. + * @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 user's username. + * @type string $nickname The user's nickname. + * Default is the user's username. + * @type string $first_name The user's first name. For new users, will be used + * to build the first part of the user's display name + * if `$display_name` is not specified. + * @type string $last_name The user's last name. For new users, will be used + * to build the second part of the user's display name + * if `$display_name` is not specified. + * @type string $description The user's biographical description. + * @type string|bool $rich_editing Whether to enable the rich-editor for the user. + * False if not empty. + * @type string|bool $comment_shortcuts Whether to enable comment moderation keyboard + * shortcuts for the user. Default false. + * @type string $admin_color Admin color scheme for the user. Default 'fresh'. + * @type bool $use_ssl Whether the user should always access the admin over + * https. Default false. + * @type string $user_registered Date the user registered. Format is 'Y-m-d H:i:s'. + * @type string|bool $show_admin_bar_front Whether to display the Admin Bar for the user on the + * site's front end. Default true. + * @type string $role User's role. + * @type string $locale User's locale. Default empty. * } * @return int|WP_Error The newly created user's ID or a WP_Error object if the user could not * be created. @@ -1636,18 +1401,24 @@ function validate_username( $username ) { 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(); } + // Are we updating or creating? if ( ! empty( $userdata['ID'] ) ) { $ID = (int) $userdata['ID']; $update = true; - $old_user_data = WP_User::get_data_by( 'id', $ID ); + $old_user_data = get_userdata( $ID ); + + if ( ! $old_user_data ) { + return new WP_Error( 'invalid_user_id', __( 'Invalid user ID.' ) ); + } + // hashed in wp_update_user(), plaintext if called directly - $user_pass = $userdata['user_pass']; + $user_pass = ! empty( $userdata['user_pass'] ) ? $userdata['user_pass'] : $old_user_data->user_pass; } else { $update = false; // Hash the password @@ -1657,7 +1428,7 @@ function wp_insert_user( $userdata ) { $sanitized_user_login = sanitize_user( $userdata['user_login'], true ); /** - * Filter a username after it has been sanitized. + * Filters a username after it has been sanitized. * * This filter is called before the user is created or updated. * @@ -1670,23 +1441,50 @@ function wp_insert_user( $userdata ) { //Remove any non-printable chars from the login string to see if we have ended up with an empty username $user_login = trim( $pre_user_login ); + // user_login must be between 0 and 60 characters. if ( empty( $user_login ) ) { return new WP_Error('empty_user_login', __('Cannot create a user with an empty login name.') ); + } elseif ( mb_strlen( $user_login ) > 60 ) { + return new WP_Error( 'user_login_too_long', __( 'Username may not be longer than 60 characters.' ) ); } + if ( ! $update && username_exists( $user_login ) ) { return new WP_Error( 'existing_user_login', __( 'Sorry, that username already exists!' ) ); } - if ( empty( $userdata['user_nicename'] ) ) { - $user_nicename = sanitize_title( $user_login ); + + /** + * Filters the list of blacklisted usernames. + * + * @since 4.4.0 + * + * @param array $usernames Array of blacklisted usernames. + */ + $illegal_logins = (array) apply_filters( 'illegal_user_logins', array() ); + + if ( in_array( strtolower( $user_login ), array_map( 'strtolower', $illegal_logins ) ) ) { + return new WP_Error( 'invalid_username', __( 'Sorry, that username is not allowed.' ) ); + } + + /* + * If a nicename is provided, remove unsafe user characters before using it. + * Otherwise build a nicename from the user_login. + */ + if ( ! empty( $userdata['user_nicename'] ) ) { + $user_nicename = sanitize_user( $userdata['user_nicename'], true ); + if ( mb_strlen( $user_nicename ) > 50 ) { + return new WP_Error( 'user_nicename_too_long', __( 'Nicename may not be longer than 50 characters.' ) ); + } } else { - $user_nicename = $userdata['user_nicename']; + $user_nicename = mb_substr( $user_login, 0, 50 ); } + $user_nicename = sanitize_title( $user_nicename ); + // Store values to save in user meta. $meta = array(); /** - * Filter a user's nicename before the user is created or updated. + * Filters a user's nicename before the user is created or updated. * * @since 2.0.3 * @@ -1697,7 +1495,7 @@ function wp_insert_user( $userdata ) { $raw_user_url = empty( $userdata['user_url'] ) ? '' : $userdata['user_url']; /** - * Filter a user's URL before the user is created or updated. + * Filters a user's URL before the user is created or updated. * * @since 2.0.3 * @@ -1708,7 +1506,7 @@ function wp_insert_user( $userdata ) { $raw_user_email = empty( $userdata['user_email'] ) ? '' : $userdata['user_email']; /** - * Filter a user's email before the user is created or updated. + * Filters a user's email before the user is created or updated. * * @since 2.0.3 * @@ -1716,13 +1514,21 @@ function wp_insert_user( $userdata ) { */ $user_email = apply_filters( 'pre_user_email', $raw_user_email ); - if ( ! $update && ! defined( 'WP_IMPORTING' ) && email_exists( $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 ) && 0 !== strcasecmp( $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!' ) ); } $nickname = empty( $userdata['nickname'] ) ? $user_login : $userdata['nickname']; /** - * Filter a user's nickname before the user is created or updated. + * Filters a user's nickname before the user is created or updated. * * @since 2.0.3 * @@ -1733,7 +1539,7 @@ function wp_insert_user( $userdata ) { $first_name = empty( $userdata['first_name'] ) ? '' : $userdata['first_name']; /** - * Filter a user's first name before the user is created or updated. + * Filters a user's first name before the user is created or updated. * * @since 2.0.3 * @@ -1744,7 +1550,7 @@ function wp_insert_user( $userdata ) { $last_name = empty( $userdata['last_name'] ) ? '' : $userdata['last_name']; /** - * Filter a user's last name before the user is created or updated. + * Filters a user's last name before the user is created or updated. * * @since 2.0.3 * @@ -1770,7 +1576,7 @@ function wp_insert_user( $userdata ) { } /** - * Filter a user's display name before the user is created or updated. + * Filters a user's display name before the user is created or updated. * * @since 2.0.3 * @@ -1781,7 +1587,7 @@ function wp_insert_user( $userdata ) { $description = empty( $userdata['description'] ) ? '' : $userdata['description']; /** - * Filter a user's description before the user is created or updated. + * Filters a user's description before the user is created or updated. * * @since 2.0.3 * @@ -1791,7 +1597,7 @@ function wp_insert_user( $userdata ) { $meta['rich_editing'] = empty( $userdata['rich_editing'] ) ? 'true' : $userdata['rich_editing']; - $meta['comment_shortcuts'] = empty( $userdata['comment_shortcuts'] ) ? 'false' : $userdata['comment_shortcuts']; + $meta['comment_shortcuts'] = empty( $userdata['comment_shortcuts'] ) || 'false' === $userdata['comment_shortcuts'] ? 'false' : 'true'; $admin_color = empty( $userdata['admin_color'] ) ? 'fresh' : $userdata['admin_color']; $meta['admin_color'] = preg_replace( '|[^a-z0-9 _.\-@]|i', '', $admin_color ); @@ -1802,12 +1608,16 @@ function wp_insert_user( $userdata ) { $meta['show_admin_bar_front'] = empty( $userdata['show_admin_bar_front'] ) ? 'true' : $userdata['show_admin_bar_front']; + $meta['locale'] = isset( $userdata['locale'] ) ? $userdata['locale'] : ''; + $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; while ($user_nicename_check) { - $alt_user_nicename = $user_nicename . "-$suffix"; + // user_nicename allows 50 chars. Subtract one for a hyphen, plus the length of the suffix. + $base_length = 49 - mb_strlen( $suffix ); + $alt_user_nicename = mb_substr( $user_nicename, 0, $base_length ) . "-$suffix"; $user_nicename_check = $wpdb->get_var( $wpdb->prepare("SELECT ID FROM $wpdb->users WHERE user_nicename = %s AND user_login != %s LIMIT 1" , $alt_user_nicename, $user_login)); $suffix++; } @@ -1830,6 +1640,33 @@ function wp_insert_user( $userdata ) { $user = new WP_User( $user_id ); + /** + * Filters a user's meta values and keys before the user is created or updated. + * + * Does not include contact methods. These are added using `wp_get_user_contact_methods( $user )`. + * + * @since 4.4.0 + * + * @param array $meta { + * Default meta values and keys for the user. + * + * @type string $nickname The user's nickname. Default is the user's username. + * @type string $first_name The user's first name. + * @type string $last_name The user's last name. + * @type string $description The user's description. + * @type bool $rich_editing Whether to enable the rich-editor for the user. False if not empty. + * @type bool $comment_shortcuts Whether to enable keyboard shortcuts for the user. Default false. + * @type string $admin_color The color scheme for a user's admin screen. Default 'fresh'. + * @type int|bool $use_ssl Whether to force SSL on the user's admin area. 0|false if SSL is + * not forced. + * @type bool $show_admin_bar_front Whether to show the admin bar on the front end for the user. + * Default true. + * } + * @param WP_User $user User object. + * @param bool $update Whether the user is being updated rather than created. + */ + $meta = apply_filters( 'insert_user_meta', $meta, $user, $update ); + // Update user meta. foreach ( $meta as $key => $value ) { update_user_meta( $user_id, $key, $value ); @@ -1874,7 +1711,7 @@ function wp_insert_user( $userdata ) { } /** - * 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. @@ -1890,17 +1727,22 @@ function wp_insert_user( $userdata ) { * @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(); @@ -1912,17 +1754,173 @@ function wp_update_user($userdata) { // Escape data pulled from DB. $user = add_magic_quotes( $user ); - // If password is changing, hash it now. - if ( ! empty($userdata['user_pass']) ) { + if ( ! empty( $userdata['user_pass'] ) && $userdata['user_pass'] !== $user_obj->user_pass ) { + // If password is changing, hash it now $plaintext_pass = $userdata['user_pass']; - $userdata['user_pass'] = wp_hash_password($userdata['user_pass']); + $userdata['user_pass'] = wp_hash_password( $userdata['user_pass'] ); + + /** + * Filters whether to send the password change email. + * + * @since 4.3.0 + * + * @see wp_insert_user() For `$user` and `$userdata` fields. + * + * @param bool $send Whether to send the email. + * @param array $user The original user array. + * @param array $userdata The updated user array. + * + */ + $send_password_change_email = apply_filters( 'send_password_change_email', true, $user, $userdata ); + } + + if ( isset( $userdata['user_email'] ) && $user['user_email'] !== $userdata['user_email'] ) { + /** + * Filters whether to send the email change email. + * + * @since 4.3.0 + * + * @see wp_insert_user() For `$user` and `$userdata` fields. + * + * @param bool $send Whether to send the email. + * @param array $user The original user array. + * @param array $userdata The updated user array. + * + */ + $send_email_change_email = apply_filters( 'send_email_change_email', true, $user, $userdata ); } - wp_cache_delete($user[ 'user_email' ], 'useremail'); + wp_cache_delete( $user['user_email'], 'useremail' ); + wp_cache_delete( $user['user_nicename'], 'userslugs' ); // Merge old and new fields with new fields overwriting old ones. - $userdata = array_merge($user, $userdata); - $user_id = wp_insert_user($userdata); + $userdata = array_merge( $user, $userdata ); + $user_id = wp_insert_user( $userdata ); + + if ( ! is_wp_error( $user_id ) ) { + + $blog_name = wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES ); + + $switched_locale = false; + if ( ! empty( $send_password_change_email ) || ! empty( $send_email_change_email ) ) { + $switched_locale = switch_to_locale( get_user_locale( $user_id ) ); + } + + if ( ! empty( $send_password_change_email ) ) { + /* translators: Do not translate USERNAME, ADMIN_EMAIL, EMAIL, SITENAME, SITEURL: those are placeholders. */ + $pass_change_text = __( 'Hi ###USERNAME###, + +This notice confirms that your password was changed on ###SITENAME###. + +If you did not change your password, please contact the Site Administrator at +###ADMIN_EMAIL### + +This email has been sent to ###EMAIL### + +Regards, +All at ###SITENAME### +###SITEURL###' ); + + $pass_change_email = array( + 'to' => $user['user_email'], + /* translators: User password change notification email subject. 1: Site name */ + 'subject' => __( '[%s] Notice of Password Change' ), + 'message' => $pass_change_text, + 'headers' => '', + ); + + /** + * Filters the contents of the email sent when the user's password is changed. + * + * @since 4.3.0 + * + * @param array $pass_change_email { + * Used to build wp_mail(). + * @type string $to The intended recipients. Add emails in a comma separated string. + * @type string $subject The subject of the email. + * @type string $message The content of the email. + * The following strings have a special meaning and will get replaced dynamically: + * - ###USERNAME### The current user's username. + * - ###ADMIN_EMAIL### The admin email in case this was unexpected. + * - ###EMAIL### The old email. + * - ###SITENAME### The name of the site. + * - ###SITEURL### The URL to the site. + * @type string $headers Headers. Add headers in a newline (\r\n) separated string. + * } + * @param array $user The original user array. + * @param array $userdata The updated user array. + * + */ + $pass_change_email = apply_filters( 'password_change_email', $pass_change_email, $user, $userdata ); + + $pass_change_email['message'] = str_replace( '###USERNAME###', $user['user_login'], $pass_change_email['message'] ); + $pass_change_email['message'] = str_replace( '###ADMIN_EMAIL###', get_option( 'admin_email' ), $pass_change_email['message'] ); + $pass_change_email['message'] = str_replace( '###EMAIL###', $user['user_email'], $pass_change_email['message'] ); + $pass_change_email['message'] = str_replace( '###SITENAME###', $blog_name, $pass_change_email['message'] ); + $pass_change_email['message'] = str_replace( '###SITEURL###', home_url(), $pass_change_email['message'] ); + + wp_mail( $pass_change_email['to'], sprintf( $pass_change_email['subject'], $blog_name ), $pass_change_email['message'], $pass_change_email['headers'] ); + } + + if ( ! empty( $send_email_change_email ) ) { + /* translators: Do not translate USERNAME, ADMIN_EMAIL, EMAIL, SITENAME, SITEURL: those are placeholders. */ + $email_change_text = __( 'Hi ###USERNAME###, + +This notice confirms that your email was changed on ###SITENAME###. + +If you did not change your email, please contact the Site Administrator at +###ADMIN_EMAIL### + +This email has been sent to ###EMAIL### + +Regards, +All at ###SITENAME### +###SITEURL###' ); + + $email_change_email = array( + 'to' => $user['user_email'], + /* translators: User email change notification email subject. 1: Site name */ + 'subject' => __( '[%s] Notice of Email Change' ), + 'message' => $email_change_text, + 'headers' => '', + ); + + /** + * Filters the contents of the email sent when the user's email is changed. + * + * @since 4.3.0 + * + * @param array $email_change_email { + * Used to build wp_mail(). + * @type string $to The intended recipients. + * @type string $subject The subject of the email. + * @type string $message The content of the email. + * The following strings have a special meaning and will get replaced dynamically: + * - ###USERNAME### The current user's username. + * - ###ADMIN_EMAIL### The admin email in case this was unexpected. + * - ###EMAIL### The old email. + * - ###SITENAME### The name of the site. + * - ###SITEURL### The URL to the site. + * @type string $headers Headers. + * } + * @param array $user The original user array. + * @param array $userdata The updated user array. + */ + $email_change_email = apply_filters( 'email_change_email', $email_change_email, $user, $userdata ); + + $email_change_email['message'] = str_replace( '###USERNAME###', $user['user_login'], $email_change_email['message'] ); + $email_change_email['message'] = str_replace( '###ADMIN_EMAIL###', get_option( 'admin_email' ), $email_change_email['message'] ); + $email_change_email['message'] = str_replace( '###EMAIL###', $user['user_email'], $email_change_email['message'] ); + $email_change_email['message'] = str_replace( '###SITENAME###', $blog_name, $email_change_email['message'] ); + $email_change_email['message'] = str_replace( '###SITEURL###', home_url(), $email_change_email['message'] ); + + wp_mail( $email_change_email['to'], sprintf( $email_change_email['subject'], $blog_name ), $email_change_email['message'], $email_change_email['headers'] ); + } + + if ( $switched_locale ) { + restore_previous_locale(); + } + } // Update the cookies if the password changed. $current_user = wp_get_current_user(); @@ -1945,7 +1943,7 @@ function wp_update_user($userdata) { } /** - * 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. @@ -1955,8 +1953,9 @@ function wp_update_user($userdata) { * * @param string $username The user's username. * @param string $password The user's password. - * @param string $email The user's email (optional). - * @return int The new user's ID. + * @param string $email Optional. The user's email. Default empty. + * @return int|WP_Error The newly created user's ID or a WP_Error object if the user could not + * be created. */ function wp_create_user($username, $password, $email = '') { $user_login = wp_slash( $username ); @@ -1968,16 +1967,19 @@ function wp_create_user($username, $password, $email = '') { } /** - * Return a list of meta keys that wp_insert_user() is supposed to set. + * Returns a list of meta keys to be (maybe) populated in wp_update_user(). + * + * The list of keys returned via this function are dependent on the presence + * of those keys in the user meta data to be set. * * @since 3.3.0 * @access private * - * @param object $user WP_User instance. - * @return array + * @param WP_User $user WP_User instance. + * @return array List of user keys to be populated in wp_update_user(). */ 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' ); + $keys = array( 'first_name', 'last_name', 'nickname', 'description', 'rich_editing', 'comment_shortcuts', 'admin_color', 'use_ssl', 'show_admin_bar_front', 'locale' ); return array_merge( $keys, array_keys( wp_get_user_contact_methods( $user ) ) ); } @@ -2002,7 +2004,7 @@ function wp_get_user_contact_methods( $user = null ) { } /** - * Filter the user contact methods. + * Filters the user contact methods. * * @since 2.9.0 * @@ -2015,13 +2017,121 @@ function wp_get_user_contact_methods( $user = null ) { /** * The old private function for setting up user contact methods. * + * Use wp_get_user_contact_methods() instead. + * * @since 2.9.0 * @access private + * + * @param WP_User $user Optional. WP_User object. Default null. + * @return array Array of contact methods and their labels. */ 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 twelve characters long. To make it stronger, use upper and lower case letters, numbers, and symbols like ! " ? $ % ^ & ).' ); + + /** + * Filters 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 ); +} + +/** + * Creates, stores, then returns a password reset key for user. + * + * @since 4.4.0 + * + * @global wpdb $wpdb WordPress database abstraction object. + * @global PasswordHash $wp_hasher Portable PHP password hashing framework. + * + * @param WP_User $user User to retrieve password reset key for. + * + * @return string|WP_Error Password reset key on success. WP_Error on error. + */ +function get_password_reset_key( $user ) { + global $wpdb, $wp_hasher; + + /** + * Fires before a new password is retrieved. + * + * Use the {@see 'retrieve_password'} hook instead. + * + * @since 1.5.0 + * @deprecated 1.5.1 Misspelled. Use 'retrieve_password' hook instead. + * + * @param string $user_login The user login name. + */ + do_action( 'retreive_password', $user->user_login ); + + /** + * Fires before a new password is retrieved. + * + * @since 1.5.1 + * + * @param string $user_login The user login name. + */ + do_action( 'retrieve_password', $user->user_login ); + + $allow = true; + if ( is_multisite() && is_user_spammy( $user ) ) { + $allow = false; + } + + /** + * Filters whether to allow a password to be reset. + * + * @since 2.7.0 + * + * @param bool $allow Whether to allow the password to be reset. Default true. + * @param int $user_data->ID The ID of the user attempting to reset a password. + */ + $allow = apply_filters( 'allow_password_reset', $allow, $user->ID ); + + if ( ! $allow ) { + return new WP_Error( 'no_password_reset', __( 'Password reset is not allowed for this user' ) ); + } elseif ( is_wp_error( $allow ) ) { + return $allow; + } + + // Generate something random for a password reset key. + $key = wp_generate_password( 20, false ); + + /** + * Fires when a password reset key is generated. + * + * @since 2.5.0 + * + * @param string $user_login The username for the user. + * @param string $key The generated password reset key. + */ + do_action( 'retrieve_password_key', $user->user_login, $key ); + + // Now insert the key, hashed, into the DB. + if ( empty( $wp_hasher ) ) { + $wp_hasher = new PasswordHash( 8, true ); + } + $hashed = time() . ':' . $wp_hasher->HashPassword( $key ); + $key_saved = $wpdb->update( $wpdb->users, array( 'user_activation_key' => $hashed ), array( 'user_login' => $user->user_login ) ); + if ( false === $key_saved ) { + return new WP_Error( 'no_password_key_update', __( 'Could not save password reset key to database.' ) ); + } + + return $key; +} + /** * Retrieves a user row based on password reset key and login * @@ -2030,7 +2140,10 @@ function _wp_get_user_contactmethods( $user = null ) { * 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. * - * @global wpdb $wpdb WordPress database object for queries. + * @since 3.1.0 + * + * @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. @@ -2052,22 +2165,49 @@ function check_password_reset_key($key, $login) { return new WP_Error('invalid_key', __('Invalid key')); if ( empty( $wp_hasher ) ) { - require_once ABSPATH . WPINC . '/class-phpass.php'; $wp_hasher = new PasswordHash( 8, true ); } - if ( $wp_hasher->CheckPassword( $key, $row->user_activation_key ) ) + /** + * Filters the expiration time of password reset keys. + * + * @since 4.3.0 + * + * @param int $expiration The expiration time in seconds. + */ + $expiration_duration = apply_filters( 'password_reset_expiration', DAY_IN_SECONDS ); + + if ( false !== strpos( $row->user_activation_key, ':' ) ) { + list( $pass_request_time, $pass_key ) = explode( ':', $row->user_activation_key, 2 ); + $expiration_time = $pass_request_time + $expiration_duration; + } else { + $pass_key = $row->user_activation_key; + $expiration_time = false; + } + + if ( ! $pass_key ) { + return new WP_Error( 'invalid_key', __( 'Invalid key' ) ); + } + + $hash_is_correct = $wp_hasher->CheckPassword( $key, $pass_key ); + + if ( $hash_is_correct && $expiration_time && time() < $expiration_time ) { return get_userdata( $row->ID ); + } elseif ( $hash_is_correct && $expiration_time ) { + // Key has an expiration time that's passed + return new WP_Error( 'expired_key', __( 'Invalid key' ) ); + } - if ( $key === $row->user_activation_key ) { + if ( hash_equals( $row->user_activation_key, $key ) || ( $hash_is_correct && ! $expiration_time ) ) { $return = new WP_Error( 'expired_key', __( 'Invalid key' ) ); $user_id = $row->ID; /** - * Filter the return value of check_password_reset_key() when an - * old-style key is used (plain-text key was stored in the database). + * Filters the return value of check_password_reset_key() when an + * old-style key is used. * - * @since 3.7.0 + * @since 3.7.0 Previously plain-text keys were stored in the database. + * @since 4.3.0 Previously key hashes were stored without an expiration time. * * @param WP_Error $return A WP_Error object denoting an expired key. * Return a WP_User object to validate the key. @@ -2082,7 +2222,9 @@ function check_password_reset_key($key, $login) { /** * Handles resetting the user's password. * - * @param object $user The user + * @since 2.5.0 + * + * @param object $user The user * @param string $new_pass New password for the user in plaintext */ function reset_password( $user, $new_pass ) { @@ -2099,12 +2241,22 @@ function reset_password( $user, $new_pass ) { wp_set_password( $new_pass, $user->ID ); update_user_option( $user->ID, 'default_password_nag', false, true ); - wp_password_change_notification( $user ); + /** + * Fires after the user's password is reset. + * + * @since 4.4.0 + * + * @param object $user The user. + * @param string $new_pass New user password. + */ + do_action( 'after_password_reset', $user, $new_pass ); } /** * Handles registering a new user. * + * @since 2.5.0 + * * @param string $user_login User's username for logging in * @param string $user_email User's email address to send password and add * @return int|WP_Error Either user's ID or error on failure. @@ -2114,7 +2266,7 @@ function register_new_user( $user_login, $user_email ) { $sanitized_user_login = sanitize_user( $user_login ); /** - * Filter the email address of a user being registered. + * Filters the email address of a user being registered. * * @since 2.1.0 * @@ -2130,11 +2282,18 @@ function register_new_user( $user_login, $user_email ) { $sanitized_user_login = ''; } elseif ( username_exists( $sanitized_user_login ) ) { $errors->add( 'username_exists', __( 'ERROR: This username is already registered. Please choose another one.' ) ); + + } else { + /** This filter is documented in wp-includes/user.php */ + $illegal_user_logins = array_map( 'strtolower', (array) apply_filters( 'illegal_user_logins', array() ) ); + if ( in_array( strtolower( $sanitized_user_login ), $illegal_user_logins ) ) { + $errors->add( 'invalid_username', __( 'ERROR: Sorry, that username is not allowed.' ) ); + } } - // Check the e-mail address + // Check the email address if ( $user_email == '' ) { - $errors->add( 'empty_email', __( 'ERROR: Please type your e-mail address.' ) ); + $errors->add( 'empty_email', __( 'ERROR: Please type your email address.' ) ); } elseif ( ! is_email( $user_email ) ) { $errors->add( 'invalid_email', __( 'ERROR: The email address isn’t correct.' ) ); $user_email = ''; @@ -2156,7 +2315,7 @@ function register_new_user( $user_login, $user_email ) { do_action( 'register_post', $sanitized_user_login, $user_email, $errors ); /** - * Filter the errors encountered when a new user is being registered. + * Filters 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, @@ -2185,11 +2344,36 @@ function register_new_user( $user_login, $user_email ) { update_user_option( $user_id, 'default_password_nag', true, true ); //Set up the Password change nag. - wp_new_user_notification( $user_id, $user_pass ); + /** + * Fires after a new user registration has been recorded. + * + * @since 4.4.0 + * + * @param int $user_id ID of the newly registered user. + */ + do_action( 'register_new_user', $user_id ); return $user_id; } +/** + * Initiates email notifications related to the creation of new users. + * + * Notifications are sent both to the site admin and to the newly created user. + * + * @since 4.4.0 + * @since 4.6.0 Converted the `$notify` parameter to accept 'user' for sending + * notifications only to the user created. + * + * @param int $user_id ID of the newly created user. + * @param string $notify Optional. Type of notification that should happen. Accepts 'admin' + * or an empty string (admin only), 'user', or 'both' (admin and user). + * Default 'both'. + */ +function wp_send_new_user_notifications( $user_id, $notify = 'both' ) { + wp_new_user_notification( $user_id, null, $notify ); +} + /** * Retrieve the current session token from the logged_in cookie. * @@ -2248,3 +2432,102 @@ function wp_destroy_all_sessions() { $manager = WP_Session_Tokens::get_instance( get_current_user_id() ); $manager->destroy_all(); } + +/** + * Get the user IDs of all users with no role on this site. + * + * This function returns an empty array when used on Multisite. + * + * @since 4.4.0 + * + * @return array Array of user IDs. + */ +function wp_get_users_with_no_role() { + global $wpdb; + + if ( is_multisite() ) { + return array(); + } + + $prefix = $wpdb->get_blog_prefix(); + $regex = implode( '|', array_keys( wp_roles()->get_names() ) ); + $regex = preg_replace( '/[^a-zA-Z_\|-]/', '', $regex ); + $users = $wpdb->get_col( $wpdb->prepare( " + SELECT user_id + FROM $wpdb->usermeta + WHERE meta_key = '{$prefix}capabilities' + AND meta_value NOT REGEXP %s + ", $regex ) ); + + return $users; +} + +/** + * Retrieves the current user object. + * + * Will set the current user, if the current user is not set. The current user + * will be set to the logged-in person. If no user is logged-in, then it will + * set the current user to 0, which is invalid and won't have any permissions. + * + * This function is used by the pluggable functions wp_get_current_user() and + * get_currentuserinfo(), the latter of which is deprecated but used for backward + * compatibility. + * + * @since 4.5.0 + * @access private + * + * @see wp_get_current_user() + * @global WP_User $current_user Checks if the current user is set. + * + * @return WP_User Current WP_User instance. + */ +function _wp_get_current_user() { + global $current_user; + + if ( ! empty( $current_user ) ) { + if ( $current_user instanceof WP_User ) { + return $current_user; + } + + // Upgrade stdClass to WP_User + if ( is_object( $current_user ) && isset( $current_user->ID ) ) { + $cur_id = $current_user->ID; + $current_user = null; + wp_set_current_user( $cur_id ); + return $current_user; + } + + // $current_user has a junk value. Force to WP_User with ID 0. + $current_user = null; + wp_set_current_user( 0 ); + return $current_user; + } + + if ( defined('XMLRPC_REQUEST') && XMLRPC_REQUEST ) { + wp_set_current_user( 0 ); + return $current_user; + } + + /** + * Filters the current user. + * + * The default filters use this to determine the current user from the + * request's cookies, if available. + * + * Returning a value of false will effectively short-circuit setting + * the current user. + * + * @since 3.9.0 + * + * @param int|bool $user_id User ID if one has been determined, false otherwise. + */ + $user_id = apply_filters( 'determine_current_user', false ); + if ( ! $user_id ) { + wp_set_current_user( 0 ); + return $current_user; + } + + wp_set_current_user( $user_id ); + + return $current_user; +}