[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

Search

title

Body

[close]

/wp-includes/ -> class-wp-role.php (summary)

User API: WP_Role class

File Size: 103 lines (2 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

WP_Role:: (4 methods):
  __construct()
  add_cap()
  remove_cap()
  has_cap()


Class: WP_Role  - X-Ref

Core class used to extend the user roles API.

__construct( $role, $capabilities )   X-Ref
Constructor - Set up object properties.

The list of capabilities must have the key as the name of the capability
and the value a boolean of whether it is granted to the role.

param: string $role         Role name.
param: bool[] $capabilities Array of key/value pairs where keys represent a capability name and boolean values

add_cap( $cap, $grant = true )   X-Ref
Assign role a capability.

param: string $cap   Capability name.
param: bool   $grant Whether role has capability privilege.

remove_cap( $cap )   X-Ref
Removes a capability from a role.

param: string $cap Capability name.

has_cap( $cap )   X-Ref
Determines whether the role has the given capability.

return: bool Whether the role has the given capability.
param: string $cap Capability name.



Generated : Mon Oct 26 08:20:01 2020 Cross-referenced by PHPXref