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

Twitter updates

  • ProcessWire 3.0.192 (dev branch) contains 11 issue fixes and 5 pull requests, over 20 commits— More
    7 January 2022
  • ProcessWire 3.0.191 core updates: updates to the installer and the profile exporter module— More
    24 December 2021
  • This week ProcessWire went on a diet, trimming the core size from 15.5 MB down to 7.5 MB by moving optional site profiles into their own GitHub repos— More
    17 December 2021

Latest news

  • ProcessWire Weekly #402
    In the 402nd issue of ProcessWire Weekly we'll check out ProcessWire 3.0.193, highlight recent ProcessWire projects and resources, and more. Read on!
    Weekly.pw / 22 January 2022
  • ProcessWire 3.0.190 core updates
    ProcessWire 3.0.190 has 15 commits relative to 3.0.189 and contains a mixture of issue resolutions and feature additions. This post covers them all, in addition to updates for the PageAutosave and ProFields Table modules.
    Blog / 3 December 2021
  • Subscribe to weekly ProcessWire news

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani