User

Type
Class
Namespace
craft\console
Inherits
craft\console\User » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
Implements
yii\base\Configurable (opens new window)
Since
3.0.0

The User component provides APIs for managing the user authentication status.

An instance of the User component is globally accessible in Craft via Craft::$app->user.

View source (opens new window)

# Public Properties

# id

Type
integer (opens new window), null (opens new window)
Default value
null
Access
Read-only

View source (opens new window)

# identity

Type
craft\elements\User, yii\web\IdentityInterface (opens new window), false (opens new window), null (opens new window)
Default value
null
Access
Read-only

View source (opens new window)

# isAdmin

Type
boolean (opens new window)
Default value
null
Access
Read-only

Whether the current user is an admin.

View source (opens new window)

# isGuest

Type
boolean (opens new window)
Default value
null
Access
Read-only

Whether the current user is a guest.

View source (opens new window)

# Public Methods

Method Description
__call() (opens new window) Calls the named method which is not a class method.
__clone() (opens new window) This method is called after the object is created by cloning an existing one.
__construct() (opens new window) Constructor.
__get() (opens new window) Returns the value of an object property.
__isset() (opens new window) Checks if a property is set, i.e. defined and not null.
__set() (opens new window) Sets value of an object property.
__unset() (opens new window) Sets an object property to null.
attachBehavior() (opens new window) Attaches a behavior to this component.
attachBehaviors() (opens new window) Attaches a list of behaviors to the component.
behaviors() (opens new window) Returns a list of behaviors that this component should behave as.
canGetProperty() (opens new window) Returns a value indicating whether a property can be read.
canSetProperty() (opens new window) Returns a value indicating whether a property can be set.
checkPermission() Returns whether the current user has a given permission.
className() (opens new window) Returns the fully qualified name of this class.
detachBehavior() (opens new window) Detaches a behavior from the component.
detachBehaviors() (opens new window) Detaches all behaviors from the component.
ensureBehaviors() (opens new window) Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component.
getBehavior() (opens new window) Returns the named behavior object.
getBehaviors() (opens new window) Returns all behaviors attached to this component.
getId() Returns the current user’s ID, if they are logged in.
getIdentity() Returns the current identity object.
getIsAdmin() Returns whether the current user is an admin.
getIsGuest() Returns whether the current user is a guest (not authenticated).
hasEventHandlers() (opens new window) Returns a value indicating whether there is any handler attached to the named event.
hasMethod() (opens new window) Returns a value indicating whether a method is defined.
hasProperty() (opens new window) Returns a value indicating whether a property is defined.
init() (opens new window) Initializes the object.
off() (opens new window) Detaches an existing event handler from this component.
on() (opens new window) Attaches an event handler to an event.
setIdentity() Sets the user identity object.
trigger() (opens new window) Triggers an event.

# checkPermission()

Returns whether the current user has a given permission.

View source (opens new window)

Arguments

Returns

boolean (opens new window) – Whether the current user has the permission.

# getId()

Returns the current user’s ID, if they are logged in.

See also getIdentity() View source (opens new window)

Returns

integer (opens new window), null (opens new window)

# getIdentity()

Returns the current identity object.

View source (opens new window)

Returns

craft\elements\User, yii\web\IdentityInterface (opens new window), false (opens new window), null (opens new window)

# getIsAdmin()

Returns whether the current user is an admin.

View source (opens new window)

Returns

boolean (opens new window) – Whether the current user is an admin.

# getIsGuest()

Returns whether the current user is a guest (not authenticated).

View source (opens new window)

Returns

boolean (opens new window) – Whether the current user is a guest.

# setIdentity()

Sets the user identity object.

View source (opens new window)

Arguments

Throws