$permissions

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

Name	Return	Summary
$permissions->find() $permissions->find($selector) $permissions->find($selector)	`PageArray`	Return the permissions(s) matching the the given selector query.
$permissions->get() $permissions->get($selector) $permissions->get($selector)	`Permission` `NullPage`	Return permission by given name, numeric ID or a selector string.
$permissions->getIterator() $permissions->getIterator() $permissions->getIterator()	`array` `PageArray` `\Traversable`	Returns all installed Permission pages and enables foreach() iteration of $permissions
$permissions->getOptionalPermissions() $permissions->getOptionalPermissions() $permissions->getOptionalPermissions(bool $omitInstalled = true)	`array`	Get an associative array of all optional permissions
$permissions->getReducerPermissions() $permissions->getReducerPermissions() $permissions->getReducerPermissions()	`array`	Get permission names that can reduce existing access, when installed
$permissions->has() $permissions->has(string $name) $permissions->has(string $name)	`bool`	Does the system have a permission with the given name?
$permissions->new() $permissions->new() $permissions->new($options = [])	`Permission`	Create new Permission instance in memory 3.0.249+

Manipulation

Name	Return	Summary
$permissions->add() $permissions->add(string $name) $permissions->add(string $name)	`Permission` `NullPage`	Add a new Permission with the given name and return it
$permissions->delete() $permissions->delete($page) $permissions->delete($page, bool $recursive = false)	`bool`	Permanently delete a Permission
$permissions->save() $permissions->save($page) $permissions->save($page)	`bool`	Save a Permission

For hooks

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

Name	Return	Summary
$permissions->added() $permissions->added(Page $page) $permissions->added(Page $page)	None	Hook called just after a Permission is added
$permissions->deleteReady() $permissions->deleteReady(Page $page) $permissions->deleteReady(Page $page)	None	Hook called before a Permission is deleted
$permissions->deleted() $permissions->deleted(Page $page) $permissions->deleted(Page $page)	None	Hook called when a permission is deleted
$permissions->saveReady() $permissions->saveReady(Page $page) $permissions->saveReady(Page $page)	`array`	Hook called just before a Permission is saved
$permissions->saved() $permissions->saved(Page $page) $permissions->saved(Page $page, array $changes = [], array $values = [])	None	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.251