permissions() function

Get, find or save permissions ($permissions API variable as a function)

Accessing permissions() is exactly the same as accessing $permissions. Though there are a couple of optional shortcuts available by providing an argument to this function.

Example

// Get a permission
$p = permissions()->get('page-edit'); // regular syntax
$p = permissions('page-edit'); // shortcut syntax

// Find permissions
$ps = permissions()->find('name^=page'); // regular syntax
$ps = permissions('name^=page'); // shortcut syntax

Usage

// basic usage
$permissions = permissions();

// usage with all arguments
$permissions = permissions($selector = '');

Arguments

NameType(s)Description
selector (optional)string, int
  • Specify permission name or ID to retrieve that Permission (Permission)
  • Specify a selector string to return all permissions matching selector (PageArray)

Return value

Permissions Permission PageArray null NullPage


Functions methods and properties

API reference based on ProcessWire core version 3.0.209

Twitter updates

  • Adding custom actions to ProcessWire image fields in the admin, part of this week’s dev branch additions: More
    27 January 2023
  • ProcessWire 3.0.210 new main/master version released— More
    6 January 2023
  • ProcessWire 3.0.209: Core updates and an interesting AI that knows ProcessWire– More
    30 December 2022

Latest news

  • ProcessWire Weekly #455
    In the 455th issue of ProcessWire Weekly we'll check out the latest core updates, introduce a new third party module called JkPublishPages, and more. Read on!
    Weekly.pw / 28 January 2023
  • ProcessWire 3.0.210 new main/master version
    140 commits, 55 resolved issues, dozens of new features, eight contributors, and five new pull requests make yet another great new version of ProcessWire.
    Blog / 6 January 2023
  • Subscribe to weekly ProcessWire news

“…building with ProcessWire was a breeze, I really love all the flexibility the system provides. I can’t imagine using any other CMS in the future.” —Thomas Aull