$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 #523
    In the 523rd issue of ProcessWire Weekly we'll check out what's new in the core this week, share some new module related news, and more. Read on!
    Weekly.pw / 18 May 2024
  • ProFields Table Field with Actions support
    This week we have some updates for the ProFields table field (FieldtypeTable). These updates are primarily focused on adding new tools for the editor to facilitate input and management of content in a table field.
    Blog / 12 April 2024
  • 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