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

Latest news

  • ProcessWire Weekly #554
    In the 554th issue of ProcessWire Weekly we'll check out the latest core updates, introduce a couple of new third party modules, and more. Read on!
    Weekly.pw / 21 December 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani