Provides management of all Role pages for access control.
Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the Roles class also inherits all the methods and properties of: PagesType and Wire.
Common
| Name | Return | Summary | |
|---|---|---|---|
$roles->find() $roles->find($selector) $roles->find($selector) | PageArray | Return the Role(s) matching the the given selector. | |
$roles->get() $roles->get(string $selectorString) $roles->get(string $selectorString) | Role NullPage null | Get a Role by name, numeric ID or selector |
Manipulation
| Name | Return | Summary | |
|---|---|---|---|
$roles->add() $roles->add(string $name) $roles->add(string $name) | Role NullPage | Add a new Role with the given name and return it | |
$roles->delete() $roles->delete($page) $roles->delete($page, bool $recursive = false) | bool | Permanently delete a Role | |
$roles->save() $roles->save($page) $roles->save($page) | bool | Save a Role |
For hooks
These methods are only useful for hooking and should not be called directly.
| Name | Return | Summary | |
|---|---|---|---|
$roles->added() $roles->added(Page $page) $roles->added(Page $page) | (nothing) | Hook called just after a Role is added | |
$roles->deleteReady() $roles->deleteReady(Page $page) $roles->deleteReady(Page $page) | (nothing) | Hook called before a Role is deleted | |
$roles->deleted() $roles->deleted(Page $page) $roles->deleted(Page $page) | (nothing) | Hook called after a Role is deleted | |
$roles->saveReady() $roles->saveReady(Page $page) $roles->saveReady(Page $page) | array | Hook called just before a Role is saved | |
$roles->saved() $roles->saved(Page $page) $roles->saved(Page $page, array $changes = [], $values = []) | (nothing) | Hook called after a role has been saved |
Additional methods and properties
In addition to the methods and properties above, Roles also inherits the methods and properties of these classes:
API reference based on ProcessWire core version 3.0.236