$WP_User_Query = new WP_User_Query();
$WP_User_Query->prepare_query( $query );
$query(string|array)
Array or string of query parameters.
Default: array()
blog_id(int)
The site ID. Default: current site
role(string|string[])
An array or a comma-separated list of role names that users must match to be included in results. Note that this is an inclusive list: users must match each role. Default: ''
role__in(string[])
An array of role names. Matched users must have at least one of these roles. Default: empty array
role__not_in(string[])
An array of role names to exclude. Users matching one or more of these roles will not be included in results. Default: empty array
meta_key(string|string[])
Meta key or keys to filter by.
meta_value(string|string[])
Meta value or values to filter by.
meta_compare(string)
MySQL operator used for comparing the meta value. See WP_Meta_Query::__construct() for accepted values and default value.
meta_compare_key(string)
MySQL operator used for comparing the meta key. See WP_Meta_Query::__construct() for accepted values and default value.
meta_type(string)
MySQL data type that the meta_value column will be CAST to for comparisons. See WP_Meta_Query::__construct() for accepted values and default value.
meta_type_key(string)
MySQL data type that the meta_key column will be CAST to for comparisons. See WP_Meta_Query::__construct() for accepted values and default value.
meta_query(array)
An associative array of WP_Meta_Query arguments. See WP_Meta_Query::__construct() for accepted values.
capability(string|string[])
An array or a comma-separated list of capability names that users must match to be included in results. Note that this is an inclusive list: users must match each capability. Does NOT work for capabilities not in the database or filtered via {@see 'map_meta_cap'}. Default: ''
capability__in(string[])
An array of capability names. Matched users must have at least one of these capabilities. Does NOT work for capabilities not in the database or filtered via {@see 'map_meta_cap'}. Default: empty array
capability__not_in(string[])
An array of capability names to exclude. Users matching one or more of these capabilities will not be included in results. Does NOT work for capabilities not in the database or filtered via {@see 'map_meta_cap'}. Default: empty array
include(int[])
An array of user IDs to include. Default: empty array
exclude(int[])
An array of user IDs to exclude. Default: empty array
search(string)
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: ''
search_columns(string[])
Array of column names to be searched. Accepts 'ID', 'user_login', 'user_email', 'user_url', 'user_nicename', 'display_name'. Default: empty array
orderby(string|array)
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')
'include'
'user_login' (or 'login')
'login__in'
'user_nicename' (or 'nicename')
'nicename__in'
'user_email' (or 'email')
'user_url' (or 'url')
'user_registered' (or 'registered')
'post_count'
'meta_value'
'meta_value_num'
The value of $meta_key
An array key of $meta_query To use 'meta_value' or 'meta_value_num', $meta_key must be also be defined. Default: 'user_login'
order(string)
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'
offset(int)
Number of users to offset in retrieved results. Can be used in conjunction with pagination.
number(int)
Number of users to limit the query for. Can be used in conjunction with pagination. Value -1 (all) is supported, but should be used with caution on larger sites. Default: -1 (all users)
paged(int)
When used with number, defines the page of results to return. Default: 1
count_total(true|false)
Whether to count the total number of users found. If pagination is not needed, setting this to false can improve performance. Default: true
fields(string|string[])
Which fields to return. Single or all fields (string), or array of fields. Accepts:
'ID'
'display_name'
'user_login'
'user_nicename'
'user_email'
'user_url'
'user_registered'
'user_pass'
'user_activation_key'
'user_status'
'spam' (only available on multisite installs)
'deleted' (only available on multisite installs)
'all' for all fields and loads user meta.
'all_with_meta' Deprecated. Use 'all'. Default: 'all'
who(string)
Deprecated, use $capability instead. Type of users to query. Accepts 'authors'. Default: empty (all users)
has_published_posts(true|false|string[])
Pass an array of post types to filter results to users who have published posts in those post types. true is an alias for all public post types.
nicename(string)
The user nicename. Default: ''
nicename__in(string[])
An array of nicenames to include. Users matching one of these nicenames will be included in results. Default: empty array
nicename__not_in(string[])
An array of nicenames to exclude. Users matching one of these nicenames will not be included in results. Default: empty array
login(string)
The user login. Default: ''
login__in(string[])
An array of logins to include. Users matching one of these logins will be included in results. Default: empty array
login__not_in(string[])
An array of logins to exclude. Users matching one of these logins will not be included in results. Default: empty array
cache_results(true|false)
Whether to cache user information. Default: true
Global. WP_Roles. $wp_roles WordPress role management object.
Changelog
Since 3.1.0
Introduced.
Since 4.1.0
Added the ability to order by the include value.
Since 4.2.0
Added 'meta_value_num' support for $orderby parameter. Added multi-dimensional array syntax for $orderby parameter.
Since 4.3.0
Added 'has_published_posts' parameter.
Since 4.4.0
Added 'paged', 'role__in', and 'role__not_in' parameters. The 'role' parameter was updated to permit an array or comma-separated list of values. The 'number' parameter was updated to support querying for all users with using -1.
Since 4.7.0
Added 'nicename', 'nicename__in', 'nicename__not_in', 'login', 'login__in', and 'login__not_in' parameters.
Since 5.1.0
Introduced the 'meta_compare_key' parameter.
Since 5.3.0
Introduced the 'meta_type_key' parameter.
Since 5.9.0
Added 'capability', 'capability__in', and 'capability__not_in' parameters. Deprecated the 'who' parameter.
Since 6.3.0
Added 'cache_results' parameter.
WP_User_Query::prepare_query() WP User Query::prepare query code WP 6.8