X-Git-Url: https://scripts.mit.edu/gitweb/autoinstallsdev/wordpress.git/blobdiff_plain/4f9d63e13cd8c6e275797c75b401b074b82937bc..caeaf8dc94b5e3f75dc98ec92dc7b76049cdddb6:/wp-includes/user.php diff --git a/wp-includes/user.php b/wp-includes/user.php index 66d5d2e9..3640980f 100644 --- a/wp-includes/user.php +++ b/wp-includes/user.php @@ -3,6 +3,7 @@ * WordPress User API * * @package WordPress + * @subpackage Users */ /** @@ -18,11 +19,11 @@ * * @since 2.5.0 * - * @param array $credentials Optional. User info in order to sign on. - * @param bool $secure_cookie Optional. Whether to use secure cookie. - * @return object Either WP_Error on failure, or WP_User on success. + * @param array $credentials Optional. User info in order to sign on. + * @param string|bool $secure_cookie Optional. Whether to use secure cookie. + * @return WP_User|WP_Error WP_User on success, WP_Error on failure. */ -function wp_signon( $credentials = '', $secure_cookie = '' ) { +function wp_signon( $credentials = array(), $secure_cookie = '' ) { if ( empty($credentials) ) { if ( ! empty($_POST['log']) ) $credentials['user_login'] = $_POST['log']; @@ -37,12 +38,41 @@ function wp_signon( $credentials = '', $secure_cookie = '' ) { else $credentials['remember'] = false; - // TODO do we deprecate the wp_authentication action? - do_action_ref_array('wp_authenticate', array(&$credentials['user_login'], &$credentials['user_password'])); + /** + * Fires before the user is authenticated. + * + * The variables passed to the callbacks are passed by reference, + * and can be modified by callback functions. + * + * @since 1.5.1 + * + * @todo Decide whether to deprecate the wp_authenticate action. + * + * @param string $user_login Username, passed by reference. + * @param string $user_password User password, passed by reference. + */ + do_action_ref_array( 'wp_authenticate', array( &$credentials['user_login'], &$credentials['user_password'] ) ); if ( '' === $secure_cookie ) $secure_cookie = is_ssl(); + /** + * Filter whether to use a secure sign-on cookie. + * + * @since 3.1.0 + * + * @param bool $secure_cookie Whether to use a secure sign-on cookie. + * @param array $credentials { + * Array of entered sign-on data. + * + * @type string $user_login Username. + * @type string $user_password Password entered. + * @type bool $remember Whether to 'remember' the user. Increases the time + * that the cookie will be kept. Default false. + * } + */ + $secure_cookie = apply_filters( 'secure_signon_cookie', $secure_cookie, $credentials ); + global $auth_secure_cookie; // XXX ugly hack to pass this to wp_authenticate_cookie $auth_secure_cookie = $secure_cookie; @@ -59,19 +89,37 @@ function wp_signon( $credentials = '', $secure_cookie = '' ) { } wp_set_auth_cookie($user->ID, $credentials['remember'], $secure_cookie); - do_action('wp_login', $credentials['user_login']); + /** + * Fires after the user has successfully logged in. + * + * @since 1.5.0 + * + * @param string $user_login Username. + * @param WP_User $user WP_User object of the logged-in user. + */ + do_action( 'wp_login', $user->user_login, $user ); return $user; } - /** * Authenticate the user using the username and password. + * + * @since 2.8.0 + * + * @param WP_User|WP_Error|null $user WP_User or WP_Error object from a previous callback. Default null. + * @param string $username Username for authentication. + * @param string $password Password for authentication. + * @return WP_User|WP_Error WP_User on success, WP_Error on failure. */ -add_filter('authenticate', 'wp_authenticate_username_password', 20, 3); function wp_authenticate_username_password($user, $username, $password) { - if ( is_a($user, 'WP_User') ) { return $user; } + if ( is_a( $user, 'WP_User' ) ) { + return $user; + } if ( empty($username) || empty($password) ) { + if ( is_wp_error( $user ) ) + return $user; + $error = new WP_Error(); if ( empty($username) ) @@ -83,40 +131,45 @@ function wp_authenticate_username_password($user, $username, $password) { return $error; } - $userdata = get_user_by('login', $username); - - if ( !$userdata ) - return new WP_Error('invalid_username', sprintf(__('ERROR: Invalid username. Lost your password?'), site_url('wp-login.php?action=lostpassword', 'login'))); - - if ( is_multisite() ) { - // Is user marked as spam? - if ( 1 == $userdata->spam) - return new WP_Error('invalid_username', __('ERROR: Your account has been marked as a spammer.')); - - // Is a user's blog marked as spam? - if ( !is_super_admin( $userdata->ID ) && isset($userdata->primary_blog) ) { - $details = get_blog_details( $userdata->primary_blog ); - if ( is_object( $details ) && $details->spam == 1 ) - return new WP_Error('blog_suspended', __('Site Suspended.')); - } - } - - $userdata = apply_filters('wp_authenticate_user', $userdata, $password); - if ( is_wp_error($userdata) ) - return $userdata; + $user = get_user_by('login', $username); + + if ( !$user ) + return new WP_Error( 'invalid_username', sprintf( __( 'ERROR: Invalid username. Lost your password?' ), wp_lostpassword_url() ) ); + + /** + * Filter whether the given user can be authenticated with the provided $password. + * + * @since 2.5.0 + * + * @param WP_User|WP_Error $user WP_User or WP_Error object if a previous + * callback failed authentication. + * @param string $password Password to check against the user. + */ + $user = apply_filters( 'wp_authenticate_user', $user, $password ); + if ( is_wp_error($user) ) + return $user; - if ( !wp_check_password($password, $userdata->user_pass, $userdata->ID) ) - return new WP_Error('incorrect_password', sprintf(__('ERROR: Incorrect password. Lost your password?'), site_url('wp-login.php?action=lostpassword', 'login'))); + 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() ) ); - $user = new WP_User($userdata->ID); return $user; } /** * Authenticate the user using the WordPress auth cookie. + * + * @since 2.8.0 + * + * @param WP_User|WP_Error|null $user WP_User or WP_Error object from a previous callback. Default null. + * @param string $username Username. If not empty, cancels the cookie authentication. + * @param string $password Password. If not empty, cancels the cookie authentication. + * @return WP_User|WP_Error WP_User on success, WP_Error on failure. */ function wp_authenticate_cookie($user, $username, $password) { - if ( is_a($user, 'WP_User') ) { return $user; } + if ( is_a( $user, 'WP_User' ) ) { + return $user; + } if ( empty($username) && empty($password) ) { $user_id = wp_validate_auth_cookie(); @@ -139,41 +192,111 @@ function wp_authenticate_cookie($user, $username, $password) { return $user; } +/** + * For Multisite blogs, check if the authenticated user has been marked as a + * spammer, or if the user's primary blog has been marked as spam. + * + * @since 3.7.0 + * + * @param WP_User|WP_Error|null $user WP_User or WP_Error object from a previous callback. Default null. + * @return WP_User|WP_Error WP_User on success, WP_Error if the user is considered a spammer. + */ +function wp_authenticate_spam_check( $user ) { + if ( $user && is_a( $user, 'WP_User' ) && is_multisite() ) { + /** + * Filter whether the user has been marked as a spammer. + * + * @since 3.7.0 + * + * @param bool $spammed Whether the user is considered a spammer. + * @param WP_User $user User to check against. + */ + $spammed = apply_filters( 'check_is_user_spammed', is_user_spammy(), $user ); + + if ( $spammed ) + return new WP_Error( 'spammer_account', __( 'ERROR: Your account has been marked as a spammer.' ) ); + } + return $user; +} + +/** + * Validate the logged-in cookie. + * + * Checks the logged-in cookie if the previous auth cookie could not be + * validated and parsed. + * + * This is a callback for the determine_current_user filter, rather than API. + * + * @since 3.9.0 + * + * @param int|bool $user_id The user ID (or false) as received from the + * determine_current_user filter. + * @return int|bool User ID if validated, false otherwise. If a user ID from + * an earlier filter callback is received, that value is returned. + */ +function wp_validate_logged_in_cookie( $user_id ) { + if ( $user_id ) { + return $user_id; + } + + if ( is_blog_admin() || is_network_admin() || empty( $_COOKIE[LOGGED_IN_COOKIE] ) ) { + return false; + } + + return wp_validate_auth_cookie( $_COOKIE[LOGGED_IN_COOKIE], 'logged_in' ); +} + /** * Number of posts user has written. * * @since 3.0.0 - * @uses $wpdb WordPress database object for queries. + * @since 4.1.0 Added `$post_type` argument. * - * @param int $userid User ID. - * @return int Amount of posts user has written. + * @global wpdb $wpdb WordPress database object for queries. + * + * @param int $userid User ID. + * @param string $post_type Optional. Post type to count the number of posts for. Default 'post'. + * @return int Number of posts the user has written in this post type. */ -function count_user_posts($userid) { +function count_user_posts( $userid, $post_type = 'post' ) { global $wpdb; - $where = get_posts_by_author_sql('post', TRUE, $userid); + $where = get_posts_by_author_sql( $post_type, true, $userid ); $count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->posts $where" ); - return apply_filters('get_usernumposts', $count, $userid); + /** + * Filter the number of posts a user has written. + * + * @since 2.7.0 + * @since 4.1.0 Added `$post_type` argument. + * + * @param int $count The user's post count. + * @param int $userid User ID. + * @param string $post_type Post type to count the number of posts for. + */ + return apply_filters( 'get_usernumposts', $count, $userid, $post_type ); } /** * Number of posts written by a list of users. * * @since 3.0.0 - * @param array $userid User ID number list. + * + * @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. * @return array Amount of posts each user has written. */ -function count_many_users_posts($users) { +function count_many_users_posts( $users, $post_type = 'post', $public_only = false ) { global $wpdb; $count = array(); - if ( ! is_array($users) || empty( $users ) ) + if ( empty( $users ) || ! is_array( $users ) ) return $count; - $userlist = implode( ',', $users ); - $where = get_posts_by_author_sql( 'post' ); + $userlist = implode( ',', array_map( 'absint', $users ) ); + $where = get_posts_by_author_sql( $post_type, true, null, $public_only ); $result = $wpdb->get_results( "SELECT post_author, COUNT(*) FROM $wpdb->posts $where AND post_author IN ($userlist) GROUP BY post_author", ARRAY_N ); foreach ( $result as $row ) { @@ -188,24 +311,6 @@ function count_many_users_posts($users) { return $count; } -/** - * Check that the user login name and password is correct. - * - * @since 0.71 - * @todo xmlrpc only. Maybe move to xmlrpc.php. - * - * @param string $user_login User name. - * @param string $user_pass User password. - * @return bool False if does not authenticate, true if username and password authenticates. - */ -function user_pass_ok($user_login, $user_pass) { - $user = wp_authenticate($user_login, $user_pass); - if ( is_wp_error($user) ) - return false; - - return true; -} - // // User option functions // @@ -215,11 +320,11 @@ function user_pass_ok($user_login, $user_pass) { * * @since MU * - * @uses wp_get_current_user - * * @return int The current user's ID */ function get_current_user_id() { + if ( ! function_exists( 'wp_get_current_user' ) ) + return 0; $user = wp_get_current_user(); return ( isset( $user->ID ) ? (int) $user->ID : 0 ); } @@ -235,14 +340,13 @@ function get_current_user_id() { * The option will first check for the per site name and then the per Network name. * * @since 2.0.0 - * @uses $wpdb WordPress database object for queries. - * @uses apply_filters() Calls 'get_user_option_$option' hook with result, - * option parameter, and user data 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. - * @return mixed + * @global wpdb $wpdb WordPress database object for queries. + * + * @param string $option User option name. + * @param int $user Optional. User ID. + * @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; @@ -250,24 +354,32 @@ function get_user_option( $option, $user = 0, $deprecated = '' ) { if ( !empty( $deprecated ) ) _deprecated_argument( __FUNCTION__, '3.0' ); - if ( empty($user) ) { - $user = wp_get_current_user(); - $user = $user->ID; - } - - $user = get_userdata($user); + if ( empty( $user ) ) + $user = get_current_user_id(); - // Keys used as object vars cannot have dashes. - $key = str_replace('-', '', $option); + if ( ! $user = get_userdata( $user ) ) + return false; - if ( isset( $user->{$wpdb->prefix . $key} ) ) // Blog specific - $result = $user->{$wpdb->prefix . $key}; - elseif ( isset( $user->{$key} ) ) // User specific and cross-blog - $result = $user->{$key}; + $prefix = $wpdb->get_blog_prefix(); + if ( $user->has_prop( $prefix . $option ) ) // Blog specific + $result = $user->get( $prefix . $option ); + elseif ( $user->has_prop( $option ) ) // User specific and cross-blog + $result = $user->get( $option ); else $result = false; - return apply_filters("get_user_option_{$option}", $result, $option, $user); + /** + * Filter a specific user option value. + * + * The dynamic portion of the hook name, `$option`, refers to the user option name. + * + * @since 2.5.0 + * + * @param mixed $result Value for the user's option. + * @param string $option Name of the option being retrieved. + * @param WP_User $user WP_User object of the user whose option is being retrieved. + */ + return apply_filters( "get_user_option_{$option}", $result, $option, $user ); } /** @@ -280,24 +392,22 @@ function get_user_option( $option, $user = 0, $deprecated = '' ) { * Deletes the user option if $newvalue is empty. * * @since 2.0.0 - * @uses $wpdb WordPress database object for queries * - * @param int $user_id User ID + * @global wpdb $wpdb WordPress database object for queries. + * + * @param int $user_id User ID. * @param string $option_name User option name. - * @param mixed $newvalue User option value. - * @param bool $global Optional. Whether option name is global or blog specific. Default false (blog specific). - * @return unknown + * @param mixed $newvalue User option value. + * @param bool $global Optional. Whether option name is global or blog specific. + * Default false (blog specific). + * @return int|bool User meta ID if the option didn't exist, true on successful update, + * false on failure. */ function update_user_option( $user_id, $option_name, $newvalue, $global = false ) { global $wpdb; if ( !$global ) - $option_name = $wpdb->prefix . $option_name; - - // For backward compatibility. See differences between update_user_meta() and deprecated update_usermeta(). - // http://core.trac.wordpress.org/ticket/13088 - if ( is_null( $newvalue ) || is_scalar( $newvalue ) && empty( $newvalue ) ) - return delete_user_meta( $user_id, $option_name ); + $option_name = $wpdb->get_blog_prefix() . $option_name; return update_user_meta( $user_id, $option_name, $newvalue ); } @@ -310,57 +420,731 @@ function update_user_option( $user_id, $option_name, $newvalue, $global = false * it will prepend the WordPress table prefix to the option name. * * @since 3.0.0 - * @uses $wpdb WordPress database object for queries * - * @param int $user_id User ID + * @global wpdb $wpdb WordPress database object for queries. + * + * @param int $user_id User ID * @param string $option_name User option name. - * @param bool $global Optional. Whether option name is global or blog specific. Default false (blog specific). - * @return unknown + * @param bool $global Optional. Whether option name is global or blog specific. + * Default false (blog specific). + * @return bool True on success, false on failure. */ function delete_user_option( $user_id, $option_name, $global = false ) { global $wpdb; if ( !$global ) - $option_name = $wpdb->prefix . $option_name; + $option_name = $wpdb->get_blog_prefix() . $option_name; return delete_user_meta( $user_id, $option_name ); } /** - * Get users for the blog. + * WordPress User Query class. * - * For setups that use the multi-blog feature. Can be used outside of the - * multi-blog feature. + * @since 3.1.0 * - * @since 2.2.0 - * @uses $wpdb WordPress database object for queries - * @uses $blog_id The Blog id of the blog for those that use more than one blog + * @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; + + // 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. + * @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 + * @access public + * + * @param string|array $query { + * Optional. Array or string of Query parameters. + * + * @type int $blog_id The site ID. Default is the global blog id. + * @type string $role Role name. Default empty. + * @type string $meta_key User meta key. Default empty. + * @type string $meta_value User meta value. Default empty. + * @type string $meta_compare Comparison operator to test the `$meta_value`. Accepts '=', '!=', + * '>', '>=', '<', '<=', 'LIKE', 'NOT LIKE', 'IN', 'NOT IN', 'BETWEEN', + * 'NOT BETWEEN', 'EXISTS', 'NOT EXISTS', 'REGEXP', 'NOT REGEXP', + * or 'RLIKE'. Default '='. + * @type array $include An array of user IDs to include. Default empty array. + * @type array $exclude An array of user IDs to exclude. Default empty array. + * @type string $search Search keyword. Searches for possible string matches on columns. + * When `$search_columns` is left empty, it tries to determine which + * column to search in based on search string. Default empty. + * @type array $search_columns Array of column names to be searched. Accepts 'ID', 'login', + * 'nicename', 'email', 'url'. Default empty array. + * @type string $orderby Field to sort the retrieved users by. Accepts 'ID', 'display_name', + * 'login', 'nicename', 'email', 'url', 'registered', 'post_count', or + * 'meta_value'. To use 'meta_value', `$meta_key` must be also be defined. + * Default 'user_login'. + * @type string $order Designates ascending or descending order of users. Accepts 'ASC', + * 'DESC'. Default 'ASC'. + * @type int $offset Number of users to offset in retrieved results. Can be used in + * conjunction with pagination. Default 0. + * @type int $number Number of users to limit the query for. Can be used in conjunction + * with pagination. Value -1 (all) is not supported. + * Default empty (all users). + * @type bool $count_total Whether to count the total number of users found. If pagination is not + * needed, setting this to false can improve performance. Default true. + * @type string|array $fields Which fields to return. Single or all fields (string), or array + * of fields. Accepts 'ID', 'display_name', 'login', 'nicename', 'email', + * 'url', 'registered'. Use 'all' for all fields and 'all_with_meta' to + * include meta fields. Default 'all'. + * @type string $who Type of users to query. Accepts 'authors'. Default empty (all users). + * } + */ + public function prepare_query( $query = array() ) { + global $wpdb; + + if ( empty( $this->query_vars ) || ! empty( $query ) ) { + $this->query_limit = null; + $this->query_vars = wp_parse_args( $query, array( + 'blog_id' => $GLOBALS['blog_id'], + 'role' => '', + 'meta_key' => '', + 'meta_value' => '', + '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"; + + // 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; + } + + // 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 if ( 'include' === $qv['orderby'] && ! empty( $include ) ) { + // Sanitized earlier. + $include_sql = implode( ',', $include ); + $orderby = "FIELD( $wpdb->users.ID, $include_sql )"; + } 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 + } + + $meta_query = new WP_Meta_Query(); + $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( $meta_query->queries ) ) { + $meta_query->queries = array( $cap_meta_query ); + } elseif ( ! in_array( $cap_meta_query, $meta_query->queries, true ) ) { + // Append the cap query to the original queries and reparse the query. + $meta_query->queries = array( + 'relation' => 'AND', + array( $meta_query->queries, $cap_meta_query ), + ); + } + + $meta_query->parse_query_vars( $meta_query->queries ); + } + + 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( $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 ); + } + } + } + + /** + * 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 int Number 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. * - * @param int $id Blog ID. - * @return array List of users that are part of that Blog ID + * @since 3.1.0 + * + * @see WP_User_Query + * + * @param array $args Optional. Arguments to retrieve users. See {@see WP_User_Query::prepare_query()} + * for more information on accepted arguments. + * @return array List of users. */ -function get_users_of_blog( $id = '' ) { - global $wpdb, $blog_id; - if ( empty($id) ) - $id = (int) $blog_id; - $blog_prefix = $wpdb->get_blog_prefix($id); - $users = $wpdb->get_results( "SELECT user_id, user_id AS ID, user_login, display_name, user_email, meta_value FROM $wpdb->users, $wpdb->usermeta WHERE {$wpdb->users}.ID = {$wpdb->usermeta}.user_id AND meta_key = '{$blog_prefix}capabilities' ORDER BY {$wpdb->usermeta}.user_id" ); - return $users; +function get_users( $args = array() ) { + + $args = wp_parse_args( $args ); + $args['count_total'] = false; + + $user_search = new WP_User_Query($args); + + return (array) $user_search->get_results(); +} + +/** + * Get the blogs a user belongs to. + * + * @since 3.0.0 + * + * @global wpdb $wpdb WordPress database object for queries. + * + * @param int $user_id User ID + * @param bool $all Whether to retrieve all blogs, or only blogs that are not + * marked as deleted, archived, or spam. + * @return array A list of the user's blogs. An empty array if the user doesn't exist + * or belongs to no blogs. + */ +function get_blogs_of_user( $user_id, $all = false ) { + global $wpdb; + + $user_id = (int) $user_id; + + // Logged out users can't have blogs + if ( empty( $user_id ) ) + return array(); + + $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; + } + + $blogs = 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 + ); + } + unset( $keys[ $wpdb->base_prefix . 'capabilities' ] ); + } + + $keys = array_keys( $keys ); + + foreach ( $keys as $key ) { + if ( 'capabilities' !== substr( $key, -12 ) ) + 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 ) ) + 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 + ); + } + } + + /** + * Filter the list of blogs a user belongs to. + * + * @since MU + * + * @param array $blogs An array of blog objects belonging to the user. + * @param int $user_id User ID. + * @param bool $all Whether the returned blogs array should contain all blogs, including + * those marked 'deleted', 'archived', or 'spam'. Default false. + */ + return apply_filters( 'get_blogs_of_user', $blogs, $user_id, $all ); +} + +/** + * Find out whether a user is a member of a given blog. + * + * @since MU 1.1 + * + * @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 ) { + $user_id = (int) $user_id; + $blog_id = (int) $blog_id; + + if ( empty( $user_id ) ) + $user_id = get_current_user_id(); + + if ( empty( $blog_id ) ) + $blog_id = get_current_blog_id(); + + $blogs = get_blogs_of_user( $user_id ); + return array_key_exists( $blog_id, $blogs ); } /** * Add meta data field to a user. * - * Post meta data is called "Custom Fields" on the Administration Panels. + * 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 Post ID. - * @param string $key Metadata name. - * @param mixed $value Metadata value. + * @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 bool False for failure. True for success. + * @return int|bool 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); @@ -374,13 +1158,12 @@ 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 * * @param int $user_id user ID * @param string $meta_key Metadata name. * @param mixed $meta_value Optional. Metadata value. - * @return bool False for failure. True for success. + * @return bool True on success, false on failure. */ function delete_user_meta($user_id, $meta_key, $meta_value = '') { return delete_metadata('user', $user_id, $meta_key, $meta_value); @@ -390,16 +1173,15 @@ 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 Post ID. - * @param string $key The meta key to retrieve. + * @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) { +function get_user_meta($user_id, $key = '', $single = false) { return get_metadata('user', $user_id, $key, $single); } @@ -412,14 +1194,13 @@ 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 * - * @param int $user_id Post ID. - * @param string $key Metadata key. - * @param mixed $value Metadata value. + * @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 bool False on failure, true if success. + * @return int|bool Meta ID if the key didn't exist, true on successful update, false on failure. */ function update_user_meta($user_id, $meta_key, $meta_value, $prev_value = '') { return update_metadata('user', $user_id, $meta_key, $meta_value, $prev_value); @@ -429,7 +1210,7 @@ function update_user_meta($user_id, $meta_key, $meta_value, $prev_value = '') { * Count number of users who have each of the user roles. * * Assumes there are neither duplicated nor orphaned capabilities meta_values. - * Assumes role names are unique phrases. Same assumption made by WP_User_Search::prepare_query() + * Assumes role names are unique phrases. Same assumption made by WP_User_Query::prepare_query() * Using $strategy = 'time' this is CPU-intensive and should handle around 10^7 users. * Using $strategy = 'memory' this is memory-intensive and should handle around 10^5 users, but see WP Bug #12257. * @@ -438,10 +1219,10 @@ function update_user_meta($user_id, $meta_key, $meta_value, $prev_value = '') { * @return array Includes a grand total and an array of counts indexed by role strings. */ function count_users($strategy = 'time') { - global $wpdb, $blog_id, $wp_roles; + global $wpdb, $wp_roles; // Initialize - $id = (int) $blog_id; + $id = get_current_blog_id(); $blog_prefix = $wpdb->get_blog_prefix($id); $result = array(); @@ -456,7 +1237,7 @@ function count_users($strategy = 'time') { // Build a CPU-intensive query that will return concise information. $select_count = array(); foreach ( $avail_roles as $this_role => $name ) { - $select_count[] = "COUNT(NULLIF(`meta_value` LIKE '%" . like_escape($this_role) . "%', FALSE))"; + $select_count[] = $wpdb->prepare( "COUNT(NULLIF(`meta_value` LIKE %s, false))", '%' . $wpdb->esc_like( '"' . $this_role . '"' ) . '%'); } $select_count = implode(', ', $select_count); @@ -484,14 +1265,14 @@ function count_users($strategy = 'time') { $users_of_blog = $wpdb->get_col( "SELECT meta_value FROM $wpdb->usermeta WHERE meta_key = '{$blog_prefix}capabilities'" ); foreach ( $users_of_blog as $caps_meta ) { - $b_roles = unserialize($caps_meta); - if ( is_array($b_roles) ) { - foreach ( $b_roles as $b_role => $val ) { - if ( isset($avail_roles[$b_role]) ) { - $avail_roles[$b_role]++; - } else { - $avail_roles[$b_role] = 1; - } + $b_roles = maybe_unserialize($caps_meta); + if ( ! is_array( $b_roles ) ) + continue; + foreach ( $b_roles as $b_role => $val ) { + if ( isset($avail_roles[$b_role]) ) { + $avail_roles[$b_role]++; + } else { + $avail_roles[$b_role] = 1; } } } @@ -519,33 +1300,32 @@ function count_users($strategy = 'time') { * @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_pass_md5 MD5 of the user's password * @global string $user_identity The display name of the user * * @param int $for_user_id Optional. User ID to set up global data. */ function setup_userdata($for_user_id = '') { - global $user_login, $userdata, $user_level, $user_ID, $user_email, $user_url, $user_pass_md5, $user_identity; + global $user_login, $userdata, $user_level, $user_ID, $user_email, $user_url, $user_identity; if ( '' == $for_user_id ) - $user = wp_get_current_user(); - else - $user = new WP_User($for_user_id); - - $userdata = $user->data; - $user_ID = (int) $user->ID; - $user_level = (int) isset($user->user_level) ? $user->user_level : 0; - - if ( 0 == $user->ID ) { - $user_login = $user_email = $user_url = $user_pass_md5 = $user_identity = ''; + $for_user_id = get_current_user_id(); + $user = get_userdata( $for_user_id ); + + if ( ! $user ) { + $user_ID = 0; + $user_level = 0; + $userdata = null; + $user_login = $user_email = $user_url = $user_identity = ''; return; } - $user_login = $user->user_login; - $user_email = $user->user_email; - $user_url = $user->user_url; - $user_pass_md5 = md5($user->user_pass); - $user_identity = $user->display_name; + $user_ID = (int) $user->ID; + $user_level = (int) $user->user_level; + $userdata = $user; + $user_login = $user->user_login; + $user_email = $user->user_email; + $user_url = $user->user_url; + $user_identity = $user->display_name; } /** @@ -557,354 +1337,1001 @@ function setup_userdata($for_user_id = '') { * used, either 'include' or 'exclude', but not both. * * The available arguments are as follows: - *