On this page
add_role( string $role, string $display_name, bool[] $capabilities = array() ): WP_Role|void
Adds a role, if it does not exist.
Parameters
$rolestring Required-
Role name.
$display_namestring Required-
Display name for role.
$capabilitiesbool[] Optional-
List of capabilities keyed by the capability name, e.g. array(
'edit_posts'=> true,'delete_posts'=> false ).Default:
array()
Return
Source
File: wp-includes/capabilities.php. View all references
function add_role( $role, $display_name, $capabilities = array() ) {
if ( empty( $role ) ) {
return;
}
return wp_roles()->add_role( $role, $display_name, $capabilities );
}
Related
Uses
| Uses | Description |
|---|---|
| wp_roles() wp-includes/capabilities.php | Retrieves the global WP_Roles instance and instantiates it if necessary. |
| WP_Roles::add_role() wp-includes/class-wp-roles.php | Adds a role name with capabilities to the list. |
Used By
| Used By | Description |
|---|---|
| populate_roles_160() wp-admin/includes/schema.php | Create the roles for WordPress 2.0 |
Changelog
| Version | Description |
|---|---|
| 2.0.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/add_role