Role is a type of Page used for grouping permissions to users.
Any given User will have one or more roles, each with zero or more permissions assigned to it.
Note that most public API-level access checking is typically performed from the User rather than
the Role(s), as it accounts for the combined roles. Please also see User, Permission and the access related methods on Page.
Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the Role class also inherits all the methods and properties of: Page, WireData and Wire.
Common
| Name | Return | Summary | |
|---|---|---|---|
Role::addPermission() Role::addPermission($permission) Role::addPermission($permission) | bool | Add the given Permission string, id or object. | |
Role::hasPermission() Role::hasPermission($permission) Role::hasPermission($permission, $context = null) | bool | Does this role have the given permission name, id or object? | |
| Role::id | int | Numeric page ID of role. | |
| Role::name | string | Name of role. | |
| Role::permissions | PageArray | PageArray of permissions assigned to Role. | |
Role::removePermission() Role::removePermission($permission) Role::removePermission($permission) | bool | Remove the given permission string, id or object. | |
Role::wired() Role::wired() Role::wired() | (nothing) | Wired to API |
Additional methods and properties
In addition to the methods and properties above, Role also inherits the methods and properties of these classes:
API reference based on ProcessWire core version 3.0.236