User
- Type
- Class
- Namespace
- craft\elements
- Inherits
- craft\elements\User » craft\base\Element » craft\base\Component » craft\base\Model » yii\base\Model (opens new window) » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
- Implements
- ArrayAccess (opens new window), IteratorAggregate (opens new window), craft\base\ComponentInterface, craft\base\ElementInterface, craft\base\ModelInterface, yii\base\Arrayable (opens new window), yii\base\Configurable (opens new window), yii\base\StaticInstanceInterface (opens new window), yii\web\IdentityInterface (opens new window)
- Uses traits
- craft\base\ClonefixTrait, craft\base\ElementTrait, craft\base\NameTrait, yii\base\ArrayableTrait (opens new window), yii\base\StaticInstanceTrait (opens new window)
- Since
- 3.0.0
User represents a user element.
View source (opens new window)
# Public Properties
# active
- Type
- boolean (opens new window)
- Default value
false
- Since
- 4.0.0
Active
View source (opens new window)
# addresses
- Type
- craft\elements\Address[], null (opens new window)
- Default value
null
the user’s addresses
View source (opens new window)
# admin
- Type
- boolean (opens new window)
- Default value
false
Admin
View source (opens new window)
# authError
- Type
- string (opens new window), null (opens new window)
- Default value
null
Auth error
View source (opens new window)
# authKey
- Type
- string (opens new window), null (opens new window)
- Default value
null
- Access
- Read-only
A key that is used to check the validity of a given identity ID.
View source (opens new window)
# cooldownEndTime
- Type
- DateTime (opens new window), null (opens new window)
- Default value
null
the time when the user will be over their cooldown period
View source (opens new window)
# currentPassword
- Type
- string (opens new window), null (opens new window)
- Default value
null
Current password
View source (opens new window)
# email
- Type
- string (opens new window), null (opens new window)
- Default value
null
View source (opens new window)
# friendlyName
- Type
- string (opens new window), null (opens new window)
- Default value
null
the user’s first name or username
View source (opens new window)
# gqlTypeName
- Type
- string (opens new window)
- Default value
null
- Access
- Read-only
- Since
- 3.3.0
View source (opens new window)
# groups
- Type
- craft\models\UserGroup[]
- Default value
null
the user’s groups
View source (opens new window)
# hasDashboard
- Type
- boolean (opens new window)
- Default value
false
- Since
- 3.0.4
Whether the user has a dashboard
View source (opens new window)
# hasRoundedThumb
- Type
- boolean (opens new window)
- Default value
null
- Access
- Read-only
- Since
- 3.5.5
View source (opens new window)
# inheritorOnDelete
- Type
self
, null (opens new window)- Default value
null
The user who should take over the user’s content if the user is deleted.
View source (opens new window)
# invalidLoginCount
- Type
- integer (opens new window), null (opens new window)
- Default value
null
Invalid login count
View source (opens new window)
# isCredentialed
- Type
- boolean (opens new window)
- Default value
null
whether the user account can be logged into
View source (opens new window)
# isCurrent
- Type
- boolean (opens new window)
- Default value
null
whether this is the current logged-in user
View source (opens new window)
# lastInvalidLoginDate
- Type
- DateTime (opens new window), null (opens new window)
- Default value
null
Last invalid login date
View source (opens new window)
# lastLoginAttemptIp
- Type
- string (opens new window), null (opens new window)
- Default value
null
Last login attempt IP address.
View source (opens new window)
# lastLoginDate
- Type
- DateTime (opens new window), null (opens new window)
- Default value
null
Last login date
View source (opens new window)
# lastPasswordChangeDate
- Type
- DateTime (opens new window), null (opens new window)
- Default value
null
Last password change date
View source (opens new window)
# locked
- Type
- boolean (opens new window)
- Default value
false
Locked
View source (opens new window)
# lockoutDate
- Type
- DateTime (opens new window), null (opens new window)
- Default value
null
Lockout date
View source (opens new window)
# name
- Type
- string (opens new window)
- Default value
null
the user’s full name or username
View source (opens new window)
# newPassword
- Type
- string (opens new window), null (opens new window)
- Default value
null
New password
View source (opens new window)
# password
- Type
- string (opens new window), null (opens new window)
- Default value
null
Password
View source (opens new window)
# passwordResetRequired
- Type
- boolean (opens new window)
- Default value
false
Password reset required
View source (opens new window)
# pending
- Type
- boolean (opens new window)
- Default value
false
Pending
View source (opens new window)
# photo
- Type
- craft\elements\Asset, null (opens new window)
- Default value
null
the user’s photo
View source (opens new window)
# photoId
- Type
- integer (opens new window), null (opens new window)
- Default value
null
Photo asset ID
View source (opens new window)
# preferences
- Type
- array (opens new window)
- Default value
null
the user’s preferences
View source (opens new window)
# preferredLanguage
- Type
- string (opens new window), null (opens new window)
- Default value
null
the user’s preferred language
View source (opens new window)
# preferredLocale
- Type
- string (opens new window), null (opens new window)
- Default value
null
the user’s preferred formatting locale
View source (opens new window)
# remainingCooldownTime
- Type
- DateInterval (opens new window), null (opens new window)
- Default value
null
the remaining cooldown time for this user, if they've entered their password incorrectly too many times
View source (opens new window)
# suspended
- Type
- boolean (opens new window)
- Default value
false
Suspended
View source (opens new window)
# thumbAlt
- Type
- string (opens new window), null (opens new window)
- Default value
null
- Access
- Read-only
- Since
- 4.0.0
View source (opens new window)
# unverifiedEmail
- Type
- string (opens new window), null (opens new window)
- Default value
null
Unverified email
View source (opens new window)
# username
- Type
- string (opens new window), null (opens new window)
- Default value
null
Username
View source (opens new window)
# verificationCode
- Type
- string (opens new window), null (opens new window)
- Default value
null
Verification code
View source (opens new window)
# verificationCodeIssuedDate
- Type
- DateTime (opens new window), null (opens new window)
- Default value
null
Verification code issued date
View source (opens new window)
# Protected Properties
Property | Description |
---|---|
revisionCreatorId | integer (opens new window), null (opens new window) – Revision creator ID to be saved |
revisionNotes | string (opens new window), null (opens new window) – Revision notes to be saved |
# Public Methods
Method | Description |
---|---|
__call() | Calls the named method which is not a class method. |
__clone() | |
__construct() | |
__get() | Returns the value of a component property. |
__isset() | Checks if a property is set. |
__set() | Sets the value of a component property. |
__toString() | Use the full name or username as the string representation. |
__unset() (opens new window) | Sets a component property to be null. |
actions() | Returns the available element actions (opens new window) for a given source. |
activeAttributes() (opens new window) | Returns the attribute names that are subject to validation in the current scenario. |
addError() | Adds a new error to the specified attribute. |