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.

Common / Manipulation / For hooks

Show “$permissions”             Show Arguments        


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


$permissions->add(string $name)
Permission, Page or NullPageAdd a new Permission with the given name and return it
boolPermanently delete a Permission
boolSave a Permission

For hooks

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

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