Template::getRoles() method

Get the role pages that are part of this template

  • This method returns a blank PageArray if roles haven’t yet been loaded into the template.
  • If the roles have previously been loaded as an array, then this method converts that array to a PageArray and returns it.
  • If you make changes to returned roles, make sure to set it back to the template again with setRoles(). It’s preferable to make changes with addRole() and removeRole() methods instead.

Usage

// basic usage
$items = $template->getRoles();

// usage with all arguments
$items = $template->getRoles(string $type = 'view');

Arguments

NameType(s)Description
type (optional)string

Default is 'view', but you may also specify 'edit', 'create' or 'add' to retrieve those.

Return value

PageArray

of Role objects.

Exceptions

Method can throw exceptions on error:

  • WireException - if given an unknown roles type


Template methods and properties

API reference based on ProcessWire core version 3.0.200

Twitter updates

  • New blog: Debugging tools built-in to ProcessWire. ProcessWire's core comes with a lot of helpful debugging tools and capabilities built-in. In this post we'll cover some of these useful tools and how to use them… More
    1 July 2022
  • A review of weekly core updates, plus a simple recipe for a very effective listing cache—More
    24 June 2022
  • Weekly update: Making ProcessWire render pages at old WordPress URLs (or building a simple/custom URL router in PW): More
    17 June 2022

Latest news

  • ProcessWire Weekly #424
    In the 424th issue of ProcessWire Weekly we'll check out the latest weekly update from Ryan, introduce a new third party module, and more. Read on!
    Weekly.pw / 25 June 2022
  • Debugging tools built into ProcessWire
    ProcessWire's core comes with a lot of helpful debugging tools and capabilities built-in. In this post we'll cover some of these useful tools and how to use them.
    Blog / 1 July 2022
  • 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