$user / User

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?       Only hookable?    

Common

NameReturnSummary 
$user->get(string $key)
null mixedGet value 
$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->hasPagePermission($name)
boolDoes this user have named permission for the given Page?
$user->hasPermission($name)
bool arrayDoes the user have the given permission? 
$user->hasRole($role)
boolDoes this user have the given Role? 
$user->hasTemplatePermission($name, $template)
boolDoes this user have the given permission on the given template?
$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) 

Properties

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

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