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

Latest news

  • ProcessWire Weekly #558
    In the 558th issue of ProcessWire Weekly we'll check out the blog post that introduces ProcessWire 3.0.244, share some recent ProcessWire highlights, and more. Read on!
    Weekly.pw / 18 January 2025
  • ProcessWire 3.0.244 new main/master version
    ProcessWire 3.0.244 is our newest main/master/stable version. It's been more than a year in the making and is packed with tons of new features, issue fixes, optimizations and more. This post covers all the details.
    Blog / 18 January 2025
  • 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