$user->hasPermission() method

Does the user have the given permission?

  • Optionally accepts a Page or Template context for the permission.
  • This method accounts for the user's permissions across all their roles.

Example

if($user->hasPermission('page-publish')) {
  // user has the page-publish permission in one of their roles
}
if($user->hasPermission('page-publish', $page)) {
  // user has page-publish permission for $page
}

Usage

// basic usage
$bool = $user->hasPermission($name);

// usage with all arguments
$bool = $user->hasPermission($name, $context = null);

Arguments

NameType(s)Description
namestring, Permission

Permission name, object or id.

context (optional)Page, Template, bool, string

Page or Template...

  • or specify boolean true to return if user has permission OR if it was added at any template
  • or specify string "templates" to return array of Template objects where user has permission

Return value

bool array


$user methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #515
    In the 515th issue of ProcessWire Weekly we’ll check out the latest core updates, new modules, and more. Read on!
    Weekly.pw / 23 March 2024
  • Invoices Site Profile
    The new invoices site profile is a free invoicing application developed in ProcessWire. It enables you to create invoices, record payments to them, email invoices to clients, print invoices, and more. This post covers all the details.
    Blog / 15 March 2024
  • Subscribe to weekly ProcessWire news

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer