WP_Users_List_Table::get_role_list

Advertisement

Summery Summery

Returns an array of user roles for a given user object.

Syntax Syntax

WP_Users_List_Table::get_role_list( WP_User $user_object )

Parameters Parameters

$user_object

(Required) The WP_User object.

Return Return

(string[]) An array of user roles.

Source Source

File: wp-admin/includes/class-wp-users-list-table.php

	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 roles for a user.
		 *
		 * @since 4.4.0
		 *
		 * @param string[] $role_list   An array of user roles.
		 * @param WP_User  $user_object A WP_User object.
		 */
		return apply_filters( 'get_role_list', $role_list, $user_object );
	}

Advertisement

Changelog Changelog

Changelog
Version Description
4.4.0 Introduced.

Advertisement

Leave a Reply