$user API variable / User class

The $user API variable is a type of page representing the current user, and the User class is Page type used for all users.

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the User class also inherits all the methods and properties of: Page, WireData and Wire.

Show $var?             Show args?        

Common

NameReturnSummary 
$user->admin_theme string Admin theme class name (when applicable). 
$user->email string Get or set email address for this user. 
$user->pass string Password Set the user’s password.  
$user->roles PageArray Get the roles this user has.  

Access

NameReturnSummary 
$user->addRole($role)
boolAdd Role to this user 
$user->getPermissions()
PageArrayGet this user’s permissions, optionally within the context of a Page. 
$user->hasPermission($name)
bool arrayDoes the user have the given permission? 
$user->hasRole($role)
boolDoes this user have the given Role? 
$user->hasTfa()
bool string TfaDoes user have two-factor authentication (Tfa) enabled? (and what type?) 
$user->isGuest()
boolIs this the non-logged in guest user? 
$user->isLoggedin()
boolIs the current $user logged in and the same as this user? 
$user->isSuperuser()
boolDoes this user have the superuser role? 
$user->removeRole($role)
boolRemove Role from this user 
$user->roles PageArray Get the roles this user has.  

Languages

NameReturnSummary 
$user->language Language User language, applicable only if LanguageSupport installed.  
$user->setLanguage($language)
selfSet language for user (quietly) 

Additional methods and properties

In addition to the methods and properties above, User also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.200

Twitter updates

  • A review of weekly core updates, plus a simple recipe for a very effective listing cache—More
    24 June 2022
  • Weekly update: Making ProcessWire render pages at old WordPress URLs (or building a simple/custom URL router in PW): More
    17 June 2022
  • New post: ProcessWire now comes with just 1 site installation profile, the "blank" profile. It makes very few assumptions, making it a minimal though excellent starting point. Here’s how you might use it— More
    10 June 2022

Latest news

  • ProcessWire Weekly #424
    In the 424th issue of ProcessWire Weekly we'll check out the latest weekly update from Ryan, introduce a new third party module, and more. Read on!
    Weekly.pw / 25 June 2022
  • Starting a site with the “blank” profile
    ProcessWire 3.0.200+ comes with just 1 site installation profile, the site-blank profile. This profile makes very few assumptions, making it a minimal though excellent starting point. Here’s how you might use it. 
    Blog / 10 June 2022
  • Subscribe to weekly ProcessWire news

“We chose ProcessWire because of its excellent architecture, modular extensibility and the internal API. The CMS offers the necessary flexibility and performance for such a complex website like superbude.de. ProcessWire offers options that are only available for larger systems, such as Drupal, and allows a much slimmer development process.” —xport communication GmbH