WP_Users_List_Table::get_views(): string[]
- Since
- 3.1.0
- Source
wp-admin/includes/class-wp-users-list-table.php:174
Description
Provides a list of roles and user count for that role for easy filtering of the user table.
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.
Return value
string[]- An array of HTML links keyed by their view.
Performance profile
How much work a call to WP_Users_List_Table::get_views() 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
- Moderate
- Scaling
- Scales with input
- Instructions
- 33–103
- Plugin surface
- None
- Called by
- 0
Only touches the object cache, via wp_cache_switch_to_blog().
The body loops, so the work grows with how much data it finds.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 145.
Nothing here hands control to plugin code.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- hookthird-party callbacks
apply_filters()one call below WP_Users_List_Table::get_views() - cacheobject cache
wp_cache_switch_to_blog()one call below WP_Users_List_Table::get_views() - serializeserialisation
maybe_unserialize()one call below WP_Users_List_Table::get_views()
Further down the call graph this can also reach option, query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 6 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Users_List_Table::get_views() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
$value && empty($avail_roles) | 33–36 | wp_roles(), wp_is_large_user_count(), __(), ->get_names(), ->get_views_links() |
!$value && empty($avail_roles) | 56–59 | wp_roles(), wp_is_large_user_count(), __(), count_users(), _nx(), number_format_i18n(), sprintf(), ->get_names(), ->get_views_links() |
$value && !empty($avail_roles) | 65–68 | wp_roles(), wp_is_large_user_count(), __(), ->get_names(), __(), __(), number_format_i18n(), sprintf(), add_query_arg(), esc_url(), ->get_views_links() |
!$value && empty($avail_roles) | 68–71 | wp_roles(), wp_is_large_user_count(), __(), switch_to_blog(), count_users(), restore_current_blog(), _nx(), number_format_i18n(), sprintf(), ->get_names(), ->get_views_links() |
!$value && !empty($avail_roles) | 88–91 | wp_roles(), wp_is_large_user_count(), __(), count_users(), _nx(), number_format_i18n(), sprintf(), ->get_names(), __(), __(), number_format_i18n(), sprintf(), add_query_arg(), esc_url(), ->get_views_links() |
!$value && !empty($avail_roles) | 100–103 | wp_roles(), wp_is_large_user_count(), __(), switch_to_blog(), count_users(), restore_current_blog(), _nx(), number_format_i18n(), sprintf(), ->get_names(), __(), __(), number_format_i18n(), sprintf(), add_query_arg(), esc_url(), ->get_views_links() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 145 instructions, 33–103 executed per call, 9 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 · 12
- wp_roles()Retrieves the global WP_Roles instance and instantiates it if necessary.
- wp_is_large_user_count()Determines whether the site has a large number of users.
- __()Retrieves the translation of $text.
- switch_to_blog()Switches the current blog.
- count_users()Counts number of users who have each of the user roles.
- restore_current_blog()Restores the current blog, after calling switch_to_blog().
- _nx()Translates and retrieves the singular or plural form based on the supplied number, with gettext context.
- number_format_i18n()Converts float number to format based on the locale.
- translate_user_role()Translates role name.
- esc_url()Checks and cleans a URL.
- add_query_arg()Retrieves a modified URL query string.
- WP_Users_List_Table::get_views_links()
Source code
protected function get_views() { global $role; $wp_roles = wp_roles(); $count_users = ! wp_is_large_user_count(); if ( $this->is_site_users ) { $url = 'site-users.php?id=' . $this->site_id; } else { $url = 'users.php'; } $role_links = array(); $avail_roles = array(); $all_text = __( 'All' ); if ( $count_users ) { if ( $this->is_site_users ) { switch_to_blog( $this->site_id ); $users_of_blog = count_users( 'time', $this->site_id ); restore_current_blog(); } else { $users_of_blog = count_users(); } $total_users = $users_of_blog['total_users']; $avail_roles =& $users_of_blog['avail_roles']; unset( $users_of_blog ); $all_text = sprintf( /* translators: %s: Number of users. */ _nx( 'All <span class="count">(%s)</span>', 'All <span class="count">(%s)</span>', $total_users, 'users' ), number_format_i18n( $total_users ) ); } $role_links['all'] = array( 'url' => $url, 'label' => $all_text, 'current' => empty( $role ), ); foreach ( $wp_roles->get_names() as $this_role => $name ) { if ( $count_users && ! isset( $avail_roles[ $this_role ] ) ) { continue; } $name = translate_user_role( $name ); if ( $count_users ) { $name = sprintf( /* translators: 1: User role name, 2: Number of users. */ __( '%1$s <span class="count">(%2$s)</span>' ), $name, number_format_i18n( $avail_roles[ $this_role ] ) ); } $role_links[ $this_role ] = array( 'url' => esc_url( add_query_arg( 'role', $this_role, $url ) ), 'label' => $name, 'current' => $this_role === $role, ); } if ( ! empty( $avail_roles['none'] ) ) { $name = __( 'No role' ); $name = sprintf( /* translators: 1: User role name, 2: Number of users. */ __( '%1$s <span class="count">(%2$s)</span>' ), $name, number_format_i18n( $avail_roles['none'] ) );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 6.8.8 tag, from
src/wp-admin/includes/class-wp-users-list-table.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.