X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/41578db67d72562346e4dbb2a14889b23d522813..7f1521bf193b382565eb753043c161f4cb3fcda7:/wp-includes/user.php
diff --git a/wp-includes/user.php b/wp-includes/user.php
index 5a9dc466..e602a3ec 100644
--- a/wp-includes/user.php
+++ b/wp-includes/user.php
@@ -19,8 +19,8 @@
*
* @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.
+ * @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 = array(), $secure_cookie = '' ) {
@@ -112,7 +112,7 @@ function wp_signon( $credentials = array(), $secure_cookie = '' ) {
* @return WP_User|WP_Error WP_User on success, WP_Error on failure.
*/
function wp_authenticate_username_password($user, $username, $password) {
- if ( is_a( $user, 'WP_User' ) ) {
+ if ( $user instanceof WP_User ) {
return $user;
}
@@ -134,7 +134,7 @@ function wp_authenticate_username_password($user, $username, $password) {
$user = get_user_by('login', $username);
if ( !$user )
- return new WP_Error( 'invalid_username', sprintf( __( 'ERROR: Invalid username. Lost your password?' ), wp_lostpassword_url() ) );
+ 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.
@@ -150,7 +150,7 @@ function wp_authenticate_username_password($user, $username, $password) {
return $user;
if ( !wp_check_password($password, $user->user_pass, $user->ID) )
- return new WP_Error( 'incorrect_password', sprintf( __( 'ERROR: The password you entered for the username %1$s is incorrect. Lost your password?' ),
+ 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() ) );
return $user;
@@ -167,7 +167,7 @@ function wp_authenticate_username_password($user, $username, $password) {
* @return WP_User|WP_Error WP_User on success, WP_Error on failure.
*/
function wp_authenticate_cookie($user, $username, $password) {
- if ( is_a( $user, 'WP_User' ) ) {
+ if ( $user instanceof WP_User ) {
return $user;
}
@@ -202,7 +202,7 @@ function wp_authenticate_cookie($user, $username, $password) {
* @return WP_User|WP_Error WP_User on success, WP_Error if the user is considered a spammer.
*/
function wp_authenticate_spam_check( $user ) {
- if ( $user && is_a( $user, 'WP_User' ) && is_multisite() ) {
+ if ( $user instanceof WP_User && is_multisite() ) {
/**
* Filter whether the user has been marked as a spammer.
*
@@ -229,7 +229,7 @@ function wp_authenticate_spam_check( $user ) {
*
* @since 3.9.0
*
- * @param int|bool $user The user ID (or false) as received from the
+ * @param int|bool $user_id The user ID (or false) as received from the
* determine_current_user filter.
* @return int|bool User ID if validated, false otherwise. If a user ID from
* an earlier filter callback is received, that value is returned.
@@ -250,16 +250,18 @@ function wp_validate_logged_in_cookie( $user_id ) {
* Number of posts user has written.
*
* @since 3.0.0
+ * @since 4.1.0 Added `$post_type` argument.
*
* @global wpdb $wpdb WordPress database object for queries.
*
- * @param int $userid User ID.
- * @return int Amount of posts user has written.
+ * @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" );
@@ -267,11 +269,13 @@ function count_user_posts($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 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 );
+ return apply_filters( 'get_usernumposts', $count, $userid, $post_type );
}
/**
@@ -316,8 +320,6 @@ function count_many_users_posts( $users, $post_type = 'post', $public_only = fal
*
* @since MU
*
- * @uses wp_get_current_user
- *
* @return int The current user's ID
*/
function get_current_user_id() {
@@ -343,7 +345,7 @@ function get_current_user_id() {
*
* @param string $option User option name.
* @param int $user Optional. User ID.
- * @param bool $deprecated Use get_option() to check for an option in the options table.
+ * @param string $deprecated Use get_option() to check for an option in the options table.
* @return mixed User option value on success, false on failure.
*/
function get_user_option( $option, $user = 0, $deprecated = '' ) {
@@ -369,7 +371,7 @@ function get_user_option( $option, $user = 0, $deprecated = '' ) {
/**
* Filter a specific user option value.
*
- * The dynamic portion of the hook name, $option, refers to the user option name.
+ * The dynamic portion of the hook name, `$option`, refers to the user option name.
*
* @since 2.5.0
*
@@ -439,6 +441,8 @@ function delete_user_option( $user_id, $option_name, $global = false ) {
* WordPress User Query class.
*
* @since 3.1.0
+ *
+ * @see WP_User_Query::prepare_query() for information on accepted arguments.
*/
class WP_User_Query {
@@ -449,7 +453,7 @@ class WP_User_Query {
* @access public
* @var array
*/
- var $query_vars = array();
+ public $query_vars = array();
/**
* List of found user ids
@@ -458,7 +462,7 @@ class WP_User_Query {
* @access private
* @var array
*/
- var $results;
+ private $results;
/**
* Total number of found users for the current query
@@ -467,24 +471,34 @@ class WP_User_Query {
* @access private
* @var int
*/
- var $total_users = 0;
+ private $total_users = 0;
+
+ /**
+ * Metadata query container.
+ *
+ * @since 4.2.0
+ * @access public
+ * @var object WP_Meta_Query
+ */
+ public $meta_query = false;
+
+ private $compat_fields = array( 'results', 'total_users' );
// SQL clauses
- var $query_fields;
- var $query_from;
- var $query_where;
- var $query_orderby;
- var $query_limit;
+ public $query_fields;
+ public $query_from;
+ public $query_where;
+ public $query_orderby;
+ public $query_limit;
/**
* PHP5 constructor.
*
* @since 3.1.0
*
- * @param string|array $args Optional. The query variables.
- * @return WP_User_Query
+ * @param null|string|array $args Optional. The query variables.
*/
- function __construct( $query = null ) {
+ public function __construct( $query = null ) {
if ( ! empty( $query ) ) {
$this->prepare_query( $query );
$this->query();
@@ -495,10 +509,56 @@ class WP_User_Query {
* Prepare the query variables.
*
* @since 3.1.0
+ * @since 4.2.0 Added 'meta_value_num' support for `$orderby` parameter. Added multi-dimensional array syntax
+ * for `$orderby` parameter.
+ * @access public
*
- * @param string|array $args Optional. The query variables.
+ * @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).
+ * }
*/
- function prepare_query( $query = array() ) {
+ public function prepare_query( $query = array() ) {
global $wpdb;
if ( empty( $this->query_vars ) || ! empty( $query ) ) {
@@ -523,6 +583,19 @@ class WP_User_Query {
) );
}
+ /**
+ * Fires before the WP_User_Query has been parsed.
+ *
+ * The passed WP_User_Query object contains the query variables, not
+ * yet passed into SQL.
+ *
+ * @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'] ) ) {
@@ -546,43 +619,111 @@ class WP_User_Query {
$this->query_from = "FROM $wpdb->users";
$this->query_where = "WHERE 1=1";
+ // Parse and sanitize 'include', for use by 'orderby' as well as 'include' below.
+ if ( ! empty( $qv['include'] ) ) {
+ $include = wp_parse_id_list( $qv['include'] );
+ } else {
+ $include = false;
+ }
+
+ $blog_id = 0;
+ if ( isset( $qv['blog_id'] ) ) {
+ $blog_id = absint( $qv['blog_id'] );
+ }
+
+ if ( isset( $qv['who'] ) && 'authors' == $qv['who'] && $blog_id ) {
+ $qv['meta_key'] = $wpdb->get_blog_prefix( $blog_id ) . 'user_level';
+ $qv['meta_value'] = 0;
+ $qv['meta_compare'] = '!=';
+ $qv['blog_id'] = $blog_id = 0; // Prevent extra meta query
+ }
+
+ // Meta query.
+ $this->meta_query = new WP_Meta_Query();
+ $this->meta_query->parse_query_vars( $qv );
+
+ $role = '';
+ if ( isset( $qv['role'] ) ) {
+ $role = trim( $qv['role'] );
+ }
+
+ if ( $blog_id && ( $role || is_multisite() ) ) {
+ $cap_meta_query = array();
+ $cap_meta_query['key'] = $wpdb->get_blog_prefix( $blog_id ) . 'capabilities';
+
+ if ( $role ) {
+ $cap_meta_query['value'] = '"' . $role . '"';
+ $cap_meta_query['compare'] = 'like';
+ }
+
+ if ( empty( $this->meta_query->queries ) ) {
+ $this->meta_query->queries = array( $cap_meta_query );
+ } elseif ( ! in_array( $cap_meta_query, $this->meta_query->queries, true ) ) {
+ // Append the cap query to the original queries and reparse the query.
+ $this->meta_query->queries = array(
+ 'relation' => 'AND',
+ array( $this->meta_query->queries, $cap_meta_query ),
+ );
+ }
+
+ $this->meta_query->parse_query_vars( $this->meta_query->queries );
+ }
+
+ if ( ! empty( $this->meta_query->queries ) ) {
+ $clauses = $this->meta_query->get_sql( 'user', $wpdb->users, 'ID', $this );
+ $this->query_from .= $clauses['join'];
+ $this->query_where .= $clauses['where'];
+
+ if ( 'OR' == $this->meta_query->relation ) {
+ $this->query_fields = 'DISTINCT ' . $this->query_fields;
+ }
+ }
+
// sorting
- if ( isset( $qv['orderby'] ) ) {
- 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";
+ $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 );
+ } else if ( 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 {
- $orderby = 'user_login';
+ // Non-integer key means this the key is the field and the value is ASC/DESC.
+ $_orderby = $_key;
+ $_order = $_value;
}
+
+ $parsed = $this->parse_orderby( $_orderby );
+
+ if ( ! $parsed ) {
+ continue;
+ }
+
+ $orderby_array[] = $parsed . ' ' . $this->parse_order( $_order );
}
- if ( empty( $orderby ) )
- $orderby = 'user_login';
+ // If no valid clauses were found, order by user_login.
+ if ( empty( $orderby_array ) ) {
+ $orderby_array[] = "user_login $order";
+ }
- $qv['order'] = isset( $qv['order'] ) ? strtoupper( $qv['order'] ) : '';
- if ( 'ASC' == $qv['order'] )
- $order = 'ASC';
- else
- $order = 'DESC';
- $this->query_orderby = "ORDER BY $orderby $order";
+ $this->query_orderby = 'ORDER BY ' . implode( ', ', $orderby_array );
// limit
if ( isset( $qv['number'] ) && $qv['number'] ) {
@@ -641,55 +782,21 @@ class WP_User_Query {
$this->query_where .= $this->get_search_sql( $search, $search_columns, $wild );
}
- $blog_id = 0;
- if ( isset( $qv['blog_id'] ) )
- $blog_id = absint( $qv['blog_id'] );
-
- if ( isset( $qv['who'] ) && 'authors' == $qv['who'] && $blog_id ) {
- $qv['meta_key'] = $wpdb->get_blog_prefix( $blog_id ) . 'user_level';
- $qv['meta_value'] = 0;
- $qv['meta_compare'] = '!=';
- $qv['blog_id'] = $blog_id = 0; // Prevent extra meta query
- }
-
- $role = '';
- if ( isset( $qv['role'] ) )
- $role = trim( $qv['role'] );
-
- if ( $blog_id && ( $role || is_multisite() ) ) {
- $cap_meta_query = array();
- $cap_meta_query['key'] = $wpdb->get_blog_prefix( $blog_id ) . 'capabilities';
-
- if ( $role ) {
- $cap_meta_query['value'] = '"' . $role . '"';
- $cap_meta_query['compare'] = 'like';
- }
-
- if ( empty( $qv['meta_query'] ) || ! in_array( $cap_meta_query, $qv['meta_query'], true ) ) {
- $qv['meta_query'][] = $cap_meta_query;
- }
- }
-
- $meta_query = new WP_Meta_Query();
- $meta_query->parse_query_vars( $qv );
-
- if ( !empty( $meta_query->queries ) ) {
- $clauses = $meta_query->get_sql( 'user', $wpdb->users, 'ID', $this );
- $this->query_from .= $clauses['join'];
- $this->query_where .= $clauses['where'];
-
- if ( 'OR' == $meta_query->relation )
- $this->query_fields = 'DISTINCT ' . $this->query_fields;
- }
-
- if ( ! empty( $qv['include'] ) ) {
- $ids = implode( ',', wp_parse_id_list( $qv['include'] ) );
+ 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.
@@ -712,7 +819,7 @@ class WP_User_Query {
*
* @global wpdb $wpdb WordPress database object for queries.
*/
- function query() {
+ public function query() {
global $wpdb;
$qv =& $this->query_vars;
@@ -730,7 +837,7 @@ class WP_User_Query {
*
* @since 3.2.0
*
- * @global wpdb $wpdb WordPress database object.
+ * @global wpdb $wpdb WordPress database abstraction object.
*
* @param string $sql The SELECT FOUND_ROWS() query for the current WP_User_Query.
*/
@@ -750,7 +857,7 @@ class WP_User_Query {
$this->results = $r;
} elseif ( 'all' == $qv['fields'] ) {
foreach ( $this->results as $key => $user ) {
- $this->results[ $key ] = new WP_User( $user );
+ $this->results[ $key ] = new WP_User( $user, '', $qv['blog_id'] );
}
}
}
@@ -764,7 +871,7 @@ class WP_User_Query {
* @param string $query_var Query variable key.
* @return mixed
*/
- function get( $query_var ) {
+ public function get( $query_var ) {
if ( isset( $this->query_vars[$query_var] ) )
return $this->query_vars[$query_var];
@@ -780,7 +887,7 @@ class WP_User_Query {
* @param string $query_var Query variable key.
* @param mixed $value Query variable value.
*/
- function set( $query_var, $value ) {
+ public function set( $query_var, $value ) {
$this->query_vars[$query_var] = $value;
}
@@ -796,17 +903,20 @@ class WP_User_Query {
* 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 );
+ 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[] = "$col = '$string'";
- else
- $searches[] = "$col LIKE '$leading_wild" . like_escape($string) . "$trailing_wild'";
+ if ( 'ID' == $col ) {
+ $searches[] = $wpdb->prepare( "$col = %s", $string );
+ } else {
+ $searches[] = $wpdb->prepare( "$col LIKE %s", $like );
+ }
}
return ' AND (' . implode(' OR ', $searches) . ')';
@@ -820,7 +930,7 @@ class WP_User_Query {
*
* @return array Array of results.
*/
- function get_results() {
+ public function get_results() {
return $this->results;
}
@@ -830,11 +940,161 @@ class WP_User_Query {
* @since 3.1.0
* @access public
*
- * @return array Array of total users.
+ * @return int Number of total users.
*/
- function get_total() {
+ public function get_total() {
return $this->total_users;
}
+
+ /**
+ * Parse and sanitize 'orderby' keys passed to the user query.
+ *
+ * @since 4.2.0
+ * @access protected
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param string $orderby Alias for the field to order by.
+ * @return string|bool Value to used in the ORDER clause, if `$orderby` is valid. False otherwise.
+ */
+ protected function parse_orderby( $orderby ) {
+ global $wpdb;
+
+ $meta_query_clauses = $this->meta_query->get_clauses();
+
+ $_orderby = '';
+ if ( in_array( $orderby, array( 'login', 'nicename', 'email', 'url', 'registered' ) ) ) {
+ $_orderby = 'user_' . $orderby;
+ } elseif ( in_array( $orderby, array( 'user_login', 'user_nicename', 'user_email', 'user_url', 'user_registered' ) ) ) {
+ $_orderby = $orderby;
+ } elseif ( 'name' == $orderby || 'display_name' == $orderby ) {
+ $_orderby = 'display_name';
+ } elseif ( 'post_count' == $orderby ) {
+ // todo: avoid the JOIN
+ $where = get_posts_by_author_sql( 'post' );
+ $this->query_from .= " LEFT OUTER JOIN (
+ SELECT post_author, COUNT(*) as post_count
+ FROM $wpdb->posts
+ $where
+ GROUP BY post_author
+ ) p ON ({$wpdb->users}.ID = p.post_author)
+ ";
+ $_orderby = 'post_count';
+ } elseif ( 'ID' == $orderby || 'id' == $orderby ) {
+ $_orderby = 'ID';
+ } elseif ( 'meta_value' == $orderby || $this->get( 'meta_key' ) == $orderby ) {
+ $_orderby = "$wpdb->usermeta.meta_value";
+ } elseif ( 'meta_value_num' == $orderby ) {
+ $_orderby = "$wpdb->usermeta.meta_value+0";
+ } elseif ( 'include' === $orderby && ! empty( $this->query_vars['include'] ) ) {
+ $include = wp_parse_id_list( $this->query_vars['include'] );
+ $include_sql = implode( ',', $include );
+ $_orderby = "FIELD( $wpdb->users.ID, $include_sql )";
+ } elseif ( isset( $meta_query_clauses[ $orderby ] ) ) {
+ $meta_clause = $meta_query_clauses[ $orderby ];
+ $_orderby = sprintf( "CAST(%s.meta_value AS %s)", esc_sql( $meta_clause['alias'] ), esc_sql( $meta_clause['cast'] ) );
+ }
+
+ return $_orderby;
+ }
+
+ /**
+ * Parse an 'order' query variable and cast it to ASC or DESC as necessary.
+ *
+ * @since 4.2.0
+ * @access protected
+ *
+ * @param string $order The 'order' query variable.
+ * @return string The sanitized 'order' query variable.
+ */
+ protected function parse_order( $order ) {
+ if ( ! is_string( $order ) || empty( $order ) ) {
+ return 'DESC';
+ }
+
+ if ( 'ASC' === strtoupper( $order ) ) {
+ return 'ASC';
+ } else {
+ return 'DESC';
+ }
+ }
+
+ /**
+ * Make private properties readable for backwards compatibility.
+ *
+ * @since 4.0.0
+ * @access public
+ *
+ * @param string $name Property to get.
+ * @return mixed Property.
+ */
+ public function __get( $name ) {
+ if ( in_array( $name, $this->compat_fields ) ) {
+ return $this->$name;
+ }
+ }
+
+ /**
+ * Make private properties settable for backwards compatibility.
+ *
+ * @since 4.0.0
+ * @access public
+ *
+ * @param string $name Property to check if set.
+ * @param mixed $value Property value.
+ * @return mixed Newly-set property.
+ */
+ public function __set( $name, $value ) {
+ if ( in_array( $name, $this->compat_fields ) ) {
+ return $this->$name = $value;
+ }
+ }
+
+ /**
+ * Make private properties checkable for backwards compatibility.
+ *
+ * @since 4.0.0
+ * @access public
+ *
+ * @param string $name Property to check if set.
+ * @return bool Whether the property is set.
+ */
+ public function __isset( $name ) {
+ if ( in_array( $name, $this->compat_fields ) ) {
+ return isset( $this->$name );
+ }
+ }
+
+ /**
+ * Make private properties un-settable for backwards compatibility.
+ *
+ * @since 4.0.0
+ * @access public
+ *
+ * @param string $name Property to unset.
+ */
+ public function __unset( $name ) {
+ if ( in_array( $name, $this->compat_fields ) ) {
+ unset( $this->$name );
+ }
+ }
+
+ /**
+ * Make private/protected methods readable for backwards compatibility.
+ *
+ * @since 4.0.0
+ * @access public
+ *
+ * @param callable $name Method to call.
+ * @param array $arguments Arguments to pass when calling.
+ * @return mixed|bool Return value of the callback, false otherwise.
+ */
+ public function __call( $name, $arguments ) {
+ if ( 'get_search_sql' === $name ) {
+ return call_user_func_array( array( $this, $name ), $arguments );
+ }
+ return false;
+ }
}
/**
@@ -842,9 +1102,10 @@ class WP_User_Query {
*
* @since 3.1.0
*
- * @uses WP_User_Query See for default arguments and information.
+ * @see WP_User_Query
*
- * @param array $args Optional. Array of arguments.
+ * @param array $args Optional. Arguments to retrieve users. See {@see WP_User_Query::prepare_query()}
+ * for more information on accepted arguments.
* @return array List of users.
*/
function get_users( $args = array() ) {
@@ -963,7 +1224,6 @@ 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 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.
@@ -989,8 +1249,7 @@ 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
+ * @link https://codex.wordpress.org/Function_Reference/add_user_meta
*
* @param int $user_id User ID.
* @param string $meta_key Metadata name.
@@ -1010,8 +1269,7 @@ 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.
@@ -1026,8 +1284,7 @@ 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
+ * @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.
@@ -1048,8 +1305,7 @@ function get_user_meta($user_id, $key = '', $single = false) {
* If the meta field for the user does not exist, it will be added.
*
* @since 3.0.0
- * @uses update_metadata
- * @link http://codex.wordpress.org/Function_Reference/update_user_meta
+ * @link https://codex.wordpress.org/Function_Reference/update_user_meta
*
* @param int $user_id User ID.
* @param string $meta_key Metadata key.
@@ -1092,7 +1348,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);
@@ -1192,33 +1448,49 @@ 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
*
* @global wpdb $wpdb WordPress database object for queries.
*
- * @todo Hash-notate arguments array.
- *
- * @param string|array $args Optional. Array of user arguments.
+ * @param array|string $args {
+ * Optional. Array or string of arguments to generate a drop-down of users.
+ * {@see WP_User_Query::prepare_query() for additional available arguments.
+ *
+ * @type string $show_option_all Text to show as the drop-down default (all).
+ * Default empty.
+ * @type string $show_option_none Text to show as the drop-down default when no
+ * users were found. Default empty.
+ * @type int|string $option_none_value Value to use for $show_option_non when no users
+ * were found. Default -1.
+ * @type string $hide_if_only_one_author Whether to skip generating the drop-down
+ * if only one user was found. Default empty.
+ * @type string $orderby Field to order found users by. Accepts user fields.
+ * Default 'display_name'.
+ * @type string $order Whether to order users in ascending or descending
+ * order. Accepts 'ASC' (ascending) or 'DESC' (descending).
+ * Default 'ASC'.
+ * @type array|string $include Array or comma-separated list of user IDs to include.
+ * Default empty.
+ * @type array|string $exclude Array or comma-separated list of user IDs to exclude.
+ * Default empty.
+ * @type bool|int $multi Whether to skip the ID attribute on the 'select' element.
+ * Accepts 1|true or 0|false. Default 0|false.
+ * @type string $show User table column to display. If the selected item is empty
+ * then the 'user_login' will be displayed in parentheses.
+ * Accepts user fields. Default 'display_name'.
+ * @type int|bool $echo Whether to echo or return the drop-down. Accepts 1|true (echo)
+ * or 0|false (return). Default 1|true.
+ * @type int $selected Which user ID should be selected. Default 0.
+ * @type bool $include_selected Whether to always include the selected user ID in the drop-
+ * down. Default false.
+ * @type string $name Name attribute of select element. Default 'user'.
+ * @type string $id ID attribute of the select element. Default is the value of $name.
+ * @type string $class Class attribute of the select element. Default empty.
+ * @type int $blog_id ID of blog (Multisite only). Default is ID of the current blog.
+ * @type string $who Which type of users to query. Accepts only an empty string or
+ * 'authors'. Default empty.
+ * }
* @return string|null Null on display. String of HTML content on retrieve.
*/
function wp_dropdown_users( $args = '' ) {
@@ -1228,51 +1500,57 @@ 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 );
+ $show = $r['show'];
+ $show_option_all = $r['show_option_all'];
+ $show_option_none = $r['show_option_none'];
+ $option_none_value = $r['option_none_value'];
$query_args = wp_array_slice_assoc( $r, array( 'blog_id', 'include', 'exclude', 'orderby', 'order', 'who' ) );
$query_args['fields'] = array( 'ID', 'user_login', $show );
$users = get_users( $query_args );
$output = '';
- if ( !empty($users) && ( empty($hide_if_only_one_author) || count($users) > 1 ) ) {
- $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 = "