$roles API variable / Roles class

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.

Show $var?             Show args?        

Common

NameReturnSummary 
$roles->find($selector)
PageArrayReturn the Role(s) matching the the given selector.
$roles->get(string $selectorString)
Role NullPage nullGet a Role by name, numeric ID or selector 

For hooks

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

NameReturnSummary 
$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)
arrayHook called just before a Role is saved
$roles->saved(Page $page)
(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.209

Twitter updates

  • Adding custom actions to ProcessWire image fields in the admin, part of this week’s dev branch additions: More
    27 January 2023
  • ProcessWire 3.0.210 new main/master version released— More
    6 January 2023
  • ProcessWire 3.0.209: Core updates and an interesting AI that knows ProcessWire– More
    30 December 2022

Latest news

  • ProcessWire Weekly #455
    In the 455th issue of ProcessWire Weekly we'll check out the latest core updates, introduce a new third party module called JkPublishPages, and more. Read on!
    Weekly.pw / 28 January 2023
  • ProcessWire 3.0.210 new main/master version
    140 commits, 55 resolved issues, dozens of new features, eight contributors, and five new pull requests make yet another great new version of ProcessWire.
    Blog / 6 January 2023
  • Subscribe to weekly ProcessWire news

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer