X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/bf5c68485ef07868ad0a91168ecd0092af7661ae..784f914b1e4b1c62d6657e86397c2e83bcee4295:/wp-includes/user.php
diff --git a/wp-includes/user.php b/wp-includes/user.php
index cdec57e2..69cc86c0 100644
--- a/wp-includes/user.php
+++ b/wp-includes/user.php
@@ -1,12 +1,13 @@
ID, $credentials['remember'], $secure_cookie);
- do_action('wp_login', $user->user_login, $user);
+ /**
+ * Fires after the user has successfully logged in.
+ *
+ * @since 1.5.0
+ *
+ * @param string $user_login Username.
+ * @param WP_User $user WP_User object of the logged-in user.
+ */
+ do_action( 'wp_login', $user->user_login, $user );
return $user;
}
-
/**
- * Authenticate the user using the username and password.
+ * Authenticate a user, confirming the username and password are valid.
+ *
+ * @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 ( $user instanceof WP_User ) {
+ return $user;
+ }
if ( empty($username) || empty($password) ) {
+ if ( is_wp_error( $user ) )
+ return $user;
+
$error = new WP_Error();
if ( empty($username) )
@@ -85,41 +133,134 @@ function wp_authenticate_username_password($user, $username, $password) {
return $error;
}
- $userdata = get_user_by('login', $username);
+ $user = get_user_by('login', $username);
- if ( !$userdata )
- return new WP_Error('invalid_username', sprintf(__('ERROR: Invalid username. Lost your password?'), wp_lostpassword_url()));
+ if ( !$user ) {
+ return new WP_Error( 'invalid_username',
+ __( 'ERROR: Invalid username.' ) .
+ ' ' .
+ __( 'Lost your password?' ) .
+ ''
+ );
+ }
- 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.'));
+ /**
+ * Filter whether the given user can be authenticated with the provided $password.
+ *
+ * @since 2.5.0
+ *
+ * @param WP_User|WP_Error $user WP_User or WP_Error object if a previous
+ * callback failed authentication.
+ * @param string $password Password to check against the user.
+ */
+ $user = apply_filters( 'wp_authenticate_user', $user, $password );
+ if ( is_wp_error($user) )
+ return $user;
+
+ if ( ! wp_check_password( $password, $user->user_pass, $user->ID ) ) {
+ return new WP_Error( 'incorrect_password',
+ sprintf(
+ /* 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?' ) .
+ ''
+ );
}
- $userdata = apply_filters('wp_authenticate_user', $userdata, $password);
- if ( is_wp_error($userdata) )
- return $userdata;
+ /** 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, $userdata->user_pass, $userdata->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: email address */
+ __( 'ERROR: The password you entered for the email address %s is incorrect.' ),
+ '' . $email . ''
+ ) .
+ ' ' .
+ __( 'Lost your password?' ) .
+ ''
+ );
+ }
- $user = new WP_User($userdata->ID);
return $user;
}
/**
* Authenticate the user using the WordPress auth cookie.
+ *
+ * @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') ) { return $user; }
+ if ( $user instanceof WP_User ) {
+ return $user;
+ }
if ( empty($username) && empty($password) ) {
$user_id = wp_validate_auth_cookie();
@@ -142,34 +283,110 @@ 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 instanceof WP_User && is_multisite() ) {
+ /**
+ * Filter whether the user has been marked as a spammer.
+ *
+ * @since 3.7.0
+ *
+ * @param bool $spammed Whether the user is considered a spammer.
+ * @param WP_User $user User to check against.
+ */
+ $spammed = apply_filters( 'check_is_user_spammed', is_user_spammy(), $user );
+
+ if ( $spammed )
+ return new WP_Error( 'spammer_account', __( '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|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 ) {
+ 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.
+ * @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 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" );
- 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.
+ * @since 4.3.1 Added `$public_only` argument.
+ *
+ * @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, $post_type, $public_only );
}
/**
* Number of posts written by a list of users.
*
* @since 3.0.0
- * @param array $user_ids Array of user IDs.
- * @param string|array $post_type Optional. Post type to check. Defaults to post.
+ *
+ * @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' ) {
+function count_many_users_posts( $users, $post_type = 'post', $public_only = false ) {
global $wpdb;
$count = array();
@@ -177,7 +394,7 @@ function count_many_users_posts($users, $post_type = 'post' ) {
return $count;
$userlist = implode( ',', array_map( 'absint', $users ) );
- $where = get_posts_by_author_sql( $post_type );
+ $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 ) {
@@ -192,24 +409,6 @@ function count_many_users_posts($users, $post_type = 'post' ) {
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
//
@@ -219,11 +418,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 );
}
@@ -239,14 +438,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 abstraction object.
+ *
+ * @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;
@@ -255,21 +453,31 @@ function get_user_option( $option, $user = 0, $deprecated = '' ) {
_deprecated_argument( __FUNCTION__, '3.0' );
if ( empty( $user ) )
- $user = wp_get_current_user();
- else
- $user = new WP_User( $user );
+ $user = get_current_user_id();
- if ( ! isset( $user->ID ) )
+ if ( ! $user = get_userdata( $user ) )
return false;
- if ( $user->has_prop( $wpdb->prefix . $option ) ) // Blog specific
- $result = $user->get( $wpdb->prefix . $option );
+ $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 );
}
/**
@@ -282,24 +490,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 abstraction object.
+ *
+ * @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 );
}
@@ -312,322 +518,32 @@ 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 abstraction object.
+ *
+ * @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 );
}
-/**
- * WordPress User Query class.
- *
- * @since 3.1.0
- */
-class WP_User_Query {
-
- /**
- * List of found user ids
- *
- * @since 3.1.0
- * @access private
- * @var array
- */
- var $results;
-
- /**
- * Total number of found users for the current query
- *
- * @since 3.1.0
- * @access private
- * @var int
- */
- var $total_users = 0;
-
- // SQL clauses
- var $query_fields;
- var $query_from;
- var $query_where;
- var $query_orderby;
- var $query_limit;
-
-
- /**
- * PHP5 constructor
- *
- * @since 3.1.0
- *
- * @param string|array $args The query variables
- * @return WP_User_Query
- */
- function __construct( $query = null ) {
- if ( !empty( $query ) ) {
- $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' => '',
- 'orderby' => 'login',
- 'order' => 'ASC',
- 'offset' => '',
- 'number' => '',
- 'count_total' => true,
- 'fields' => 'all',
- 'who' => ''
- ) );
-
- $this->prepare_query();
- $this->query();
- }
- }
-
- /**
- * Prepare the query variables
- *
- * @since 3.1.0
- * @access private
- */
- function prepare_query() {
- global $wpdb;
-
- $qv = &$this->query_vars;
-
- if ( is_array( $qv['fields'] ) ) {
- $qv['fields'] = array_unique( $qv['fields'] );
-
- $this->query_fields = array();
- foreach ( $qv['fields'] as $field )
- $this->query_fields[] = $wpdb->users . '.' . esc_sql( $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 ( $this->query_vars['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 ( 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';
- } else {
- $orderby = 'user_login';
- }
-
- $qv['order'] = strtoupper( $qv['order'] );
- if ( 'ASC' == $qv['order'] )
- $order = 'ASC';
- else
- $order = 'DESC';
- $this->query_orderby = "ORDER BY $orderby $order";
-
- // limit
- if ( $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 = 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, '*');
-
- if ( false !== strpos( $search, '@') )
- $search_columns = array('user_email');
- elseif ( is_numeric($search) )
- $search_columns = array('user_login', 'ID');
- elseif ( preg_match('|^https?://|', $search) )
- $search_columns = array('user_url');
- else
- $search_columns = array('user_login', 'user_nicename');
-
- $this->query_where .= $this->get_search_sql( $search, $search_columns, $wild );
- }
-
- $blog_id = absint( $qv['blog_id'] );
-
- if ( '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 = trim( $qv['role'] );
-
- if ( $blog_id && ( $role || is_multisite() ) ) {
- $cap_meta_query = array();
- $cap_meta_query['key'] = $wpdb->get_blog_prefix( $blog_id ) . 'capabilities';
-
- if ( $role ) {
- $cap_meta_query['value'] = '"' . $role . '"';
- $cap_meta_query['compare'] = 'like';
- }
-
- $qv['meta_query'][] = $cap_meta_query;
- }
-
- $meta_query = new WP_Meta_Query();
- $meta_query->parse_query_vars( $qv );
-
- if ( !empty( $meta_query->queries ) ) {
- $clauses = $meta_query->get_sql( 'user', $wpdb->users, 'ID', $this );
- $this->query_from .= $clauses['join'];
- $this->query_where .= $clauses['where'];
-
- if ( 'OR' == $meta_query->relation )
- $this->query_fields = 'DISTINCT ' . $this->query_fields;
- }
-
- if ( !empty( $qv['include'] ) ) {
- $ids = implode( ',', wp_parse_id_list( $qv['include'] ) );
- $this->query_where .= " AND $wpdb->users.ID IN ($ids)";
- } elseif ( !empty($qv['exclude']) ) {
- $ids = implode( ',', wp_parse_id_list( $qv['exclude'] ) );
- $this->query_where .= " AND $wpdb->users.ID NOT IN ($ids)";
- }
-
- do_action_ref_array( 'pre_user_query', array( &$this ) );
- }
-
- /**
- * Execute the query, with the current variables
- *
- * @since 3.1.0
- * @access private
- */
- function query() {
- global $wpdb;
-
- if ( is_array( $this->query_vars['fields'] ) || 'all' == $this->query_vars['fields'] ) {
- $this->results = $wpdb->get_results("SELECT $this->query_fields $this->query_from $this->query_where $this->query_orderby $this->query_limit");
- } else {
- $this->results = $wpdb->get_col("SELECT $this->query_fields $this->query_from $this->query_where $this->query_orderby $this->query_limit");
- }
-
- if ( $this->query_vars['count_total'] )
- $this->total_users = $wpdb->get_var( apply_filters( 'found_users_query', 'SELECT FOUND_ROWS()' ) );
-
- if ( !$this->results )
- return;
-
- if ( 'all_with_meta' == $this->query_vars['fields'] ) {
- cache_users( $this->results );
-
- $r = array();
- foreach ( $this->results as $userid )
- $r[ $userid ] = new WP_User( $userid, '', $this->query_vars['blog_id'] );
-
- $this->results = $r;
- }
- }
-
- /*
- * 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
- */
- function get_search_sql( $string, $cols, $wild = false ) {
- $string = esc_sql( $string );
-
- $searches = array();
- $leading_wild = ( 'leading' == $wild || 'both' == $wild ) ? '%' : '';
- $trailing_wild = ( 'trailing' == $wild || 'both' == $wild ) ? '%' : '';
- foreach ( $cols as $col ) {
- if ( 'ID' == $col )
- $searches[] = "$col = '$string'";
- else
- $searches[] = "$col LIKE '$leading_wild" . like_escape($string) . "$trailing_wild'";
- }
-
- return ' AND (' . implode(' OR ', $searches) . ')';
- }
-
- /**
- * Return the list of users
- *
- * @since 3.1.0
- * @access public
- *
- * @return array
- */
- function get_results() {
- return $this->results;
- }
-
- /**
- * Return the total number of users for the current query
- *
- * @since 3.1.0
- * @access public
- *
- * @return array
- */
- function get_total() {
- return $this->total_users;
- }
-}
-
/**
* Retrieve list of users matching criteria.
*
* @since 3.1.0
- * @uses $wpdb
- * @uses WP_User_Query See for default arguments and information.
*
- * @param array $args Optional.
+ * @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( $args = array() ) {
@@ -645,9 +561,13 @@ function get_users( $args = array() ) {
*
* @since 3.0.0
*
- * @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. False if the user was not found or an empty array if the user has no blogs.
+ * @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
+ * 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;
@@ -656,11 +576,11 @@ function get_blogs_of_user( $user_id, $all = false ) {
// Logged out users can't have blogs
if ( empty( $user_id ) )
- return false;
+ return array();
$keys = get_user_meta( $user_id );
if ( empty( $keys ) )
- return false;
+ return array();
if ( ! is_multisite() ) {
$blog_id = get_current_blog_id();
@@ -671,6 +591,9 @@ function get_blogs_of_user( $user_id, $all = false ) {
$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;
}
@@ -686,6 +609,10 @@ function get_blogs_of_user( $user_id, $all = false ) {
'path' => $blog->path,
'site_id' => $blog->site_id,
'siteurl' => $blog->siteurl,
+ 'archived' => $blog->archived,
+ 'mature' => $blog->mature,
+ 'spam' => $blog->spam,
+ 'deleted' => $blog->deleted,
);
}
unset( $keys[ $wpdb->base_prefix . 'capabilities' ] );
@@ -712,10 +639,24 @@ function get_blogs_of_user( $user_id, $all = false ) {
'path' => $blog->path,
'site_id' => $blog->site_id,
'siteurl' => $blog->siteurl,
+ 'archived' => $blog->archived,
+ 'mature' => $blog->mature,
+ 'spam' => $blog->spam,
+ 'deleted' => $blog->deleted,
);
}
}
+ /**
+ * 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 );
}
@@ -723,27 +664,64 @@ function get_blogs_of_user( $user_id, $all = false ) {
* 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 The unique ID of the user
- * @param int $blog Optional. If no blog_id is provided, current site is used
+ * @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();
+ }
+
+ // 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 ( empty( $blog_id ) )
+ if ( ! is_multisite() ) {
+ return true;
+ }
+
+ if ( empty( $blog_id ) ) {
$blog_id = get_current_blog_id();
+ }
- $blogs = get_blogs_of_user( $user_id );
- if ( is_array( $blogs ) )
- return array_key_exists( $blog_id, $blogs );
- else
+ $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;
}
/**
@@ -752,14 +730,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 Post ID.
- * @param string $meta_key Metadata name.
- * @param mixed $meta_value Metadata value.
- * @param bool $unique Optional, default is false. Whether the same key should not be added.
- * @return bool False for failure. True for success.
+ * @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);
@@ -773,13 +750,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
+ * @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.
- * @return bool False for failure. True for success.
+ * @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 = '') {
return delete_metadata('user', $user_id, $meta_key, $meta_value);
@@ -789,14 +765,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 Post ID.
- * @param string $key The meta key to retrieve.
- * @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);
@@ -811,14 +785,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 $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.
+ * @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.
+ * @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);
@@ -828,16 +801,20 @@ 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_Query::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.
*
* @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();
@@ -845,18 +822,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[] = "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[] = "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.
@@ -872,25 +845,32 @@ 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'" );
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;
+ if ( empty( $b_roles ) ) {
+ $avail_roles['none']++;
+ }
+ foreach ( $b_roles as $b_role => $val ) {
+ if ( isset($avail_roles[$b_role]) ) {
+ $avail_roles[$b_role]++;
+ } else {
+ $avail_roles[$b_role] = 1;
}
}
}
@@ -899,6 +879,10 @@ function count_users($strategy = 'time') {
$result['avail_roles'] =& $avail_roles;
}
+ if ( is_multisite() ) {
+ $result['avail_roles']['none'] = 0;
+ }
+
return $result;
}
@@ -912,40 +896,39 @@ 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_pass_md5 MD5 of the user's password
+ *
+ * @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.
*/
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 = null;
- $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;
}
- $userdata = $user;
- $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;
}
/**
@@ -957,31 +940,53 @@ function setup_userdata($for_user_id = '') {
* used, either 'include' or 'exclude', but not both.
*
* The available arguments are as follows:
- *
- * - show_option_all - Text to show all and whether HTML option exists.
- * - show_option_none - Text for show none and whether HTML option exists.
- * - hide_if_only_one_author - Don't create the dropdown if there is only one user.
- * - orderby - SQL order by clause for what order the users appear. Default is 'display_name'.
- * - order - Default is 'ASC'. Can also be 'DESC'.
- * - include - User IDs to include.
- * - exclude - User IDs to exclude.
- * - multi - Default is 'false'. Whether to skip the ID attribute on the 'select' element. A 'true' value is overridden when id argument is set.
- * - show - Default is 'display_name'. User table column to display. If the selected item is empty then the user_login will be displayed in parentheses
- * - echo - Default is '1'. Whether to display or retrieve content.
- * - selected - Which User ID is selected.
- * - include_selected - Always include the selected user ID in the dropdown. Default is false.
- * - name - Default is 'user'. Name attribute of select element.
- * - id - Default is the value of the 'name' parameter. ID attribute of select element.
- * - class - Class attribute of select element.
- * - blog_id - ID of blog (Multisite only). Defaults to ID of current blog.
- * - who - Which users to query. Currently only 'authors' is supported. Default is all users.
- *
*
* @since 2.3.0
- * @uses $wpdb WordPress database object for queries
- *
- * @param string|array $args Optional. Override defaults.
- * @return string|null Null on display. String of HTML content on retrieve.
+ * @since 4.5.0 Added the 'display_name_with_login' value for 'show'.
+ *
+ * @global int $blog_id
+ *
+ * @param array|string $args {
+ * Optional. Array or string of arguments to generate a drop-down of users.
+ * {@see WP_User_Query::prepare_query() for additional available arguments.
+ *
+ * @type string $show_option_all Text to show as the drop-down default (all).
+ * Default empty.
+ * @type string $show_option_none Text to show as the drop-down default when no
+ * users were found. Default empty.
+ * @type int|string $option_none_value Value to use for $show_option_non when no users
+ * were found. Default -1.
+ * @type string $hide_if_only_one_author Whether to skip generating the drop-down
+ * if only one user was found. Default empty.
+ * @type string $orderby Field to order found users by. Accepts user fields.
+ * Default 'display_name'.
+ * @type string $order Whether to order users in ascending or descending
+ * order. Accepts 'ASC' (ascending) or 'DESC' (descending).
+ * Default 'ASC'.
+ * @type array|string $include Array or comma-separated list of user IDs to include.
+ * Default empty.
+ * @type array|string $exclude Array or comma-separated list of user IDs to exclude.
+ * Default empty.
+ * @type bool|int $multi Whether to skip the ID attribute on the 'select' element.
+ * Accepts 1|true or 0|false. Default 0|false.
+ * @type string $show User data to display. If the selected item is empty
+ * then the 'user_login' will be displayed in parentheses.
+ * 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.
+ * @type bool $include_selected Whether to always include the selected user ID in the drop-
+ * down. Default false.
+ * @type string $name Name attribute of select element. Default 'user'.
+ * @type string $id ID attribute of the select element. Default is the value of $name.
+ * @type string $class Class attribute of the select element. Default empty.
+ * @type int $blog_id ID of blog (Multisite only). Default is ID of the current blog.
+ * @type string $who Which type of users to query. Accepts only an empty string or
+ * 'authors'. Default empty.
+ * }
+ * @return string String of HTML content.
*/
function wp_dropdown_users( $args = '' ) {
$defaults = array(
@@ -990,62 +995,107 @@ 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
+ 'blog_id' => $GLOBALS['blog_id'], 'who' => '', 'include_selected' => false,
+ 'option_none_value' => -1
);
$defaults['selected'] = is_author() ? get_query_var( 'author' ) : 0;
$r = wp_parse_args( $args, $defaults );
- extract( $r, EXTR_SKIP );
$query_args = wp_array_slice_assoc( $r, array( 'blog_id', 'include', 'exclude', 'orderby', 'order', 'who' ) );
- $query_args['fields'] = array( 'ID', $show );
+
+ $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'];
+
+ /**
+ * 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 = '';
- if ( !empty($users) && ( empty($hide_if_only_one_author) || count($users) > 1 ) ) {
- $name = esc_attr( $name );
- if ( $multi && ! $id )
+ if ( ! empty( $users ) && ( empty( $r['hide_if_only_one_author'] ) || count( $users ) > 1 ) ) {
+ $name = esc_attr( $r['name'] );
+ if ( $r['multi'] && ! $r['id'] ) {
$id = '';
- else
- $id = $id ? " id='" . esc_attr( $id ) . "'" : " id='$name'";
-
- $output = "