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 / Manipulation / For hooks


Name Return Summary  
$roles->find($selector) PageArray Return the Role(s) matching the the given selector.
$roles->get(string $selectorString) Role, NullPage or null Get a Role by name, numeric ID or selector


Name Return Summary  
$roles->add(string $name) Role, Page or NullPage Add a new Role with the given name and return it
$roles->delete($page) bool Permanently delete a Role
$roles->save($page) bool Save a Role

For hooks

This methods are only useful for hooking and should not be called directly.

Name Return Summary  
$roles->added(Page $page) (nothing) Hook called just after a Role is added
$roles->deleteReady(Page $page) (nothing) Hook called before a Role is deleted
$roles->deleted(Page $page) (nothing) Hook called after a Role is deleted
$roles->saveReady(Page $page) array Hook called just before a Role is saved
$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: