get_users( array $args = array() ): array
- Since
- 3.1.0
- Source
wp-includes/user.php:874
Compatibility
- WordPress
- since 3.1.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$argsarrayoptional- Arguments to retrieve users. See WP_User_Query::prepare_query() for more information on accepted arguments.Default:
array()
Return value
array- List of users.
Performance profile
How much work a call to get_users() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Heavy
- Scaling
- Constant
- Instructions
- 15
- Plugin surface
- None
- Called by
- 12
Reaches the database via ->get_results().
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5. The body compiles to 15.
Nothing here hands control to plugin code.
12 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- querycontent query
get_users()this function does it - sqldatabase query
->get_results()called directly
Further down the call graph this can also reach hook. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 1 distinct outcome
One number would be a lie: the work depends on which branch runs. These are every distinct cost get_users() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 15 | wp_parse_args(), ->get_results() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 15 instructions, 15 executed per call, 0 branches. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
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 code
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();}Changelog
Introduced in 3.1.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 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.