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. 
Role::wired()
(nothing)Wired to API 

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.184

Twitter updates

  • ProcessWire 3.0.185 (dev) core updates, plus new Session Allow module— More
    17 September 2021
  • Three new ProcessWire Textformatter modules: Find/Replace, Markdown in Markup, and Emoji— More
    3 September 2021
  • This week we have a new master version released after a year in the making. With nearly 40 pull requests, hundreds of new additions and more than 100 issue reports resolved, this new version has a ton of great new stuff— More
    27 August 2021

Latest news

  • ProcessWire Weekly #384
    In the 384th issue of ProcessWire Weekly we'll cover the latest core updates, introduce a new module called Session Allow, and highlight a new site of the week. Read on!
    Weekly.pw / 18 September 2021
  • ProcessWire 3.0.184 new master/main version
    This week we have a new master/main version released after a full year in the making. As you might imagine, this new version has a ton of great new stuff and we’ll try to cover much of it here.
    Blog / 27 August 2021
  • Subscribe to weekly ProcessWire news

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer