W3cubDocs

/WordPress

get_role( string $role )

Retrieve role object.

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/capabilities.php 

function get_role( $role ) {
	return wp_roles()->get_role( $role );
}

Uses

Uses Description
wp-includes/capabilities.php: wp_roles()

Retrieves the global WP_Roles instance and instantiates it if necessary.
wp-includes/class-wp-roles.php: WP_Roles::get_role()

Retrieve role object by name.

Used By

Used By Description
wp-admin/includes/schema.php: populate_roles_160()

Create the roles for WordPress 2.0
wp-admin/includes/schema.php: populate_roles_210()

Create and modify WordPress roles for WordPress 2.1.
wp-admin/includes/schema.php: populate_roles_230()

Create and modify WordPress roles for WordPress 2.3.
wp-admin/includes/schema.php: populate_roles_250()

Create and modify WordPress roles for WordPress 2.5.
wp-admin/includes/schema.php: populate_roles_260()

Create and modify WordPress roles for WordPress 2.6.
wp-admin/includes/schema.php: populate_roles_270()

Create and modify WordPress roles for WordPress 2.7.
wp-admin/includes/schema.php: populate_roles_280()

Create and modify WordPress roles for WordPress 2.8.
wp-admin/includes/schema.php: populate_roles_300()

Create and modify WordPress roles for WordPress 3.0.
wp-includes/formatting.php: sanitize_option()

Sanitises various option values based on the nature of the option.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_getUsers()

Retrieve users.

Changelog

Version Description
2.0.0 Introduced.

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