On this page
WP_Roles::get_role( string $role ): WP_Role|null
Retrieves a role object by name.
Parameters
$rolestring 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. View all references
public function get_role( $role ) {
if ( isset( $this->role_objects[ $role ] ) ) {
return $this->role_objects[ $role ];
} else {
return null;
}
}
Related
Used By
| Used By | Description |
|---|---|
| WP_User::get_role_caps() wp-includes/class-wp-user.php | Retrieves all of the capabilities of the user’s roles, and merges them with individual user capabilities. |
| get_role() wp-includes/capabilities.php | Retrieves role object. |
Changelog
| Version | Description |
|---|---|
| 2.0.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_roles/get_role