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

Latest news

  • ProcessWire Weekly #511
    In the 511th issue of ProcessWire Weekly we'll cover the latest core updates, introduce a new third party module called Auto AVIF, and more. Read on!
    Weekly.pw / 25 February 2024
  • Using date range fields in ProcessWire
    This week we'll take a detailed look at the newest addition to the ProFields set of modules: the Date Range Fieldtype and Inputfield.
    Blog / 24 November 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