$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()
array PageArray \TraversableReturns 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.214

Twitter updates

  • Weekly update – 31 March 2023 – More
    31 March 2023
  • This week ProcessWire 3.0.214 is on the dev branch. Relative to 3.0.213 this version has 16 new commits which include the addition of 3 new pull requests, 6 issue fixes, a new WireNumberTools utility class, and various other improvements. More
    17 March 2023
  • ProcessWire 3.0.213 core updates: This week we’ll look at the new WireSitemapXML module, a new WireNumberTools core class, and a new ability for Fieldtype modules to specify useful ready-to-use configurations when creating new fields. More
    24 February 2023

Latest news

  • ProcessWire Weekly #464
    In the 464th issue of ProcessWire Weekly we're going to check out the latest core updates, introduce a new third party textformatter module for handling footnotes in text, and more. Read on!
    Weekly.pw / 1 April 2023
  • ProcessWire 3.0.213 core updates
    This week we’ll look at the new WireSitemapXML module, a new WireNumberTools core class, and a new ability for Fieldtype modules to specify useful ready-to-use configurations when creating new fields.
    Blog / 24 February 2023
  • Subscribe to weekly ProcessWire news

“I am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer