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

Common

Name	Return	Summary
$user->changed() $user->changed(string $what) $user->changed(string $what, mixed $old = null, mixed $new = null)	None	Hook called when field has changed
$user->get() $user->get(string $key) $user->get(string $key)	`null` `mixed`	Get value
$user->roles	`PageArray`	Get the roles this user has.
$user->setEditor() $user->setEditor(WirePageEditor $editor) $user->setEditor(WirePageEditor $editor)	None	Set the Process module (WirePageEditor) that is editing this User

Access

Name	Return	Summary
$user->addRole() $user->addRole($role) $user->addRole($role)	`bool`	Add Role to this user
$user->getPermissions() $user->getPermissions() $user->getPermissions($page = null)	`PageArray`	Get this user’s permissions, optionally within the context of a Page.
$this->hasPagePermission() $this->hasPagePermission($name) $this->hasPagePermission($name, $page = null)	`bool`	Does this user have named permission for the given Page?
$user->hasPermission() $user->hasPermission($name) $user->hasPermission($name, $context = null)	`bool` `array`	Does the user have the given permission?
$user->hasRole() $user->hasRole($role) $user->hasRole($role)	`bool`	Does this user have the given Role?
$this->hasTemplatePermission() $this->hasTemplatePermission($name, $template) $this->hasTemplatePermission($name, $template)	`bool`	Does this user have the given permission on the given template?
$user->hasTfa() $user->hasTfa() $user->hasTfa(bool $getInstance = false)	`bool` `string` `Tfa`	Does user have two-factor authentication (Tfa) enabled? (and what type?)
$user->isGuest() $user->isGuest() $user->isGuest()	`bool`	Is this the non-logged in guest user?
$user->isLoggedin() $user->isLoggedin() $user->isLoggedin()	`bool`	Is the current $user logged in and the same as this user?
$user->isSuperuser() $user->isSuperuser() $user->isSuperuser()	`bool`	Does this user have the superuser role?
$user->removeRole() $user->removeRole($role) $user->removeRole($role)	`bool`	Remove Role from this user
$user->roles	`PageArray`	Get the roles this user has.

Languages

Name	Return	Summary
$user->language	`Language`	User language, applicable only if LanguageSupport installed.
$user->setLanguage() $user->setLanguage($language) $user->setLanguage($language)	`self`	Set language for user (quietly)

Properties

Name	Return	Summary
$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