Class craft\elements\User

Inheritance: craft\elements\User » craft\base\Element » craft\base\Component » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject
Implements: ArrayAccess, IteratorAggregate, craft\base\ComponentInterface, craft\base\ElementInterface, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface, yii\web\IdentityInterface
Uses Traits: craft\base\ElementTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait
Available since version: 3.0
Source Code: https://github.com/craftcms/cms/blob/master/src/elements/User.php

User represents a user element.

Public Properties
Property	Type	Description	Defined By
`$admin`	boolean	Admin	craft\elements\User
`$archived`	boolean	Whether the element is archived	craft\base\ElementTrait
`$authError`	string, null	Auth error	craft\elements\User
`$awaitingFieldValues`	boolean	Whether the element is still awaiting its custom field values	craft\base\ElementTrait
`$client`	boolean	Client	craft\elements\User
`$contentId`	integer, null	The element’s content row ID	craft\base\ElementTrait
`$currentPassword`	string, null	Current password	craft\elements\User
`$dateCreated`	DateTime, null	The date that the element was created	craft\base\ElementTrait
`$dateUpdated`	DateTime, null	The date that the element was last updated	craft\base\ElementTrait
`$email`	string, null	Email	craft\elements\User
`$enabled`	boolean	Whether the element is enabled	craft\base\ElementTrait
`$enabledForSite`	boolean	Whether the element is enabled for this site.	craft\base\ElementTrait
`$fieldLayoutId`	integer, null	The element’s field layout ID	craft\base\ElementTrait
`$firstName`	string, null	First name	craft\elements\User
`$id`	integer, null	The element’s ID	craft\base\ElementTrait
`$inheritorOnDelete`	self, null	The user who should take over the user’s content if the user is deleted.	craft\elements\User
`$invalidLoginCount`	integer, null	Invalid login count	craft\elements\User
`$lastInvalidLoginDate`	DateTime, null	Last invalid login date	craft\elements\User
`$lastLoginAttemptIp`	string, null	Last login attempt IP address.	craft\elements\User
`$lastLoginDate`	DateTime, null	Last login date	craft\elements\User
`$lastName`	string, null	Last name	craft\elements\User
`$lastPasswordChangeDate`	DateTime, null	Last password change date	craft\elements\User
`$level`	integer, null	The element’s level within its structure	craft\base\ElementTrait
`$lft`	integer, null	The element’s left position within its structure	craft\base\ElementTrait
`$locked`	boolean	Locked	craft\elements\User
`$lockoutDate`	DateTime, null	Lockout date	craft\elements\User
`$newPassword`	string, null	New password	craft\elements\User
`$password`	string, null	Password	craft\elements\User
`$passwordResetRequired`	boolean	Password reset required	craft\elements\User
`$pending`	boolean	Pending	craft\elements\User
`$photoId`	integer, null	Photo asset id	craft\elements\User
`$propagating`	boolean	Whether the element is being saved in the context of propagating another site's version of the element.	craft\base\ElementTrait
`$rgt`	integer, null	The element’s right position within its structure	craft\base\ElementTrait
`$root`	integer, null	The element’s structure’s root ID	craft\base\ElementTrait
`$searchScore`	integer, null	The element’s search score, if the craft\elements\db\ElementQuery::search() parameter was used when querying for the element	craft\base\ElementTrait
`$siteId`	integer, null	The site ID the element is associated with	craft\base\ElementTrait
`$slug`	string, null	The element’s slug	craft\base\ElementTrait
`$structureId`	integer, null	The element’s structure ID	craft\base\ElementTrait
`$suspended`	boolean	Suspended	craft\elements\User
`$tempId`	string, null	The element’s temporary ID (only used if the element's URI format contains {id})	craft\base\ElementTrait
`$title`	string, null	The element’s title	craft\base\ElementTrait
`$uid`	string, null	The element’s UID	craft\base\ElementTrait
`$unverifiedEmail`	string, null	Unverified email	craft\elements\User
`$uri`	string, null	The element’s URI	craft\base\ElementTrait
`$username`	string, null	Username	craft\elements\User
`$verificationCode`	string, null	Verification code	craft\elements\User
`$verificationCodeIssuedDate`	DateTime, null	Verification code issued date	craft\elements\User

Public Methods
Method	Description	Defined By
`__call()`	Calls the named method which is not a class method.	craft\base\Element
`__clone()`	This method is called after the object is created by cloning an existing one.	yii\base\Component
`__construct()`	Constructor.	yii\base\BaseObject
`__get()`	Returns the value of a component property.	craft\base\Element
`__isset()`	Checks if a property is set.	craft\base\Element
`__set()`	Sets the value of a component property.	craft\base\Element
`__toString()`		craft\elements\User
`__unset()`	Sets an object property to null.	yii\base\BaseObject
`actions()`	Returns the available element actions for a given source (if one is provided).	craft\base\Element
`activeAttributes()`	Returns the attribute names that are subject to validation in the current scenario.	yii\base\Model
`addError()`	Adds a new error to the specified attribute.	craft\base\Element
`addErrors()`	Adds a list of errors.	yii\base\Model
`addModelErrors()`	Adds errors from another model, with a given attribute name prefix.	craft\base\Model
`afterDelete()`	Performs actions after an element is deleted.	craft\base\Element
`afterMoveInStructure()`	Performs actions after an element is moved within a structure.	craft\base\Element
`afterSave()`	Performs actions after an element is saved.	craft\elements\User
`afterValidate()`	This method is invoked after validation ends.	yii\base\Model
`attachBehavior()`	Attaches a behavior to this component.	yii\base\Component
`attachBehaviors()`	Attaches a list of behaviors to the component.	yii\base\Component
`attributeHints()`	Returns the attribute hints.	yii\base\Model
`attributeLabels()`	Returns the attribute labels.	craft\base\Element
`attributes()`	Returns the list of attribute names.	craft\elements\User
`authData()`	Returns the authentication data from a given auth key.	craft\elements\User
`authenticate()`	Determines whether the user is allowed to be logged in with a given password.	craft\elements\User
`beforeDelete()`	Performs actions before an element is deleted.	craft\elements\User
`beforeMoveInStructure()`	Performs actions before an element is moved within a structure.	craft\base\Element
`beforeSave()`	Performs actions before an element is saved.	craft\base\Element
`beforeValidate()`	This method is invoked before validation starts.	yii\base\Model
`behaviors()`	Returns a list of behaviors that this component should behave as.	craft\base\Element
`can()`	Returns whether the user has permission to perform a given action.	craft\elements\User
`canGetProperty()`	Returns a value indicating whether a property can be read.	yii\base\BaseObject
`canSetProperty()`	Returns a value indicating whether a property can be set.	yii\base\BaseObject
`className()`	Returns the fully qualified name of this class.	yii\base\BaseObject
`clearErrors()`	Removes errors for all attributes or a single attribute.	yii\base\Model
`createValidators()`	Creates validator objects based on the validation rules specified in rules().	yii\base\Model
`datetimeAttributes()`	Returns the names of any attributes that should hold DateTime values.	craft\elements\User
`defaultTableAttributes()`	Returns the list of table attribute keys that should be shown by default.	craft\base\Element
`detachBehavior()`	Detaches a behavior from the component.	yii\base\Component
`detachBehaviors()`	Detaches all behaviors from the component.	yii\base\Component
`displayName()`	Returns the display name of this class.	craft\elements\User
`eagerLoadingMap()`	Returns an array that maps source-to-target element IDs based on the given sub-property handle.	craft\elements\User
`ensureBehaviors()`	Makes sure that the behaviors declared in behaviors() are attached to this component.	yii\base\Component
`extraFields()`	Returns the list of fields that can be expanded further and returned by toArray().	craft\elements\User
`fields()`	Returns the list of fields that should be returned by default by toArray() when no specific fields are specified.	yii\base\ArrayableTrait
`find()`	Creates an craft\elements\db\ElementQueryInterface instance for query purpose.	craft\elements\User
`findAll()`	Returns a list of elements that match the specified ID(s) or a set of element criteria parameters.	craft\base\Element
`findIdentity()`	Finds an identity by the given ID.	craft\elements\User
`findIdentityByAccessToken()`	Finds an identity by the given token.	craft\elements\User
`findOne()`	Returns a single element instance by a primary key or a set of element criteria parameters.	craft\base\Element
`formName()`	Returns the form name that this model class should use.	yii\base\Model
`generateAttributeLabel()`	Generates a user friendly attribute label based on the give attribute name.	yii\base\Model
`getActiveValidators()`	Returns the validators applicable to the current \yii\base\scenario.	yii\base\Model
`getAncestors()`	Returns the element’s ancestors.	craft\base\Element
`getAttributeHint()`	Returns the text hint for the specified attribute.	yii\base\Model
`getAttributeLabel()`	Returns the text label for the specified attribute.	craft\base\Element
`getAttributes()`	Returns attribute values.	yii\base\Model
`getAuthKey()`	Returns a key that can be used to check the validity of a given identity ID.	craft\elements\User
`getBehavior()`	Returns the named behavior object.	yii\base\Component
`getBehaviors()`	Returns all behaviors attached to this component.	yii\base\Component
`getChildren()`	Returns the element’s children.	craft\base\Element
`getContentTable()`	Returns the name of the table this element’s content is stored in.	craft\base\Element
`getCooldownEndTime()`	Returns the time when the user will be over their cooldown period.	craft\elements\User
`getCpEditUrl()`	Returns the element’s CP edit URL.	craft\elements\User
`getDescendants()`	Returns the element’s descendants.	craft\base\Element
`getEagerLoadedElements()`	Returns the eager-loaded elements for a given handle.	craft\base\Element
`getEditorHtml()`	Returns the HTML for the element’s editor HUD.	craft\elements\User
`getError()`	Returns the first error of the specified attribute.	craft\base\Model
`getErrorSummary()`	Returns the errors for all attributes as a one-dimensional array.	yii\base\Model
`getErrors()`	Returns the errors for all attributes or a single attribute.	yii\base\Model
`getFieldColumnPrefix()`	Returns the field column prefix this element’s content uses.	craft\base\Element
`getFieldContext()`	Returns the field context this element’s content uses.	craft\base\Element
`getFieldLayout()`	Returns the field layout used by this element.	craft\elements\User
`getFieldParamNamespace()`	Returns the namespace used by custom field params on the request.	craft\base\Element
`getFieldValue()`	Returns the value for a given field.	craft\base\Element
`getFieldValues()`	Returns the element’s normalized custom field values, indexed by their handles.	craft\base\Element
`getFirstError()`	Returns the first error of the specified attribute.	yii\base\Model
`getFirstErrors()`	Returns the first error of every attribute in the model.	yii\base\Model
`getFriendlyName()`	Gets the user's first name or username.	craft\elements\User
`getFullName()`	Returns the user's full name.	craft\elements\User
`getGroups()`	Returns the user's groups.	craft\elements\User
`getHasDescendants()`	Returns whether the element has descendants.	craft\base\Element
`getHasFreshContent()`	Returns whether the element’s content is "fresh" (unsaved and without validation errors).	craft\base\Element
`getHtmlAttributes()`	Returns any attributes that should be included in the element’s DOM representation in the Control Panel.	craft\base\Element
`getId()`	Returns the element’s ID.	craft\base\Element
`getIsCurrent()`	Returns whether this is the current logged-in user.	craft\elements\User
`getIsEditable()`	Returns whether the current user can edit the element.	craft\elements\User
`getIterator()`	Returns an iterator for traversing the attributes in the model.	yii\base\Model
`getLink()`	Returns an anchor pre-filled with this element’s URL and title.	craft\base\Element
`getName()`	Returns the user's full name or username.	craft\elements\User
`getNext()`	Returns the next element relative to this one, from a given set of criteria.	craft\base\Element
`getNextSibling()`	Returns the element’s next sibling.	craft\base\Element
`getParent()`	Returns the element’s parent.	craft\base\Element
`getPhoto()`	Returns the user's photo.	craft\elements\User
`getPhotoUrl()`	Returns the URL to the user's photo.	craft\elements\User
`getPreference()`	Returns one of the user’s preferences by its key.	craft\elements\User
`getPreferences()`	Returns the user’s preferences.	craft\elements\User
`getPreferredLanguage()`	Returns the user’s preferred language, if they have one.	craft\elements\User
`getPrev()`	Returns the previous element relative to this one, from a given set of criteria.	craft\base\Element
`getPrevSibling()`	Returns the element’s previous sibling.	craft\base\Element
`getRef()`	Returns the reference string to this element.	craft\elements\User
`getRemainingCooldownTime()`	Returns the remaining cooldown time for this user, if they've entered their password incorrectly too many times.	craft\elements\User
`getRoute()`	Returns the route that should be used when the element’s URI is requested.	craft\base\Element
`getScenario()`	Returns the scenario that this model is used in.	yii\base\Model
`getSearchKeywords()`	Returns the search keywords for a given search attribute.	craft\base\Element
`getSerializedFieldValues()`	Returns an array of the element’s serialized custom field values, indexed by their handles.	craft\base\Element
`getSiblings()`	Returns all of the element’s siblings.	craft\base\Element
`getSite()`	Returns the site the element is associated with.	craft\base\Element
`getStatus()`	Returns the element’s status.	craft\elements\User
`getSupportedSites()`	Returns the sites this element is associated with.	craft\base\Element
`getTableAttributeHtml()`	Returns the HTML that should be shown for a given attribute in Table View.	craft\base\Element
`getThumbUrl()`	Returns the URL to the element’s thumbnail, if there is one.	craft\elements\User
`getTotalDescendants()`	Returns the total number of descendants that the element has.	craft\base\Element
`getUriFormat()`	Returns the URI format used to generate this element’s URI.	craft\base\Element
`getUrl()`	Returns the element’s full URL.	craft\base\Element
`getValidators()`	Returns all the validators declared in rules().	yii\base\Model
`hasContent()`	Returns whether elements of this type will be storing any data in the `content` table (tiles or custom fields).	craft\elements\User
`hasEagerLoadedElements()`	Returns whether elements have been eager-loaded with a given handle.	craft\base\Element
`hasErrors()`	Returns a value indicating whether there is any validation error.	yii\base\Model
`hasEventHandlers()`	Returns a value indicating whether there is any handler attached to the named event.	yii\base\Component
`hasMethod()`	Returns a value indicating whether a method is defined.	yii\base\BaseObject
`hasProperty()`	Returns a value indicating whether a property is defined.	yii\base\BaseObject
`hasShunned()`	Returns whether the user has shunned a given message.	craft\elements\User
`hasStatuses()`	Returns whether elements of this type have statuses.	craft\elements\User
`hasTitles()`	Returns whether elements of this type have traditional titles.	craft\base\Element
`hasUris()`	Returns whether elements of this type can have their own slugs and URIs.	craft\base\Element
`indexHtml()`	Returns the element index HTML.	craft\base\Element
`init()`	Initializes the object.	craft\elements\User
`instance()`	Returns static class instance, which can be used to obtain meta information.	yii\base\StaticInstanceTrait
`isAncestorOf()`	Returns whether this element is an ancestor of another one.	craft\base\Element
`isAttributeActive()`	Returns a value indicating whether the attribute is active in the current scenario.	yii\base\Model
`isAttributeRequired()`	Returns a value indicating whether the attribute is required.	yii\base\Model
`isAttributeSafe()`	Returns a value indicating whether the attribute is safe for massive assignments.	yii\base\Model
`isChildOf()`	Returns whether this element is a direct child of another one.	craft\base\Element
`isDescendantOf()`	Returns whether this element is a descendant of another one.	craft\base\Element
`isFieldEmpty()`	Returns whether a field is empty.	craft\base\Element
`isInGroup()`	Returns whether the user is in a specific group.	craft\elements\User
`isLocalized()`	Returns whether elements of this type store content on a per-site basis.	craft\base\Element
`isNextSiblingOf()`	Returns whether this element is the direct next sibling of another one.	craft\base\Element
`isParentOf()`	Returns whether this element is a direct parent of another one.	craft\base\Element
`isPrevSiblingOf()`	Returns whether this element is the direct previous sibling of another one.	craft\base\Element
`isSiblingOf()`	Returns whether this element is a sibling of another one.	craft\base\Element
`load()`	Populates the model with input data.	yii\base\Model
`loadMultiple()`	Populates a set of models with the data from end user.	yii\base\Model
`mergePreferences()`	Merges new user preferences with the existing ones, and returns the result.	craft\elements\User
`off()`	Detaches an existing event handler from this component.	yii\base\Component
`offsetExists()`	Returns whether there is an element at the specified offset.	craft\base\Element
`offsetGet()`	Returns the element at the specified offset.	yii\base\Model
`offsetSet()`	Sets the element at the specified offset.	yii\base\Model
`offsetUnset()`	Sets the element value at the specified offset to null.	yii\base\Model
`on()`	Attaches an event handler to an event.	yii\base\Component
`onUnsafeAttribute()`	This method is invoked when an unsafe attribute is being massively assigned.	yii\base\Model
`refHandle()`	Returns the handle that should be used to refer to this element type from reference tags.	craft\elements\User
`rules()`	Returns the validation rules for attributes.	craft\elements\User
`safeAttributes()`	Returns the attribute names that are safe to be massively assigned in the current scenario.	yii\base\Model
`scenarios()`	Returns a list of scenarios and the corresponding active attributes.	craft\elements\User
`searchableAttributes()`	Defines which element attributes should be searchable.	craft\base\Element
`setAttributes()`	Sets the attribute values in a massive way.	yii\base\Model
`setEagerLoadedElements()`	Sets some eager-loaded elements on a given handle.	craft\elements\User
`setFieldParamNamespace()`	Sets the namespace used by custom field params on the request.	craft\base\Element
`setFieldValue()`	Sets the value for a given field.	craft\base\Element
`setFieldValues()`	Sets the element’s custom field values.	craft\base\Element
`setFieldValuesFromRequest()`	Sets the element’s custom field values, when the values have come from post data.	craft\base\Element
`setGroups()`	Sets an array of User element objects on the user.	craft\elements\User
`setNext()`	Sets the default next element.	craft\base\Element
`setParent()`	Sets the element’s parent.	craft\base\Element
`setPhoto()`	Sets the entry's author.	craft\elements\User
`setPrev()`	Sets the default previous element.	craft\base\Element
`setScenario()`	Sets the scenario for the model.	yii\base\Model
`sortOptions()`	Returns the sort options for the element type.	craft\base\Element
`sources()`	Returns the source definitions that elements of this type may belong to.	craft\base\Element
`statuses()`	Returns all of the possible statuses that elements of this type may have.	craft\elements\User
`tableAttributes()`	Defines all of the available columns that can be shown in table views.	craft\base\Element
`toArray()`	Converts the model into an array.	yii\base\ArrayableTrait
`trigger()`	Triggers an event.	yii\base\Component
`validate()`	Performs the data validation.	yii\base\Model
`validateAuthKey()`	Validates the given auth key.	craft\elements\User
`validateCustomFieldAttribute()`	Calls a custom validation function on a custom field.	craft\base\Element
`validateCustomFieldContentSize()`	Validates that the content size is going to fit within the field’s database column.	craft\base\Element
`validateMultiple()`	Validates multiple models.	yii\base\Model
`validateUnverifiedEmail()`	Validates the unverifiedEmail value is unique.	craft\elements\User

Protected Methods
Method	Description	Defined By
`defineActions()`	Defines the available element actions for a given source (if one is provided).	craft\elements\User
`defineDefaultTableAttributes()`	Returns the list of table attribute keys that should be shown by default.	craft\elements\User
`defineSearchableAttributes()`	Defines which element attributes should be searchable.	craft\elements\User
`defineSortOptions()`	Returns the sort options for the element type.	craft\elements\User
`defineSources()`	Defines the sources that elements of this type may belong to.	craft\elements\User
`defineTableAttributes()`	Defines all of the available columns that can be shown in table views.	craft\elements\User
`extractFieldsFor()`	Extract nested fields from a fields collection for a given root field Nested fields are separated with dots (.). e.g: "item.id" The previous example would extract "id".	yii\base\ArrayableTrait
`extractRootFields()`	Extracts the root field names from nested fields.	yii\base\ArrayableTrait
`fieldByHandle()`	Returns the field with a given handle.	craft\base\Element
`fieldLayoutFields()`	Returns each of this element’s fields.	craft\base\Element
`findByCondition()`	Finds Element instance(s) by the given condition.	craft\base\Element
`htmlAttributes()`	Returns any attributes that should be included in the element’s DOM representation in the Control Panel.	craft\base\Element
`normalizeFieldValue()`	Normalizes a field’s value.	craft\base\Element
`prepElementQueryForTableAttribute()`	Preps the element criteria for a given table attribute	craft\base\Element
`resolveFields()`	Determines which fields can be returned by toArray().	yii\base\ArrayableTrait
`route()`	Returns the route that should be used when the element’s URI is requested.	craft\base\Element
`tableAttributeHtml()`	Returns the HTML that should be shown for a given attribute in Table View.	craft\elements\User

Events
Event	Type	Description	Defined By
`EVENT_AFTER_DELETE`	yii\base\Event	The event that is triggered after the element is deleted	craft\base\Element
`EVENT_AFTER_MOVE_IN_STRUCTURE`	craft\events\ElementStructureEvent	The event that is triggered after the element is moved in a structure.	craft\base\Element
`EVENT_AFTER_SAVE`	craft\events\ModelEvent	The event that is triggered after the element is saved	craft\base\Element
`EVENT_AFTER_VALIDATE`	yii\base\Event	An event raised at the end of validate()	yii\base\Model
`EVENT_BEFORE_AUTHENTICATE`	craft\events\AuthenticateUserEvent	The event that is triggered before a user is authenticated.	craft\elements\User
`EVENT_BEFORE_DELETE`	craft\events\ModelEvent	The event that is triggered before the element is deleted You may set craft\events\ModelEvent::$isValid to `false` to prevent the element from getting deleted.	craft\base\Element
`EVENT_BEFORE_MOVE_IN_STRUCTURE`	craft\events\ElementStructureEvent	The event that is triggered before the element is moved in a structure.	craft\base\Element
`EVENT_BEFORE_SAVE`	craft\events\ModelEvent	The event that is triggered before the element is saved You may set craft\events\ModelEvent::$isValid to `false` to prevent the element from getting saved.	craft\base\Element
`EVENT_BEFORE_VALIDATE`	yii\base\ModelEvent	An event raised at the beginning of validate().	yii\base\Model
`EVENT_DEFINE_BEHAVIORS`	craft\events\DefineBehaviorsEvent	The event that is triggered when defining the class behaviors	craft\base\Component
`EVENT_INIT`	yii\base\Event	The event that is triggered after the component's init cycle	craft\base\Component
`EVENT_REGISTER_ACTIONS`	craft\events\RegisterElementActionsEvent	The event that is triggered when registering the available actions for the element type.	craft\base\Element
`EVENT_REGISTER_DEFAULT_TABLE_ATTRIBUTES`	craft\events\RegisterElementTableAttributesEvent	The event that is triggered when registering the table attributes for the element type.	craft\base\Element
`EVENT_REGISTER_HTML_ATTRIBUTES`	craft\events\RegisterElementHtmlAttributesEvent	The event that is triggered when registering the HTML attributes that should be included in the element’s DOM representation in the Control Panel.	craft\base\Element
`EVENT_REGISTER_SEARCHABLE_ATTRIBUTES`	craft\events\RegisterElementSearchableAttributesEvent	The event that is triggered when registering the searchable attributes for the element type.	craft\base\Element
`EVENT_REGISTER_SORT_OPTIONS`	craft\events\RegisterElementSortOptionsEvent	The event that is triggered when registering the sort options for the element type.	craft\base\Element
`EVENT_REGISTER_SOURCES`	craft\events\RegisterElementSourcesEvent	The event that is triggered when registering the available sources for the element type.	craft\base\Element
`EVENT_REGISTER_TABLE_ATTRIBUTES`	craft\events\RegisterElementTableAttributesEvent	The event that is triggered when registering the table attributes for the element type.	craft\base\Element
`EVENT_SET_ROUTE`	craft\events\SetElementRouteEvent	The event that is triggered when defining the route that should be used when this element’s URL is requested `php Event::on(craft\elements\Entry::class, craft\base\Element::EVENT_SET_ROUTE, function(craft\events\SetElementRouteEvent $e) { // @var craft\elements\Entry $entry $entry = $e->sender; if ($entry->uri === 'pricing') { $e->route = 'module/pricing/index'; } } `	craft\base\Element
`EVENT_SET_TABLE_ATTRIBUTE_HTML`	craft\events\SetElementTableAttributeHtmlEvent	The event that is triggered when defining the HTML to represent a table attribute.	craft\base\Element

Constants
Constant	Value	Description	Defined By
`AUTH_ACCOUNT_COOLDOWN`	'account_cooldown'		craft\elements\User
`AUTH_ACCOUNT_LOCKED`	'account_locked'		craft\elements\User
`AUTH_ACCOUNT_SUSPENDED`	'account_suspended'		craft\elements\User
`AUTH_INVALID_CREDENTIALS`	'invalid_credentials'		craft\elements\User
`AUTH_NO_CP_ACCESS`	'no_cp_access'		craft\elements\User
`AUTH_NO_CP_OFFLINE_ACCESS`	'no_cp_offline_access'		craft\elements\User
`AUTH_NO_SITE_OFFLINE_ACCESS`	'no_site_offline_access'		craft\elements\User
`AUTH_PASSWORD_RESET_REQUIRED`	'password_reset_required'		craft\elements\User
`AUTH_PENDING_VERIFICATION`	'pending_verification'		craft\elements\User
`IMPERSONATE_KEY`	'Craft.UserSessionService.prevImpersonateUserId'		craft\elements\User
`SCENARIO_DEFAULT`	'default'	The name of the default scenario.	yii\base\Model
`SCENARIO_ESSENTIALS`	'essentials'		craft\base\Element
`SCENARIO_LIVE`	'live'		craft\base\Element
`SCENARIO_PASSWORD`	'password'		craft\elements\User
`SCENARIO_REGISTRATION`	'registration'		craft\elements\User
`STATUS_ACTIVE`	'active'		craft\elements\User
`STATUS_ARCHIVED`	'archived'		craft\base\Element
`STATUS_DISABLED`	'disabled'		craft\base\Element
`STATUS_ENABLED`	'enabled'		craft\base\Element
`STATUS_LOCKED`	'locked'		craft\elements\User
`STATUS_PENDING`	'pending'		craft\elements\User
`STATUS_SUSPENDED`	'suspended'		craft\elements\User

Property Details

`$admin` public property #

Admin

public boolean $admin = false

`$authError` public property #

Auth error

public string, null $authError = null

`$client` public property #

Client

public boolean $client = false

`$currentPassword` public property #

Current password

public string, null $currentPassword = null

`$email` public property #

public string, null $email = null

`$firstName` public property #

First name

public string, null $firstName = null

`$inheritorOnDelete` public property #

The user who should take over the user’s content if the user is deleted.

public self, null $inheritorOnDelete = null

`$invalidLoginCount` public property #

Invalid login count

public integer, null $invalidLoginCount = null

`$lastInvalidLoginDate` public property #

Last invalid login date

public DateTime, null $lastInvalidLoginDate = null

`$lastLoginAttemptIp` public property #

Last login attempt IP address.

public string, null $lastLoginAttemptIp = null

`$lastLoginDate` public property #

Last login date

public DateTime, null $lastLoginDate = null

`$lastName` public property #

Last name

public string, null $lastName = null

`$lastPasswordChangeDate` public property #

Last password change date

public DateTime, null $lastPasswordChangeDate = null

`$locked` public property #

Locked

public boolean $locked = false

`$lockoutDate` public property #

Lockout date

public DateTime, null $lockoutDate = null

`$newPassword` public property #

New password

public string, null $newPassword = null

`$password` public property #

Password

public string, null $password = null

`$passwordResetRequired` public property #

Password reset required

public boolean $passwordResetRequired = false

`$pending` public property #

Pending

public boolean $pending = false

`$photoId` public property #

Photo asset id

public integer, null $photoId = null

`$suspended` public property #

Suspended

public boolean $suspended = false

`$unverifiedEmail` public property #

Unverified email

public string, null $unverifiedEmail = null

`$username` public property #

Username

public string, null $username = null

`$verificationCode` public property #

Verification code

public string, null $verificationCode = null

`$verificationCodeIssuedDate` public property #

Verification code issued date

public DateTime, null $verificationCodeIssuedDate = null

Method Details

`__toString()` public method #

public void __toString ( )

`afterSave()` public method #

Performs actions after an element is saved.

public void afterSave ( \craft\elements\bool $isNew )

`$isNew`	boolean	Whether the element is brand new
throws	yii\base\Exception	if reasons

`attributes()` public method #

Returns the list of attribute names.

By default, this method returns all public non-static properties of the class. You may override this method to change the default behavior.

public array attributes ( )

return	array	List of attribute names.

`authData()` public static method #

Returns the authentication data from a given auth key.

public static array, null authData ( \craft\elements\string $authKey )

`$authKey`	string
return	array, null	The authentication data, or `null` if it was invalid.

`authenticate()` public method #

Determines whether the user is allowed to be logged in with a given password.

public boolean authenticate ( \craft\elements\string $password )

$password string The user's plain text passwerd.

`beforeDelete()` public method #

Performs actions before an element is deleted.

public boolean beforeDelete ( )

return	boolean	Whether the element should be deleted

`can()` public method #

Returns whether the user has permission to perform a given action.

public boolean can ( \craft\elements\string $permission )

$permission string

`datetimeAttributes()` public method #

Returns the names of any attributes that should hold DateTime values.

public string[] datetimeAttributes ( )

`defineActions()` protected static method #

Defines the available element actions for a given source (if one is provided).

protected static array defineActions ( \craft\elements\string $source = null )

`$source`	string, null	The selected source’s key, if any.
return	array	The available element actions.

`defineDefaultTableAttributes()` protected static method #

Returns the list of table attribute keys that should be shown by default.

protected static string[] defineDefaultTableAttributes ( \craft\elements\string $source )

`$source`	string	The selected source’s key
return	string[]	The table attributes.

`defineSearchableAttributes()` protected static method #

Defines which element attributes should be searchable.

protected static string[] defineSearchableAttributes ( )

return	string[]	The element attributes that should be searchable

`defineSortOptions()` protected static method #

Returns the sort options for the element type.

protected static array defineSortOptions ( )

return	array	The attributes that elements can be sorted by

`defineSources()` protected static method #

Defines the sources that elements of this type may belong to.

protected static array defineSources ( \craft\elements\string $context = null )

`$context`	string, null	The context ('index' or 'modal').
return	array	The sources.

`defineTableAttributes()` protected static method #

Defines all of the available columns that can be shown in table views.

protected static array defineTableAttributes ( )

return	array	The table attributes.

`displayName()` public static method #

Returns the display name of this class.

public static string displayName ( )

return	string	The display name of this class.

`eagerLoadingMap()` public static method #

Returns an array that maps source-to-target element IDs based on the given sub-property handle.

This method aids in the eager-loading of elements when performing an element query. The returned array should contain the following keys:

elementType – the fully qualified class name of the element type that should be eager-loaded
map – an array of element ID mappings, where each element is a sub-array with source and target keys.
criteria (optional) – Any criteria parameters that should be applied to the element query when fetching the eager-loaded elements.

public static array, false eagerLoadingMap ( array $sourceElements, \craft\elements\string $handle )

`$sourceElements`	craft\base\ElementInterface[]	An array of the source elements
`$handle`	string	The property handle used to identify which target elements should be included in the map
return	array, false	The eager-loading element ID mappings, or false if no mappings exist

`extraFields()` public method #

Returns the list of fields that can be expanded further and returned by toArray().

This method is similar to fields() except that the list of fields returned by this method are not returned by default by toArray(). Only when field names to be expanded are explicitly specified when calling toArray(), will their values be exported.

The default implementation returns an empty array.

You may override this method to return a list of expandable fields based on some context information (e.g. the current application user).

public array extraFields ( )

return	array	The list of expandable field names or field definitions. Please refer to fields() on the format of the return value.

`find()` public static method #

Creates an craft\elements\db\ElementQueryInterface instance for query purpose.

The returned craft\elements\db\ElementQueryInterface instance can be further customized by calling methods defined in craft\elements\db\ElementQueryInterface before one() or all() is called to return populated \craft\elements\ElementInterface instances. For example,

// Find the entry whose ID is 5
$entry = Entry::find()->id(5)->one();
// Find all assets and order them by their filename:
$assets = Asset::find()
    ->orderBy('filename')
    ->all();

If you want to define custom criteria parameters for your elements, you can do so by overriding this method and returning a custom query class. For example,

class Product extends Element
{
    public static function find()
    {
        // use ProductQuery instead of the default ElementQuery
        return new ProductQuery(get_called_class());
    }
}

You can also set default criteria parameters on the ElementQuery if you don’t have a need for a custom query class. For example,

class Customer extends ActiveRecord
{
    public static function find()
    {
        return parent::find()->limit(50);
    }
}

public static craft\elements\db\UserQuery find ( )

return	craft\elements\db\UserQuery	The newly created craft\elements\db\UserQuery instance.

`findIdentity()` public static method #

Finds an identity by the given ID.

public static yii\web\IdentityInterface findIdentity ( $id )

`$id`	string, integer	The ID to be looked for
return	yii\web\IdentityInterface	The identity object that matches the given ID. Null should be returned if such an identity cannot be found or the identity is not in an active state (disabled, deleted, etc.)

`findIdentityByAccessToken()` public static method #

Finds an identity by the given token.

public static yii\web\IdentityInterface findIdentityByAccessToken ( $token, $type = null )

`$token`	mixed	The token to be looked for
`$type`	mixed	The type of the token. The value of this parameter depends on the implementation. For example, yii\filters\auth\HttpBearerAuth will set this parameter to be `yii\filters\auth\HttpBearerAuth`.
return	yii\web\IdentityInterface	The identity object that matches the given token. Null should be returned if such an identity cannot be found or the identity is not in an active state (disabled, deleted, etc.)

`getAuthKey()` public method #

Returns a key that can be used to check the validity of a given identity ID.

The key should be unique for each individual user, and should be persistent so that it can be used to check the validity of the user identity.

The space of such keys should be big enough to defeat potential identity attacks.

This is required if craft\elements\User::enableAutoLogin is enabled.

public string getAuthKey ( )

return	string	A key that is used to check the validity of a given identity ID.

`getCooldownEndTime()` public method #

Returns the time when the user will be over their cooldown period.

public DateTime, null getCooldownEndTime ( )

`getCpEditUrl()` public method #

Returns the element’s CP edit URL.

public string, null getCpEditUrl ( )

`getEditorHtml()` public method #

Returns the HTML for the element’s editor HUD.

public string getEditorHtml ( )

return	string	The HTML for the editor HUD

`getFieldLayout()` public method #

Returns the field layout used by this element.

public craft\models\FieldLayout, null getFieldLayout ( )

`getFriendlyName()` public method #

Gets the user's first name or username.

public string, null getFriendlyName ( )

`getFullName()` public method #

Returns the user's full name.

public string, null getFullName ( )

`getGroups()` public method #

Returns the user's groups.

public craft\models\UserGroup[] getGroups ( )

`getIsCurrent()` public method #

Returns whether this is the current logged-in user.

public boolean getIsCurrent ( )

`getIsEditable()` public method #

Returns whether the current user can edit the element.

public boolean getIsEditable ( )

`getName()` public method #

Returns the user's full name or username.

public string getName ( )

`getPhoto()` public method #

Returns the user's photo.

public craft\elements\Asset, null getPhoto ( )

throws	yii\base\InvalidConfigException	if $photoId is set but invalid

`getPhotoUrl()` public method #

Deprecated in 3.0. Use getPhoto().getUrl() instead.

Returns the URL to the user's photo.

public string, null getPhotoUrl ( \craft\elements\int $size = 100 )

$size integer The width and height the photo should be sized to

`getPreference()` public method #

Returns one of the user’s preferences by its key.

public mixed getPreference ( \craft\elements\string $key, $default = null )

`$key`	string	The preference’s key
`$default`	mixed	The default value, if the preference hasn’t been set
return	mixed	The user’s preference

`getPreferences()` public method #

Returns the user’s preferences.

public array getPreferences ( )

return	array	The user’s preferences.

`getPreferredLanguage()` public method #

Returns the user’s preferred language, if they have one.

public string, null getPreferredLanguage ( )

return	string, null	The preferred language

`getRef()` public method #

Returns the reference string to this element.

public string, null getRef ( )

`getRemainingCooldownTime()` public method #

Returns the remaining cooldown time for this user, if they've entered their password incorrectly too many times.

public DateInterval, null getRemainingCooldownTime ( )

`getStatus()` public method #

Returns the element’s status.

public string, null getStatus ( )

`getThumbUrl()` public method #

Returns the URL to the element’s thumbnail, if there is one.

public string, null getThumbUrl ( \craft\elements\int $size )

$size integer

`hasContent()` public static method #

Returns whether elements of this type will be storing any data in the content table (tiles or custom fields).

public static boolean hasContent ( )

return	boolean	Whether elements of this type will be storing any data in the `content` table.

`hasShunned()` public method #

Returns whether the user has shunned a given message.

public boolean hasShunned ( \craft\elements\string $message )

$message string

`hasStatuses()` public static method #

Returns whether elements of this type have statuses.

If this returns true, the element index template will show a Status menu by default, and your elements will get status indicator icons next to them. Use statuses() to customize which statuses the elements might have.

public static boolean hasStatuses ( )

return	boolean	Whether elements of this type have statuses.

`init()` public method #

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

public void init ( )

`isInGroup()` public method #

Returns whether the user is in a specific group.

public boolean isInGroup ( $group )

$group craft\models\UserGroup, integer, string The user group model, its handle, or ID.

`mergePreferences()` public method #

Merges new user preferences with the existing ones, and returns the result.

public array mergePreferences ( array $preferences )

`$preferences`	array	The new preferences
return	array	The user’s new preferences.

`refHandle()` public static method #

Returns the handle that should be used to refer to this element type from reference tags.

public static string, null refHandle ( )

return	string, null	The reference handle, or null if the elemnet type doesn’t support reference tags

`rules()` public method #

Returns the validation rules for attributes.

Validation rules are used by validate() to check if attribute values are valid. Child classes may override this method to declare different validation rules.

Each rule is an array with the following structure:

[
    ['attribute1', 'attribute2'],
    'validator type',
    'on' => ['scenario1', 'scenario2'],
    //...other parameters...
]

where

attribute list: required, specifies the attributes array to be validated, for single attribute you can pass a string;
validator type: required, specifies the validator to be used. It can be a built-in validator name, a method name of the model class, an anonymous function, or a validator class name.
on: optional, specifies the \craft\elements\scenario array in which the validation rule can be applied. If this option is not set, the rule will apply to all scenarios.
additional name-value pairs can be specified to initialize the corresponding validator properties. Please refer to individual validator class API for possible properties.

A validator can be either an object of a class extending \craft\elements\Validator, or a model class method (called inline validator) that has the following signature:

// $params refers to validation parameters given in the rule
function validatorName($attribute, $params)

In the above $attribute refers to the attribute currently being validated while $params contains an array of validator configuration options such as max in case of string validator. The value of the attribute currently being validated can be accessed as $this->$attribute. Note the $ before attribute; this is taking the value of the variable $attribute and using it as the name of the property to access.

Yii also provides a set of \craft\elements\Validator::builtInValidators. Each one has an alias name which can be used when specifying a validation rule.

Below are some examples:

[
    // built-in "required" validator
    [['username', 'password'], 'required'],
    // built-in "string" validator customized with "min" and "max" properties
    ['username', 'string', 'min' => 3, 'max' => 12],
    // built-in "compare" validator that is used in "register" scenario only
    ['password', 'compare', 'compareAttribute' => 'password2', 'on' => 'register'],
    // an inline validator defined via the "authenticate()" method in the model class
    ['password', 'authenticate', 'on' => 'login'],
    // a validator of class "DateRangeValidator"
    ['dateRange', 'DateRangeValidator'],
];

Note, in order to inherit rules defined in the parent class, a child class needs to merge the parent rules with child rules using functions such as array_merge().

public array rules ( )

return	array	Validation rules

`scenarios()` public method #

Returns a list of scenarios and the corresponding active attributes.

An active attribute is one that is subject to validation in the current scenario. The returned array should be in the following format:

[
    'scenario1' => ['attribute11', 'attribute12', ...],
    'scenario2' => ['attribute21', 'attribute22', ...],
    ...
]

By default, an active attribute is considered safe and can be massively assigned. If an attribute should NOT be massively assigned (thus considered unsafe), please prefix the attribute with an exclamation character (e.g. '!rank').

The default implementation of this method will return all scenarios found in the rules() declaration. A special scenario named SCENARIO_DEFAULT will contain all attributes found in the rules(). Each scenario will be associated with the attributes that are being validated by the validation rules that apply to the scenario.

public array scenarios ( )

return	array	A list of scenarios and the corresponding active attributes.

`setEagerLoadedElements()` public method #

Sets some eager-loaded elements on a given handle.

public void setEagerLoadedElements ( \craft\elements\string $handle, array $elements )

`$handle`	string	The handle to load the elements with in the future
`$elements`	craft\base\ElementInterface[]	The eager-loaded elements

`setGroups()` public method #

Sets an array of User element objects on the user.

public void setGroups ( array $groups )

$groups craft\models\UserGroup[] An array of UserGroup objects.

`setPhoto()` public method #

Sets the entry's author.

public void setPhoto ( craft\elements\Asset $photo = null )

$photo craft\elements\Asset, null

`statuses()` public static method #

Returns all of the possible statuses that elements of this type may have.

This method will be called when populating the Status menu on element indexes, for element types whose hasStatuses() method returns true. It will also be called when craft\elements\db\ElementQuery is querying for elements, to ensure that its “status” parameter is set to a valid status. It should return an array whose keys are the status values, and values are the human-facing status labels, or an array with the following keys:

label – The human-facing status label.
color – The status color (green, orange, red, yellow, pink, purple, blue, turquoise, light, grey, black, or white) You can customize the database query condition that should be applied for your custom statuses from craft\elements\db\ElementQuery::statusCondition().

public static array statuses ( )

`tableAttributeHtml()` protected method #

Returns the HTML that should be shown for a given attribute in Table View.

protected string tableAttributeHtml ( \craft\elements\string $attribute )

`$attribute`	string	The attribute name.
return	string	The HTML that should be shown for a given attribute in Table View.

`validateAuthKey()` public method #

Validates the given auth key.

This is required if craft\elements\User::enableAutoLogin is enabled.

public boolean validateAuthKey ( $authKey )

`$authKey`	string	The given auth key
return	boolean	Whether the given auth key is valid.

`validateUnverifiedEmail()` public method #

Validates the unverifiedEmail value is unique.

public void validateUnverifiedEmail ( \craft\elements\string $attribute, $params, yii\validators\InlineValidator $validator )

`$attribute`	string
`$params`	array, null
`$validator`	yii\validators\InlineValidator

Event Details

`EVENT_BEFORE_AUTHENTICATE` event of type craft\events\AuthenticateUserEvent #

The event that is triggered before a user is authenticated. You may set craft\events\AuthenticateUserEvent::isValid to false to prevent the user from getting authenticated

Property Details

$admin public property #

$authError public property #

$client public property #

$currentPassword public property #

$email public property #

$firstName public property #

$inheritorOnDelete public property #

$invalidLoginCount public property #

$lastInvalidLoginDate public property #

$lastLoginAttemptIp public property #

$lastLoginDate public property #

$lastName public property #

$lastPasswordChangeDate public property #

$locked public property #

$lockoutDate public property #

$newPassword public property #

$password public property #

$passwordResetRequired public property #

$pending public property #

$photoId public property #

$suspended public property #

$unverifiedEmail public property #

$username public property #

$verificationCode public property #

$verificationCodeIssuedDate public property #

Method Details

__toString() public method #

afterSave() public method #

attributes() public method #

authData() public static method #

authenticate() public method #

beforeDelete() public method #

can() public method #

datetimeAttributes() public method #

defineActions() protected static method #

defineDefaultTableAttributes() protected static method #

defineSearchableAttributes() protected static method #

defineSortOptions() protected static method #

defineSources() protected static method #

defineTableAttributes() protected static method #

displayName() public static method #

eagerLoadingMap() public static method #

extraFields() public method #

find() public static method #

findIdentity() public static method #

findIdentityByAccessToken() public static method #

getAuthKey() public method #

getCooldownEndTime() public method #

getCpEditUrl() public method #

getEditorHtml() public method #

getFieldLayout() public method #

getFriendlyName() public method #

getFullName() public method #

getGroups() public method #

getIsCurrent() public method #

getIsEditable() public method #

getName() public method #

getPhoto() public method #

getPhotoUrl() public method #

getPreference() public method #

getPreferences() public method #

getPreferredLanguage() public method #

getRef() public method #

getRemainingCooldownTime() public method #

getStatus() public method #

getThumbUrl() public method #

hasContent() public static method #

hasShunned() public method #

hasStatuses() public static method #

init() public method #

isInGroup() public method #

mergePreferences() public method #

refHandle() public static method #

rules() public method #

scenarios() public method #

setEagerLoadedElements() public method #

setGroups() public method #

setPhoto() public method #

statuses() public static method #