get_users() WordPress Function
The get_users() function is a Wordpress function that allows you to get a list of users from the Wordpress database. You can use this function to get a list of all the users on your Wordpress site, or you can use it to get a list of specific users based on criteria that you specify.
get_users( array $args = array() ) #
Retrieves list of users matching criteria.
Description
See also
Parameters
- $args
(array)(Optional) Arguments to retrieve users. See WP_User_Query::prepare_query() for more information on accepted arguments.
Default value: array()
Return
(array) List of users.
More Information
Return value is an array of IDs, stdClass objects, or WP_User objects, depending on the value of the ‘fields‘ parameter.
- If ‘fields‘ is set to ‘all’ (default), or ‘all_with_meta’, it will return an array of WP_User objects.
- If ‘fields‘ is set to an array of wp_users table fields, it will return an array of stdClass objects with only those fields.
- If ‘fields‘ is set to any individual wp_users table field, an array of IDs will be returned.
Source
File: wp-includes/user.php
function get_users( $args = array() ) {
$args = wp_parse_args( $args );
$args['count_total'] = false;
$user_search = new WP_User_Query( $args );
return (array) $user_search->get_results();
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 3.1.0 | Introduced. |