Template::addPermissionByRole() method

Add a permission that applies to users having a specific role with pages using this template

Note that the change is not committed until you save() the template.

Usage

// basic usage
$bool = $template->addPermissionByRole($permission, $role);

// usage with all arguments
$bool = $template->addPermissionByRole($permission, $role, bool $test = false);

Arguments

NameType(s)Description
permissionPermission, int, string

Permission object, name, or id

roleRole, int, string

Role object, name or id

test (optional)bool

Specify true to only test if an update would be made, without changing anything

Return value

bool

Returns true if an update was made (or would be made), false if not


Template methods and properties

API reference based on ProcessWire core version 3.0.244

Latest news

  • ProcessWire Weekly #559
    The 559th issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 25 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 just love the easy and intuitive ProcessWire API. ProcessWire rocks!” —Jens Martsch, Web developer