Permission is a Page type used for storing an individual permission.
One or more Permission objects are attached to Role
objects, which are then attached to User
objects and Template
objects, forming ProcessWire's role-based access control system. Outside of roles, Permission objects are managed with the $permissions
API variable.
Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the Permission
class also inherits all the methods and properties of: Page, WireData and Wire.
Common
Name | Return | Summary | |
---|---|---|---|
Permission::id | int | Numeric page ID of the permission. | |
Permission::name | string | Name of the permission. | |
Permission::title | string | Short description of what the permission is for. | |
Permission::wired() Permission::wired() Permission::wired() | (nothing) | Wired to API |
Additional methods and properties
In addition to the methods and properties above, Permission also inherits the methods and properties of these classes:
API reference based on ProcessWire core version 3.0.236