<?php
/**
- * WordPress User API
+ * Core User API
*
* @package WordPress
* @subpackage Users
$user = get_user_by('login', $username);
- if ( !$user )
- return new WP_Error( 'invalid_username', sprintf( __( '<strong>ERROR</strong>: Invalid username. <a href="%s">Lost your password?</a>' ), wp_lostpassword_url() ) );
+ if ( !$user ) {
+ return new WP_Error( 'invalid_username',
+ __( '<strong>ERROR</strong>: Invalid username.' ) .
+ ' <a href="' . wp_lostpassword_url() . '">' .
+ __( 'Lost your password?' ) .
+ '</a>'
+ );
+ }
/**
* Filter whether the given user can be authenticated with the provided $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">Lost your password?</a>' ),
- $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 */
+ __( '<strong>ERROR</strong>: The password you entered for the username %s is incorrect.' ),
+ '<strong>' . $username . '</strong>'
+ ) .
+ ' <a href="' . wp_lostpassword_url() . '">' .
+ __( 'Lost your password?' ) .
+ '</a>'
+ );
+ }
return $user;
}
* @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.
* @param array|string $post_type Optional. Single post type or array of post types to count the number of posts for. Default 'post'.
*
* @since 3.0.0
*
- * @global wpdb $wpdb
+ * @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'.
*
* @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.
*
* @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.
*
* @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.
return delete_user_meta( $user_id, $option_name );
}
-/**
- * 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
- */
- 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;
-
- /**
- * 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
- public $query_fields;
- public $query_from;
- public $query_where;
- public $query_orderby;
- public $query_limit;
-
- /**
- * PHP5 constructor.
- *
- * @since 3.1.0
- *
- * @param null|string|array $args Optional. The query variables.
- */
- public function __construct( $query = null ) {
- 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.
- * @since 4.3.0 Added 'has_published_posts' parameter.
- * @access public
- *
- * @global wpdb $wpdb
- * @global int $blog_id
- *
- * @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).
- * @type bool|array $has_published_posts Pass an array of post types to filter results to users who have
- * published posts in those post types. `true` is an alias for all
- * public post types.
- * }
- */
- 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' => '',
- 'has_published_posts' => null,
- ) );
- }
-
- /**
- * 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";
-
- // 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
- }
-
- if ( $qv['has_published_posts'] && $blog_id ) {
- if ( true === $qv['has_published_posts'] ) {
- $post_types = get_post_types( array( 'public' => true ) );
- } else {
- $post_types = (array) $qv['has_published_posts'];
- }
-
- foreach ( $post_types as &$post_type ) {
- $post_type = $wpdb->prepare( '%s', $post_type );
- }
-
- $posts_table = $wpdb->get_blog_prefix( $blog_id ) . 'posts';
- $this->query_where .= " AND $wpdb->users.ID IN ( SELECT DISTINCT $posts_table.post_author FROM $posts_table WHERE $posts_table.post_status = 'publish' AND $posts_table.post_type IN ( " . join( ", ", $post_types ) . " ) )";
- }
-
- // 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 ( $this->meta_query->has_or_relation() ) {
- $this->query_fields = 'DISTINCT ' . $this->query_fields;
- }
- }
-
- // sorting
- $qv['order'] = isset( $qv['order'] ) ? strtoupper( $qv['order'] ) : '';
- $order = $this->parse_order( $qv['order'] );
-
- if ( empty( $qv['orderby'] ) ) {
- // Default order is by 'user_login'.
- $ordersby = array( 'user_login' => $order );
- } elseif ( is_array( $qv['orderby'] ) ) {
- $ordersby = $qv['orderby'];
- } else {
- // 'orderby' values may be a comma- or space-separated list.
- $ordersby = preg_split( '/[,\s]+/', $qv['orderby'] );
- }
-
- $orderby_array = array();
- foreach ( $ordersby as $_key => $_value ) {
- if ( ! $_value ) {
- continue;
- }
-
- if ( is_int( $_key ) ) {
- // Integer key means this is a flat array of 'orderby' fields.
- $_orderby = $_value;
- $_order = $order;
- } else {
- // 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 ( ! $parsed ) {
- continue;
- }
-
- $orderby_array[] = $parsed . ' ' . $this->parse_order( $_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']);
- 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_url', 'user_email', 'user_nicename', 'display_name');
- }
-
- /**
- * 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', 'display_name', 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 );
- }
-
- if ( ! empty( $include ) ) {
- // Sanitized earlier.
- $ids = implode( ',', $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.
- *
- * @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 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;
-
- 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, '', $qv['blog_id'] );
- }
- }
- }
-
- /**
- * 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
- *
- * @global wpdb $wpdb
- *
- * @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 int Number of total users.
- */
- 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 Value to used in the ORDER clause, if `$orderby` is valid.
- */
- 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 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.0.0
*
- * @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
* @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_blog_details 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_blog_details( $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;
}
/**
* 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
+ * @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.
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.
}
}
+ $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'" );
$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]++;
$result['avail_roles'] =& $avail_roles;
}
+ if ( is_multisite() ) {
+ $result['avail_roles']['none'] = 0;
+ }
+
return $result;
}
*
* @since 2.3.0
*
- * @global wpdb $wpdb WordPress database object for queries.
* @global int $blog_id
*
* @param array|string $args {
$query_args = wp_array_slice_assoc( $r, array( 'blog_id', 'include', 'exclude', 'orderby', 'order', 'who' ) );
$query_args['fields'] = array( 'ID', 'user_login', $show );
+
+ /**
+ * Filter the query arguments for the user drop-down.
+ *
+ * @since 4.4.0
+ *
+ * @param array $query_args The query arguments for wp_dropdown_users().
+ * @param array $r The default arguments for wp_dropdown_users().
+ */
+ $query_args = apply_filters( 'wp_dropdown_users_args', $query_args, $r );
+
$users = get_users( $query_args );
$output = '';
*
* @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');
* 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
*/
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 );
}
/**
* Checks whether a username is valid.
*
* @since 2.0.1
+ * @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.
*
* @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().
*
- * @global wpdb $wpdb WordPress database object for queries.
+ * @global wpdb $wpdb WordPress database abstraction object.
*
* @param array|object|WP_User $userdata {
* An array, object, or WP_User object of user data arguments.
} 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
//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 a nicename is provided, remove unsafe user characters before
- // using it. Otherwise build a nicename from the user_login.
+ /**
+ * Filter 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 = $user_login;
+ $user_nicename = mb_substr( $user_login, 0, 50 );
}
$user_nicename = sanitize_title( $user_nicename );
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++;
}
$user = new WP_User( $user_id );
+ /**
+ * Filter 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 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 );
// Escape data pulled from DB.
$user = add_magic_quotes( $user );
- 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'] );
$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###', get_option( 'blogname' ), $pass_change_email['message'] );
- $pass_change_email['message'] = str_replace( '###SITEURL###', get_option( 'siteurl' ), $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'] );
}
$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###', get_option( 'blogname' ), $email_change_email['message'] );
- $email_change_email['message'] = str_replace( '###SITEURL###', get_option( 'siteurl' ), $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'] );
}
* @param string $username The user's username.
* @param string $password The user's password.
* @param string $email Optional. The user's email. Default empty.
- * @return int|WP_Error The new user's ID.
+ * @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 );
}
/**
- * 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 WP_User $user WP_User instance.
- * @return array
+ * @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' );
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.
+ *
+ * @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 );
+
+ /**
+ * Filter whether to allow a password to be reset.
+ *
+ * @since 2.7.0
+ *
+ * @param bool true 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', true, $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 ) ) {
+ require_once ABSPATH . WPINC . '/class-phpass.php';
+ $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
*
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 );
}
/**
$sanitized_user_login = '';
} elseif ( username_exists( $sanitized_user_login ) ) {
$errors->add( 'username_exists', __( '<strong>ERROR</strong>: 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', __( '<strong>ERROR</strong>: Sorry, that username is not allowed.' ) );
+ }
}
- // Check the e-mail address
+ // Check the email address
if ( $user_email == '' ) {
- $errors->add( 'empty_email', __( '<strong>ERROR</strong>: Please type your e-mail address.' ) );
+ $errors->add( 'empty_email', __( '<strong>ERROR</strong>: Please type your email address.' ) );
} elseif ( ! is_email( $user_email ) ) {
$errors->add( 'invalid_email', __( '<strong>ERROR</strong>: The email address isn’t correct.' ) );
$user_email = '';
update_user_option( $user_id, 'default_password_nag', true, true ); //Set up the Password change nag.
- wp_new_user_notification( $user_id, null, 'both' );
+ /**
+ * 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;
}
+/**
+ * Initiate 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
+ *
+ * @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), 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.
*
$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( '|', 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;
+}