WP_Role::remove_cap() WordPress Method

The WP_Role::remove_cap() function is used to remove a capability from a given role. This function is useful for removing capabilities that are no longer needed or desired by a particular role.

WP_Role::remove_cap( string $cap ) #

Removes a capability from a role.


Parameters

$cap

(string)(Required)Capability name.


Top ↑

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.

 


Top ↑

Source

File: wp-includes/class-wp-role.php

	public function remove_cap( $cap ) {
		unset( $this->capabilities[ $cap ] );
		wp_roles()->remove_cap( $this->name, $cap );
	}


Top ↑

Changelog

Changelog
VersionDescription
2.0.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.