User

Type
Class
Namespace
craft\console
Inherits
craft\console\User » yii\base\Component » yii\base\BaseObject
Implements
yii\base\Configurable
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

# Public Properties

Property Description
behaviors yii\base\Behavior – List of behaviors attached to this component
id integer, null
identity craft\elements\User, yii\web\IdentityInterface, false, null
isAdmin boolean – Whether the current user is an admin.
isGuest boolean – Whether the current user is a guest.

# id

Type
integer, null
Access
Read-only

View source

# identity

Type
craft\elements\User, yii\web\IdentityInterface, false, null
Access
Read-only

View source

# isAdmin

Type
boolean
Access
Read-only

Whether the current user is an admin.

View source

# isGuest

Type
boolean
Access
Read-only

Whether the current user is a guest.

View source

# Public Methods

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

# checkPermission()

Returns whether the current user has a given permission.

View source

Arguments

  • $permissionName (string) – The name of the permission.

Returns

boolean – Whether the current user has the permission.

# getId()

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

See also getIdentity() View source

Returns

integer, null

# getIdentity()

Returns the current identity object.

View source

Returns

craft\elements\User, yii\web\IdentityInterface, false, null

# getIsAdmin()

Returns whether the current user is an admin.

View source

Returns

boolean – Whether the current user is an admin.

# getIsGuest()

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

View source

Returns

boolean – Whether the current user is a guest.

# setIdentity()

Sets the user identity object.

View source

Arguments

Throws