WP_Users_List_Table::get_role_list │ protected │ WP 4.4.0

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

Method of the class: WP_Users_List_Table{}

Returns

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

Usage

// protected - for code of main (parent) or child class
$result = $this->get_role_list( $user_object );

$user_object(WP_User) (required)

The WP_User object.

Changelog

WP_Users_List_Table::get_role_list() WP Users List Table::get role list code ^{WP 6.9.1}

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 );
}