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

Twitter updates

  • There’s a new modules directory on the ProcessWire site now up and running. In this post we’ll cover a few details about what’s changed and what’s new—More
    20 November 2020
  • ProcessWire 3.0.168 core updates — More
    26 October 2020
  • This week a 2nd new module for processing Stripe payments has been added to FormBuilder. Unlike our other Stripe Inputfield, this new one supports 3D Secure (SCA) payments. We’ll take a closer look at it in this post, plus a live demo— More
    16 October 2020

Latest news

  • ProcessWire Weekly #341
    In the 341st issue of ProcessWire Weekly we're going to check out the latest processwire.com blog post, introduce upcoming commercial module called NiftyPasswordsPlus, and check out a brand new site of the week. Read on!
    Weekly.pw / 21 November 2020
  • New ProcessWire modules directory
    There’s a new modules directory on the ProcessWire site now up and running. In this post we’ll cover a few details about what’s changed and what’s new.
    Blog / 20 November 2020
  • Subscribe to weekly ProcessWire news

“I am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer