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

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

Usage

// basic usage
$roles = roles();

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

Arguments

NameType(s)Description
selector (optional)string, int
  • Specify name or ID of role to get (Role object)
  • Specify selector string matching roles to find (PageArray object)

Return value

Roles Role PageArray null NullPage

Functions methods and properties

API reference based on ProcessWire core version 3.0.236

Newest forum posts

Latest news

  • ProcessWire Weekly #549
    In the 549th issue of ProcessWire Weekly we’re going to check out the latest core updates, highlight one older yet still very relevant third party module, and more. Read on!
    Weekly.pw / 17 November 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

“Indeed, if ProcessWire can be considered as a CMS in its own right, it also offers all the advantages of a CMF (Content Management Framework). Unlike other solutions, the programmer is not forced to follow the proposed model and can integrate his/her ways of doing things.” —Guy Verville, Spiria Digital Inc.