$permissions API variable / Permissions class

Provides management of all Permission pages independent of users, 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 Permissions class also inherits all the methods and properties of: PagesType and Wire.

Show $var?             Show args?        

Common

NameReturnSummary 
$permissions->find($selector)
PageArrayReturn the permissions(s) matching the the given selector query.
$permissions->get($selector)
Permission NullPageReturn permission by given name, numeric ID or a selector string.
$permissions->getIterator()
ArrayObjectReturns all installed Permission pages and enables foreach() iteration of $permissions 
$permissions->getReducerPermissions()
arrayGet permission names that can reduce existing access, when installed 
$permissions->has(string $name)
boolDoes the system have a permission with the given name? 

For hooks

These methods are only useful for hooking and should not be called directly.

NameReturnSummary 
$permissions->added(Page $page)
(nothing)Hook called just after a Permission is added
$permissions->deleteReady(Page $page)
(nothing)Hook called before a Permission is deleted
$permissions->deleted(Page $page)
(nothing)Hook called when a permission is deleted
$permissions->saveReady(Page $page)
arrayHook called just before a Permission is saved
$permissions->saved(Page $page)
(nothing)Hook called when a permission is saved

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.178

Twitter updates

  • ProcessWire 3.0.180 core updates– More
    18 June 2021
  • Today a new version of FormBuilder has been released in the FormBuilder support board (our 50th version) and it has a lot of interesting new features, which we’ll take a closer look at in this post— More
    11 June 2021
  • ProcessWire 3.0.179 adds great new admin theme customization tools that put you in full control over the Uikit admin styles— More
    28 May 2021

Latest news

  • ProcessWire Weekly #372
    In the 372nd issue of ProcessWire Weekly we're going to introduce a couple of new third party modules, check out a very interesting new project from Ryan, and more. Read on!
    Weekly.pw / 26 June 2021
  • ProcessWire FormBuilder v50 updates
    Today a new version of FormBuilder has been released in the FormBuilder support board (our 50th version) and it has a lot of interesting new features, which we'll take a closer look at in this post.
    Blog / 11 June 2021
  • Subscribe to weekly ProcessWire news

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