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


Functions methods and properties

API reference based on ProcessWire core version 3.0.248

Latest news

  • ProcessWire Weekly #582
    The 582nd issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 5 July 2025
  • New ProcessWire admin redesign
    When you upgrade to ProcessWire 3.0.248 or newer (currently the dev branch), you’ll immediately notice something new and beautiful…
    Blog / 9 May 2025
  • 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