WP_Roles::remove_cap() WordPress Method
The WP_Roles::remove_cap() function is used to remove a capability from a role. The first parameter is the role name, and the second parameter is the capability name.
WP_Roles::remove_cap( string $role, string $cap ) #
Remove capability from role.
Parameters
- $role
(string)(Required)Role name.
- $cap
(string)(Required)Capability name.
More Information
Changing the capabilities of a role is persistent, meaning the removed capability will stay in effect until explicitly granted.
This setting is saved to the database (in table wp_options, field 'wp_user_roles'), so you should run this only once, on theme/plugin activation and/or deactivation.
Source
File: wp-includes/class-wp-roles.php
public function remove_cap( $role, $cap ) {
if ( ! isset( $this->roles[ $role ] ) ) {
return;
}
unset( $this->roles[ $role ]['capabilities'][ $cap ] );
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. |