Role is a type of Page used for grouping permissions to users.

Any given User will have one or more roles, each with zero or more permissions assigned to it. Note that most public API-level access checking is typically performed from the User rather than the Role(s), as it accounts for the combined roles. Please also see User, Permission and the access related methods on Page.


Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the Role class also inherits all the methods and properties of: Page, WireData and Wire.

Show class?             Show args?        

Common

NameReturnSummary 
Role::addPermission($permission)
boolAdd the given Permission string, id or object. 
Role::hasPermission($permission)
boolDoes this role have the given permission name, id or object? 
Role::id int Numeric page ID of role.  
Role::name string Name of role.  
Role::permissions PageArray PageArray of permissions assigned to Role. 
Role::removePermission($permission)
boolRemove the given permission string, id or object. 

Additional methods and properties

In addition to the methods and properties above, Role also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.137

Twitter updates

  • ProcessWire 3.0.144 and 3.0.145 add improved field template context override settings and include a new Inputfields API, along with numerous other issue fixes, optimizations and improvements to the core. More
    8 November 2019
  • ProcessWire 3.0.144 core updates: Upgraded overrides section in the field editor, a new Inputfields JS API, and more— More
    1 November 2019
  • ProcessWire 3.0.143 core updates — 26 commits and 18 resolved issue reports, plus some other useful improvements and additions. More here: More
    25 October 2019

Newest forum posts

Latest news

  • ProcessWire Weekly #287
    In the 287th issue of ProcessWire Weekly we'll talk a bit about the latest core versions 3.0.144 and 3.0.145, introduce a third party module called Sanitizer EasySlugger, and publish a new #processwireworks poll. Read on!
    Weekly.pw / 9 November 2019
  • ProcessWire 3.0.145 core updates
    ProcessWire 3.0.144 and 3.0.145 add improved field template context override settings and include a new Inputfields API, along with numerous other issue fixes, optimizations and improvements to the core.
    Blog / 8 November 2019
  • 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