WP_User::remove_cap() WordPress Method

The remove_cap() method is a member function of the WP_User class. It is used to remove a capability from a user. The user must have the capability to be able to perform this action.

WP_User::remove_cap( string $cap ) #

Removes capability from user.


Parameters

$cap

(string)(Required)Capability name.


Top ↑

More Information

Changing the capabilities of a user 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-user.php

	public function remove_cap( $cap ) {
		if ( ! isset( $this->caps[ $cap ] ) ) {
			return;
		}
		unset( $this->caps[ $cap ] );
		update_user_meta( $this->ID, $this->cap_key, $this->caps );
		$this->get_role_caps();
		$this->update_user_level_from_caps();
	}


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.