W3cubDocs

/WordPress

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 );
		}
	}

Uses

Uses Description
wp-includes/option.php: update_option()

Updates the value of an option that was already added.

Used By

Used By Description
wp-includes/class-wp-role.php: WP_Role::remove_cap()

Removes a capability from a role.

Changelog

Version Description
2.0.0 Introduced.

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