$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.163

Twitter updates

  • Quick weekly update covering this week's commits for the upcoming 3.0.167 ProcessWire core version— More
    18 September 2020
  • This week ProcessWire version 3.0.166 is released on the dev branch. In this post we’ll cover all that’s new relative to the previous version, 3.0.165. Plus we’ll check out the latest new versions of ProCache and FormBuilder— More
    11 September 2020
  • Weekly update – 28 August 2020 – New secure files option defined per-template: More
    28 August 2020

Latest news

  • ProcessWire Weekly #331
    In the 331st issue of ProcessWire Weekly we're going to check out the latest core and Pro module updates (ProcessWire 3.0.166, ProCache 4.0.1, and Form Builder v44), introduce the Wireframe API module, and more. Read on!
    Weekly.pw / 12 September 2020
  • ProcessWire 3.0.166 core updates and more
    This week ProcessWire version 3.0.166 is released on the dev branch. In this post we’ll cover all that’s new relative to the previous version, 3.0.165. Plus we’ll check out the latest new versions of ProCache and FormBuilder.
    Blog / 11 September 2020
  • Subscribe to weekly ProcessWire news

“…building with ProcessWire was a breeze, I really love all the flexibility the system provides. I can’t imagine using any other CMS in the future.” —Thomas Aull