get_users( array $args = array() ): array

Parameters

$argsarrayoptional

Arguments to retrieve users. See WP_User_Query::prepare_query() for more information on accepted arguments.Default: array()

Return

array

List of users.

Uses · 2

• wp_parse_args()Merges user defined arguments into defaults array.
• WP_User_Query::__construct()Constructor.

Used by · 12

• _build_block_template_result_from_post()Builds a unified template object based a post Object.
• confirm_delete_users()
• populate_network_meta()Creates WordPress network meta and sets the default values.
• twentyfourteen_list_authors()Prints a list of all site contributors who published at least one post.
• wp_ajax_autocomplete_user()Handles user autocomplete via AJAX.
• wp_dropdown_users()Creates dropdown HTML content of users.
• wp_list_authors()Lists all the authors of the site, with several options available.
• wp_list_users()Lists all the users of the site, with several options available.
• wp_uninitialize_site()Runs the uninitialization routine for a given site.
• wp_xmlrpc_server::wp_getAuthors()Retrieves authors list.
• wp_xmlrpc_server::wp_getUsers()Retrieves users.
• wpmu_delete_blog()Deletes a site.

Source

View on Trac ↗View on GitHub ↗

874function get_users( $args = array() ) {875 876	$args                = wp_parse_args( $args );877	$args['count_total'] = false;878 879	$user_search = new WP_User_Query( $args );880 881	return (array) $user_search->get_results();882}

History

Introduced in 3.1.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.0.4 tag, from src/wp-includes/user.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.