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

Twitter updates

  • This week’s dev branch version brings you improvements to ProcessWire’s input->cookie API variable, plus it adds the ability to modify system URLs and paths at runtime. This post also includes some examples to demonstrate just how useful this can be— More
    20 September 2019
  • New post: This week we’ll take a look at a new version of FormBuilder that's on the way (with a screencast), as well as the latest version of the core: ProcessWire 3.0.140— More
    6 September 2019
  • We added WebP image support this year and many have been adopting it in existing projects. We look at a process used for migrating existing websites to WebP images— from preliminary considerations to implementation & testing, w/lots of tips & tricks too: More
    16 August 2019

Latest news

  • ProcessWire Weekly #279
    This week in the 279th issue of ProcessWire Weekly we're going to introduce some of the latest third party modules out there, and highlight a brand new site of the week. Read on!
    Weekly.pw / 14 September 2019
  • ProcessWire 3.0.141 core updates
    This week’s dev branch version brings you improvements to ProcessWire’s $input->cookie API variable, adds a new hook, and now lets you modify system URLs and paths at runtime, along with a few examples to demonstrate just how useful this can be. 
    Blog / 20 September 2019
  • Subscribe to weekly ProcessWire news

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