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


Name Return Summary  
$user->addRole($role) bool Add Role to this user
$user->email string Get or set email address for this user.
$user->getPermissions() PageArray Get this user’s permissions, optionally within the context of a Page.
$user->hasPermission($name) bool Does the user have the given permission?
$user->hasRole($role) bool Does this user have the given Role?
$user->isGuest() bool Is this the non-logged in guest user?
$user->isLoggedin() bool Is the current user logged in?
$user->isSuperuser() bool Does 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.
$user->removeRole($role) bool Remove Role from this user
$user->roles PageArray Get the roles this user has.

For hooks

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

Name Return Summary  
$user->hasPagePermission($name) bool Does this user have named permission for the given Page?
$user->hasTemplatePermission(string $name, $template) bool Does 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: