W3cubDocs

/WordPress

WP_Roles::get_role( string $role )

Retrieve role object by name.

Parameters

$role: (string) (Required) Role name.

Return

(WP_Role|null) WP_Role object if found, null if the role does not exist.

Source

File: wp-includes/class-wp-roles.php

public function get_role( $role ) {
		if ( isset( $this->role_objects[ $role ] ) ) {
			return $this->role_objects[ $role ];
		} else {
			return null;
		}
	}

Used By

Used By	Description
wp-includes/class-wp-user.php: WP_User::get_role_caps()	Retrieves all of the capabilities of the user’s roles, and merges them with individual user capabilities.
wp-includes/capabilities.php: get_role()	Retrieve role object.

Changelog

Version	Description
2.0.0	Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_roles/get_role