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

Twitter updates

  • This week we’ve got a few new and interesting core updates in progress, though none quite ready to release just yet. So rather than releasing version 3.0.154 today, I thought we'd instead take a brief look at what’s coming over the next few weeks… More
    3 April 2020
  • ProcessWire 3.0.153 (dev) focuses on comments field updates, significant refactoring/improvements to ProcessWire’s core Template class and PagesLoader class (which is used by the pages API variable), and we introduce a useful new pages API method— More
    20 March 2020
  • ProcessWire 3.0.152 core updates— This week we have some major improvements to our core date/time Inputfield, as well as a new ability to specify your own custom classes for Page objects— More
    6 March 2020

Latest news

  • ProcessWire Weekly #308
    In the 308th issue of ProcessWire Weekly we're going to take a look at some upcoming core and pro module updates, check out two all-new third party modules, and more. Read on!
    Weekly.pw / 4 April 2020
  • ProcessWire updates and additions in progress
    This week we’ve got a few new and interesting core updates in progress, though none quite ready to release just yet. So rather than releasing version 3.0.154 today, I thought we'd instead take a brief look at what’s coming over the next few weeks. This post covers all the details.
    Blog / 3 April 2020
  • Subscribe to weekly ProcessWire news

I just love the easy and intuitive ProcessWire API. ProcessWire rocks!” —Jens Martsch, Web developer