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.

Common / For hooks

Show “$user”             Show Arguments        


boolAdd Role to this user
$user->changed(string $what)
(nothing)Hook called when field has changed
$user->email string Get or set email address for this user.
PageArrayGet this user’s permissions, optionally within the context of a Page.
bool or arrayDoes the user have the given permission?
boolDoes this user have the given Role?
boolIs this the non-logged in guest user?
boolIs the current user logged in?
boolDoes this user have the superuser role?
$user->language Language User language, applicable only if LanguageSupport installed.
$user->pass string or Password Set the user’s password.
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.

boolDoes this user have named permission for the given Page?
$user->hasTemplatePermission(string $name, $template)
boolDoes this user have the given permission on the given template?

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