X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/fa11948979fd6a4ea5705dc613b239699a459db3..refs/tags/wordpress-4.0:/wp-includes/user.php
diff --git a/wp-includes/user.php b/wp-includes/user.php
index 9a60cd20..af028645 100644
--- a/wp-includes/user.php
+++ b/wp-includes/user.php
@@ -3,6 +3,7 @@
* WordPress User API
*
* @package WordPress
+ * @subpackage Users
*/
/**
@@ -20,9 +21,9 @@
*
* @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.
+ * @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,13 +38,40 @@ 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();
- $secure_cookie = apply_filters('secure_signon_cookie', $secure_cookie, $credentials);
+ /**
+ * 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;
@@ -61,16 +89,32 @@ function wp_signon( $credentials = '', $secure_cookie = '' ) {
}
wp_set_auth_cookie($user->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.
+ *
+ * @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 ) )
@@ -90,14 +134,23 @@ 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() ) );
- $user = apply_filters('wp_authenticate_user', $user, $password);
+ /**
+ * 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( __( '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;
@@ -105,9 +158,18 @@ function wp_authenticate_username_password($user, $username, $password) {
/**
* 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();
@@ -131,13 +193,24 @@ function wp_authenticate_cookie($user, $username, $password) {
}
/**
- * For multisite blogs, check if the authenticated user has been marked as a
+ * 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 )
@@ -146,11 +219,39 @@ function wp_authenticate_spam_check( $user ) {
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 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.
+ *
+ * @global wpdb $wpdb WordPress database object for queries.
*
* @param int $userid User ID.
* @return int Amount of posts user has written.
@@ -162,7 +263,15 @@ function count_user_posts($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
+ *
+ * @param int $count The user's post count.
+ * @param int $userid User ID.
+ */
+ return apply_filters( 'get_usernumposts', $count, $userid );
}
/**
@@ -212,6 +321,8 @@ function count_many_users_posts( $users, $post_type = 'post', $public_only = fal
* @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 );
}
@@ -227,14 +338,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 bool $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;
@@ -256,7 +366,18 @@ function get_user_option( $option, $user = 0, $deprecated = '' ) {
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 );
}
/**
@@ -269,13 +390,16 @@ 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;
@@ -294,12 +418,14 @@ 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;
@@ -323,7 +449,7 @@ class WP_User_Query {
* @access public
* @var array
*/
- var $query_vars = array();
+ public $query_vars = array();
/**
* List of found user ids
@@ -332,7 +458,7 @@ class WP_User_Query {
* @access private
* @var array
*/
- var $results;
+ private $results;
/**
* Total number of found users for the current query
@@ -341,25 +467,42 @@ class WP_User_Query {
* @access private
* @var int
*/
- var $total_users = 0;
+ private $total_users = 0;
// 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
+ * PHP5 constructor.
*
* @since 3.1.0
*
- * @param string|array $args The query variables
+ * @param string|array $args Optional. The query variables.
* @return WP_User_Query
*/
- function __construct( $query = null ) {
- if ( !empty( $query ) ) {
+ public function __construct( $query = null ) {
+ if ( ! empty( $query ) ) {
+ $this->prepare_query( $query );
+ $this->query();
+ }
+ }
+
+ /**
+ * Prepare the query variables.
+ *
+ * @since 3.1.0
+ *
+ * @param string|array $args Optional. The query variables.
+ */
+ public function prepare_query( $query = array() ) {
+ global $wpdb;
+
+ if ( empty( $this->query_vars ) || ! empty( $query ) ) {
+ $this->query_limit = null;
$this->query_vars = wp_parse_args( $query, array(
'blog_id' => $GLOBALS['blog_id'],
'role' => '',
@@ -378,20 +521,20 @@ class WP_User_Query {
'fields' => 'all',
'who' => ''
) );
-
- $this->prepare_query();
- $this->query();
}
- }
- /**
- * Prepare the query variables
- *
- * @since 3.1.0
- * @access private
- */
- function prepare_query() {
- global $wpdb;
+ /**
+ * 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;
@@ -494,6 +637,18 @@ class WP_User_Query {
$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 );
@@ -523,7 +678,9 @@ class WP_User_Query {
$cap_meta_query['compare'] = 'like';
}
- $qv['meta_query'][] = $cap_meta_query;
+ 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();
@@ -546,26 +703,50 @@ class WP_User_Query {
$this->query_where .= " AND $wpdb->users.ID NOT IN ($ids)";
}
+ /**
+ * Fires after the WP_User_Query has been parsed, and before
+ * the query is executed.
+ *
+ * The passed WP_User_Query object contains SQL parts formed
+ * from parsing the given query.
+ *
+ * @since 3.1.0
+ *
+ * @param WP_User_Query $this The current WP_User_Query instance,
+ * passed by reference.
+ */
do_action_ref_array( 'pre_user_query', array( &$this ) );
}
/**
- * Execute the query, with the current variables
+ * Execute the query, with the current variables.
*
* @since 3.1.0
- * @access private
+ *
+ * @global wpdb $wpdb WordPress database object for queries.
*/
- function query() {
+ 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("SELECT $this->query_fields $this->query_from $this->query_where $this->query_orderby $this->query_limit");
+ $this->results = $wpdb->get_results( $query );
} else {
- $this->results = $wpdb->get_col("SELECT $this->query_fields $this->query_from $this->query_where $this->query_orderby $this->query_limit");
+ $this->results = $wpdb->get_col( $query );
}
+ /**
+ * Filter SELECT FOUND_ROWS() query for the current WP_User_Query instance.
+ *
+ * @since 3.2.0
+ *
+ * @global wpdb $wpdb WordPress database object.
+ *
+ * @param string $sql The SELECT FOUND_ROWS() query for the current WP_User_Query.
+ */
if ( isset( $qv['count_total'] ) && $qv['count_total'] )
$this->total_users = $wpdb->get_var( apply_filters( 'found_users_query', 'SELECT FOUND_ROWS()' ) );
@@ -596,7 +777,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];
@@ -612,11 +793,11 @@ 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;
}
- /*
+ /**
* Used internally to generate an SQL string for searching across multiple columns
*
* @access protected
@@ -628,55 +809,124 @@ 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) . ')';
}
/**
- * Return the list of users
+ * Return the list of users.
*
* @since 3.1.0
* @access public
*
- * @return array
+ * @return array Array of results.
*/
- function get_results() {
+ public function get_results() {
return $this->results;
}
/**
- * Return the total number of users for the current query
+ * Return the total number of users for the current query.
*
* @since 3.1.0
* @access public
*
- * @return array
+ * @return array Array of total users.
*/
- function get_total() {
+ public function get_total() {
return $this->total_users;
}
+
+ /**
+ * Make private properties readable for backwards compatibility.
+ *
+ * @since 4.0.0
+ * @access public
+ *
+ * @param string $name Property to get.
+ * @return mixed Property.
+ */
+ public function __get( $name ) {
+ return $this->$name;
+ }
+
+ /**
+ * Make private properties settable for backwards compatibility.
+ *
+ * @since 4.0.0
+ * @access public
+ *
+ * @param string $name Property to set.
+ * @param mixed $value Property value.
+ * @return mixed Newly-set property.
+ */
+ public function __set( $name, $value ) {
+ return $this->$name = $value;
+ }
+
+ /**
+ * Make private properties checkable for backwards compatibility.
+ *
+ * @since 4.0.0
+ * @access public
+ *
+ * @param string $name Property to check if set.
+ * @return bool Whether the property is set.
+ */
+ public function __isset( $name ) {
+ return isset( $this->$name );
+ }
+
+ /**
+ * Make private properties un-settable for backwards compatibility.
+ *
+ * @since 4.0.0
+ * @access public
+ *
+ * @param string $name Property to unset.
+ */
+ public function __unset( $name ) {
+ unset( $this->$name );
+ }
+
+ /**
+ * Make private/protected methods readable for backwards compatibility.
+ *
+ * @since 4.0.0
+ * @access public
+ *
+ * @param callable $name Method to call.
+ * @param array $arguments Arguments to pass when calling.
+ * @return mixed|bool Return value of the callback, false otherwise.
+ */
+ public function __call( $name, $arguments ) {
+ return call_user_func_array( array( $this, $name ), $arguments );
+ }
}
/**
* Retrieve list of users matching criteria.
*
* @since 3.1.0
- * @uses $wpdb
+ *
* @uses WP_User_Query See for default arguments and information.
*
- * @param array $args Optional.
+ * @param array $args Optional. Array of arguments.
* @return array List of users.
*/
function get_users( $args = array() ) {
@@ -694,9 +944,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. An empty array if the user doesn't exist or belongs to no blogs.
+ * @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;
@@ -774,6 +1028,16 @@ function get_blogs_of_user( $user_id, $all = false ) {
}
}
+ /**
+ * 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 );
}
@@ -810,7 +1074,7 @@ function is_user_member_of_blog( $user_id = 0, $blog_id = 0 ) {
* @uses add_metadata()
* @link http://codex.wordpress.org/Function_Reference/add_user_meta
*
- * @param int $user_id Post ID.
+ * @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.
@@ -847,7 +1111,7 @@ function delete_user_meta($user_id, $meta_key, $meta_value = '') {
* @uses get_metadata()
* @link http://codex.wordpress.org/Function_Reference/get_user_meta
*
- * @param int $user_id Post ID.
+ * @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
@@ -869,11 +1133,11 @@ function get_user_meta($user_id, $key = '', $single = false) {
* @uses update_metadata
* @link http://codex.wordpress.org/Function_Reference/update_user_meta
*
- * @param int $user_id Post ID.
+ * @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 True on success, false on failure.
+ * @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);
@@ -910,7 +1174,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);
@@ -1010,30 +1274,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
- * @uses $wpdb WordPress database object for queries
*
- * @param string|array $args Optional. Override defaults.
+ * @global wpdb $wpdb WordPress database object for queries.
+ *
+ * @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 = '' ) {
@@ -1043,62 +1326,75 @@ 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 = "