get_users( array $args = array() )

Retrieve 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();
}

Used By

Used By Description
wp-includes/ms-site.php: wp_uninitialize_site()

Runs the uninitialization routine for a given site.
wp-admin/includes/schema.php: populate_network_meta()

Creates WordPress network meta and sets the default values.
wp-admin/includes/ms.php: wpmu_delete_blog()

Delete a site.
wp-admin/includes/ajax-actions.php: wp_ajax_autocomplete_user()

Ajax handler for user autocomplete.
wp-admin/includes/ms.php: confirm_delete_users()
wp-includes/user.php: wp_dropdown_users()

Create dropdown HTML content of users.
wp-includes/author-template.php: wp_list_authors()

List all the authors of the site, with several options available.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_getAuthors()

Retrieve authors list.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_getUsers()

Retrieve users.

Changelog

Version Description
3.1.0 Introduced.

© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_users