WP_Roles::add_cap() WordPress Method
The WP_Roles::add_cap() method allows you to add a new capability to a role. The first parameter is the role name, and the second parameter is the capability name.
WP_Roles::add_cap( string $role, string $cap, bool $grant = true ) #
Add capability to role.
Parameters
- $role
(string)(Required)Role name.
- $cap
(string)(Required)Capability name.
- $grant
(bool)(Optional) Whether role is capable of performing capability.
Default value: true
More Information
Changing the capabilities of a role is persistent, meaning the added capability will stay in effect until explicitly revoked.
This setting is saved to the database (in table wp_options, field wp_user_roles), so it might be better to run this on theme/plugin activation.
Source
File: wp-includes/class-wp-roles.php
public function add_cap( $role, $cap, $grant = true ) {
if ( ! isset( $this->roles[ $role ] ) ) {
return;
}
$this->roles[ $role ]['capabilities'][ $cap ] = $grant;
if ( $this->use_db ) {
update_option( $this->role_key, $this->roles );
}
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 2.0.0 | Introduced. |