W3cubDocs

/WordPress

get_role( string $role ): WP_Role|null

Retrieves role object.

Parameters

$rolestringrequired
Role name.

Return

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

Source

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

View all references View on Trac View on GitHub

Changelog

Version Description
2.0.0 Introduced.

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