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

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK