WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_User::add_cap()

WP_User::add_cap( string $cap, bool $grant = true )

In this article

Back to top

Adds capability and grant or deny access to capability.

Parameters

$capstringrequired
Capability name.
$grantbooloptional
Whether to grant capability to user.

Default:true

More Information

Changing the capabilities of a user is persistent, meaning the added capability will stay in effect until explicitly revoked.

This setting is saved to the database (in table wp_options, field wp_user_roles), so it might be better to run this on theme/plugin activation.

Source

public function add_cap( $cap, $grant = true ) {
	$this->caps[ $cap ] = $grant;
	update_user_meta( $this->ID, $this->cap_key, $this->caps );
	$this->get_role_caps();
	$this->update_user_level_from_caps();
}

View all references View on Trac View on GitHub

UsesDescription
WP_User::update_user_level_from_caps()wp-includes/class-wp-user.php

Updates the maximum user level for the user.

WP_User::get_role_caps()wp-includes/class-wp-user.php

Retrieves all of the capabilities of the user’s roles, and merges them with individual user capabilities.

update_user_meta()wp-includes/user.php

Updates user meta field based on user ID.

Changelog

VersionDescription
2.0.0Introduced.

User Contributed Notes

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