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


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


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


$user->language Language User language, applicable only if LanguageSupport installed.  
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.236

Latest news

  • ProcessWire Weekly #531
    In the 531st issue of ProcessWire Weekly we’ll check out the latest weekly update from Ryan, introduce new third party modules, and more. Read on!
    Weekly.pw / 13 July 2024
  • Page List Custom Children module
    This simple module gives you the ability to customize the parent/child relationship as it appears in the admin page list, enabling child pages to appear under more than one parent.
    Blog / 28 June 2024
  • Subscribe to weekly ProcessWire news

I just love the easy and intuitive ProcessWire API. ProcessWire rocks!” —Jens Martsch, Web developer