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

Twitter updates

  • Happy New Year! Today I’ve bumped the version on the dev branch to 3.0.170, and it’s quite a lot of updates. This post covers most of them. In this post, there’s also a question for you: what would you like to see in ProcessWire in 2021? More
    1 January 2021
  • In this week’s blog post we’ll take a brief look at a powerful new ProFields module for ProcessWire that’s just around the corner—the Combo field: More
    4 December 2020
  • There’s a new modules directory on the ProcessWire site now up and running. In this post we’ll cover a few details about what’s changed and what’s new—More
    20 November 2020

Latest news

  • ProcessWire Weekly #347
    In the 347th issue of ProcessWire Weekly we'll check out ProcessWire 3.0.170, introduce the PDF Fieldtype/Inputfield module, and more. Read on!
    Weekly.pw / 2 January 2021
  • ProcessWire 3.0.170 core updates
    Happy New Year! Today I’ve bumped the version on the dev branch to 3.0.170, and it’s quite a lot of updates. This post covers most of them. In this post, there’s also a question for you: what would you like to see in ProcessWire in 2021?
    Blog / 1 January 2021
  • Subscribe to weekly ProcessWire news

I just love the easy and intuitive ProcessWire API. ProcessWire rocks!” —Jens Martsch, Web developer