$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->addRole($role)
boolAdd Role to this user 
$user->admin_theme string Admin theme class name 
$user->changed(string $what)
(nothing)Hook called when field has changed
$user->email string Get or set email address for 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->isGuest()
boolIs this the non-logged in guest user? 
$user->isLoggedin()
boolIs the current user logged in? 
$user->isSuperuser()
boolDoes this user have the superuser role? 
$user->language Language User language, applicable only if LanguageSupport installed. 
$user->pass string Password Set the user’s password.  
$user->removeRole($role)
boolRemove Role from this user 
$user->roles PageArray Get the roles this user has.  

For hooks

These methods are only useful for hooking and should not be called directly.

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

Twitter updates

  • ProcessWire 3.0.153 (dev) focuses on comments field updates, significant refactoring/improvements to ProcessWire’s core Template class and PagesLoader class (which is used by the pages API variable), and we introduce a useful new pages API method— More
    20 March 2020
  • ProcessWire 3.0.152 core updates— This week we have some major improvements to our core date/time Inputfield, as well as a new ability to specify your own custom classes for Page objects— More
    6 March 2020
  • This week we’ve got a couple of really useful API-side improvements to the core in 3.0.151, including predefined image settings and static language translation improvements— More
    21 February 2020

Latest news

  • ProcessWire Weekly #307
    In the 307th issue of ProcessWire Weekly we're going to check out the latest dev branch updates, introduce some new third party modules, and more. Read on!
    Weekly.pw / 28 March 2020
  • ProcessWire 3.0.153 core updates
    This latest version of the core on the dev branch focuses on comments field updates, significant refactoring/improvements to ProcessWire’s core Template class and PagesLoader class (which is used by the $pages API variable), and we introduce a useful new $pages API method.
    Blog / 20 March 2020
  • Subscribe to weekly ProcessWire news

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani