WP_Users_List_Table::get_role_list( WP_User $user_object ): string[]

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$user_objectWP_User

The WP_User object.

Return value

string[]

An array of user role names keyed by role.

Performance profile

How much work a call to WP_Users_List_Table::get_role_list() 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

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

16–23

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 35.

Plugin surface

1 hook

Third-party callbacks on 'get_role_list' run inside this call, and their cost is not bounded by anything here.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly

Further down the call graph this can also reach query, option, cache, serialize 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 · 2 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_role_list() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while WP_Users_List_Table::get_role_list() runs, in this order:

1. 1
   apply_filters( get_role_list )filterline 681 (+23 into the body)

   Filters the returned array of translated role names for a user.

Uses · 4

• wp_roles()Retrieves the global WP_Roles instance and instantiates it if necessary.
• translate_user_role()Translates role name.
• _x()Retrieves translated string with gettext context.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 1

• WP_Users_List_Table::single_row()Generates HTML for a single row on the users.php admin panel.

Source code

View on Trac ↗View on GitHub ↗

658	protected function get_role_list( $user_object ) {659		$wp_roles = wp_roles();660 661		$role_list = array();662 663		foreach ( $user_object->roles as $role ) {664			if ( isset( $wp_roles->role_names[ $role ] ) ) {665				$role_list[ $role ] = translate_user_role( $wp_roles->role_names[ $role ] );666			}667		}668 669		if ( empty( $role_list ) ) {670			$role_list['none'] = _x( 'None', 'no user roles' );671		}672 673		/**674		 * Filters the returned array of translated role names for a user.675		 *676		 * @since 4.4.0677		 *678		 * @param string[] $role_list   An array of translated user role names keyed by role.679		 * @param WP_User  $user_object A WP_User object.680		 */681		return apply_filters( 'get_role_list', $role_list, $user_object );682	}

Changelog

Introduced in 4.4.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 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.