Docs4dev
Docs
wordpress / latest / functions / get_role.html

get_role( string $role ): WP_Role|null

Retrieves 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. View all references

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

Uses

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

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

Retrieves a role object by name.

Used By

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

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

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

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

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

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

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

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

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

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

Retrieve users.

Changelog

Version Description
2.0.0 Introduced.

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