get_editable_roles()
Fetch a filtered list of user roles that the current user is allowed to edit.
Contents
Description
Simple function whose main purpose is to allow filtering of the list of roles in the $wp_roles object so that plugins can remove inappropriate ones depending on the situation or user making edits. Specifically because without filtering anyone with the edit_users capability can edit others to be administrators, even if they are only editors or authors. This filter allows admins to delegate user management.
Return
(array[]) Array of arrays containing role information.
More Information
- Which roles a user can assign are determined by passing all roles through the
editable_rolesfilter. - The file that defines this function (
wp-admin/includes/user.php) is only loaded in the admin sections.
Source
File: wp-admin/includes/user.php
function get_editable_roles() {
$all_roles = wp_roles()->roles;
/**
* Filters the list of editable roles.
*
* @since 2.8.0
*
* @param array[] $all_roles Array of arrays containing role information.
*/
$editable_roles = apply_filters( 'editable_roles', $all_roles );
return $editable_roles;
}
Expand full source code Collapse full source code View on Trac View on GitHub
Changelog
| Version | Description |
|---|---|
| 2.8.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.
Example
Currently, you can assign the following roles:
<dl> <?php foreach (get_editable_roles() as $role_name => $role_info): ?> <dt><?php echo $role_name ?></dt> <dd> <ul> <?php foreach ($role_info['capabilities'] as $capability => $_): ?> <li><?php echo $capability ?></li> <?php endforeach; ?> </ul> </dd> <?php endforeach; ?> </dl>