W3cubDocs

/WordPress

wp_roles()

Retrieves the global WP_Roles instance and instantiates it if necessary.

(WP_Roles) WP_Roles global instance if not already instantiated.

function wp_roles() {
	global $wp_roles;

	if ( ! isset( $wp_roles ) ) {
		$wp_roles = new WP_Roles();
	}
	return $wp_roles;
}

Uses	Description
wp-includes/class-wp-roles.php: WP_Roles::__construct()	Constructor

Used By	Description
wp-includes/ms-blogs.php: wp_switch_roles_and_user()	Switches the initialized roles and current user capabilities to another site.
wp-includes/user.php: wp_get_users_with_no_role()	Get the user IDs of all users with no role on this site.
wp-admin/includes/class-wp-users-list-table.php: WP_Users_List_Table::get_role_list()	Returns an array of user roles for a given user object.
wp-admin/includes/user.php: edit_user()	Edit user settings based on contents of $_POST
wp-admin/includes/user.php: get_editable_roles()	Fetch a filtered list of user roles that the current user is allowed to edit.
wp-admin/includes/class-wp-users-list-table.php: WP_Users_List_Table::get_views()	Return an associative array listing all the views that can be used with this table.
wp-includes/class-wp-user.php: WP_User::get_role_caps()	Retrieves all of the capabilities of the user’s roles, and merges them with individual user capabilities.
wp-includes/class-wp-role.php: WP_Role::add_cap()	Assign role a capability.
wp-includes/class-wp-role.php: WP_Role::remove_cap()	Removes a capability from a role.
wp-includes/capabilities.php: get_role()	Retrieve role object.
wp-includes/capabilities.php: add_role()	Add role, if it does not exist.
wp-includes/capabilities.php: remove_role()	Remove role, if it exists.
wp-includes/user.php: count_users()	Count number of users who have each of the user roles.

Version	Description
4.3.0	Introduced.

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