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

Returns an array of translated user role names for a given user object.

Parameters

$user_objectWP_Userrequired
The WP_User object.

Return

string[] An array of user role names keyed by role.

Source

protected function get_role_list( $user_object ) {
	$wp_roles = wp_roles();

	$role_list = array();

	foreach ( $user_object->roles as $role ) {
		if ( isset( $wp_roles->role_names[ $role ] ) ) {
			$role_list[ $role ] = translate_user_role( $wp_roles->role_names[ $role ] );
		}
	}

	if ( empty( $role_list ) ) {
		$role_list['none'] = _x( 'None', 'no user roles' );
	}

	/**
	 * Filters the returned array of translated role names for a user.
	 *
	 * @since 4.4.0
	 *
	 * @param string[] $role_list   An array of translated user role names keyed by role.
	 * @param WP_User  $user_object A WP_User object.
	 */
	return apply_filters( 'get_role_list', $role_list, $user_object );
}

Hooks

apply_filters( ‘get_role_list’, string[] $role_list, WP_User $user_object )

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

Changelog

VersionDescription
4.4.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.