WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_Roles::remove_cap()

WP_Roles::remove_cap( string $role, string $cap )

In this article

Back to top

Removes a capability from role.

Parameters

$rolestringrequired
Role name.
$capstringrequired
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

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

View all references View on Trac View on GitHub

UsesDescription
update_option()wp-includes/option.php

Updates the value of an option that was already added.

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

Removes a capability from a role.

Changelog

VersionDescription
2.0.0Introduced.

User Contributed Notes

  1. Skip to note 2 content
    Akira Tachibana
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

    From Codex

    /**
 * Don't let editors read private posts.
 *
 * An alternative using WP_Roles instead of WP_Role.
 *
 * You should call the function when your plugin is activated.
 *
 * @uses $wp_roles
 * @uses WP_Roles::remove_cap()
 */
function remove_editor_read_private_posts(){

	// $wp_roles is an instance of WP_Roles.
	global $wp_roles;
	$wp_roles->remove_cap( 'editor', 'read_private_posts' );
}

You must log in before being able to contribute a note or feedback.