WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_Roles::get_role()

WP_Roles::get_role( string $role ): WP_Role|null

In this article

Back to top

Retrieves a role object by name.

Parameters

$rolestringrequired
Role name.

Return

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

Source

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

View all references View on Trac View on GitHub

Used byDescription
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

VersionDescription
2.0.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.