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.200

Twitter updates

  • New main/master version of ProcessWire that has more than 220 commits, resolves more than 80 issues, adds numerous new features, performance improvements and optimizations, and consumes HALF the disk space of our previous release— More
    13 May 2022
  • Summary of weekly core updates for 22 April 2022 More
    22 April 2022
  • ProcessWire 3.0.198 core updates: in this post we take a closer look at 3 useful new features added in this version— More
    15 April 2022

Latest news

  • ProcessWire Weekly #418
    In the 418th issue of ProcessWire Weekly we'll cover recent highlights, share some tips and tricks, and check out the new master version of ProcessWire, 3.0.200. Read on!
    Weekly.pw / 14 May 2022
  • ProcessWire 3.0.200 new master/main version
    This new main/master version has more than 220 commits, resolves more than 80 issues, adds numerous new features, performance improvements and optimizations, and consumes HALF the disk space of our previous release. This post covers all the details.
    Blog / 13 May 2022
  • Subscribe to weekly ProcessWire news

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer