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, 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, 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

Property Description
activeValidators (opens new window) yii\validators\Validator (opens new window) – The validators applicable to the current scenario (opens new window).
admin boolean (opens new window) – Admin
ancestors craft\elements\db\ElementQueryInterface, craft\base\ElementInterface[]
archived boolean (opens new window) – Whether the element is archived
attributes (opens new window) array (opens new window) – Attribute values (name => value).
authError string (opens new window), null (opens new window) – Auth error
authKey string (opens new window) – A key that is used to check the validity of a given identity ID.
awaitingFieldValues boolean (opens new window) – Whether the element is still awaiting its custom field values
behaviors (opens new window) yii\base\Behavior (opens new window) – List of behaviors attached to this component
cacheTags string (opens new window)[]
children craft\elements\db\ElementQueryInterface, craft\base\ElementInterface[]
contentId integer (opens new window), null (opens new window) – The element’s content row ID
contentTable string (opens new window)
cooldownEndTime DateTime (opens new window), null (opens new window)
cpEditUrl string (opens new window), null (opens new window)
currentPassword string (opens new window), null (opens new window) – Current password
currentRevision craft\base\ElementInterface, null (opens new window)
dateCreated DateTime (opens new window), null (opens new window) – The date that the element was created
dateDeleted DateTime (opens new window), null (opens new window) – The date that the element was trashed
dateUpdated DateTime (opens new window), null (opens new window) – The date that the element was last updated
descendants craft\elements\db\ElementQueryInterface, craft\base\ElementInterface[]
dirtyAttributes string (opens new window)[]
dirtyFields string (opens new window)[]
draftId integer (opens new window), null (opens new window) – The ID of the draft’s row in the drafts table
duplicateOf craft\base\ElementInterface, null (opens new window) – The element that this element is being duplicated by.
editorHtml string (opens new window) – The HTML for the editor HUD
email string (opens new window), null (opens new window) – Email
enabled boolean (opens new window) – Whether the element is enabled
enabledForSite boolean (opens new window), null (opens new window) – Whether the element is enabled for the given site.
errors (opens new window) array (opens new window) – Errors for all attributes or the specified attribute.
fieldColumnPrefix string (opens new window)
fieldContext string (opens new window)
fieldLayout craft\models\FieldLayout, null (opens new window)
fieldLayoutId integer (opens new window), null (opens new window) – The element’s field layout ID
fieldParamNamespace string (opens new window), null (opens new window) – The field param namespace
fieldValues array (opens new window) – The field values (handle => value)
firstErrors (opens new window) array (opens new window) – The first errors.
firstName string (opens new window), null (opens new window) – First name
friendlyName string (opens new window), null (opens new window)
fullName string (opens new window), null (opens new window)
gqlTypeName string (opens new window)
groups craft\models\UserGroup[]
hardDelete boolean (opens new window) – Whether the element is being hard-deleted.
hasCheckeredThumb boolean (opens new window)
hasDashboard boolean (opens new window) – Whether the user has a dashboard
hasDescendants boolean (opens new window)
hasFreshContent boolean (opens new window) – Whether the element’s content is fresh
hasRoundedThumb boolean (opens new window)
id integer (opens new window), null (opens new window) – The element’s ID
inheritorOnDelete self, null (opens new window) – The user who should take over the user’s content if the user is deleted.
invalidLoginCount integer (opens new window), null (opens new window) – Invalid login count
isCurrent boolean (opens new window)
isDeletable boolean (opens new window)
isDraft boolean (opens new window)
isEditable boolean (opens new window)
isHomepage boolean (opens new window)
isRevision boolean (opens new window)
isTitleTranslatable boolean (opens new window)
isUnsavedDraft boolean (opens new window)
iterator (opens new window) ArrayIterator (opens new window) – An iterator for traversing the items in the list.
language string (opens new window)
lastInvalidLoginDate DateTime (opens new window), null (opens new window) – Last invalid login date
lastLoginAttemptIp string (opens new window), null (opens new window) – Last login attempt IP address.
lastLoginDate DateTime (opens new window), null (opens new window) – Last login date
lastName string (opens new window), null (opens new window) – Last name
lastPasswordChangeDate DateTime (opens new window), null (opens new window) – Last password change date
level integer (opens new window), null (opens new window) – The element’s level within its structure
lft integer (opens new window), null (opens new window) – The element’s left position within its structure
link \Twig\Markup, null (opens new window)
localized craft\elements\db\ElementQueryInterface[], craft\base\ElementInterface[]
locked boolean (opens new window) – Locked
lockoutDate DateTime (opens new window), null (opens new window) – Lockout date
name string (opens new window)
newPassword string (opens new window), null (opens new window) – New password
newSiteIds integer (opens new window)[] – The site IDs that the element was just propagated to for the first time.
next craft\base\ElementInterface, null (opens new window)
nextSibling craft\base\ElementInterface, null (opens new window)
parent craft\base\ElementInterface, null (opens new window)
password string (opens new window), null (opens new window) – Password
passwordResetRequired boolean (opens new window) – Password reset required
pending boolean (opens new window) – Pending
photo craft\elements\Asset, null (opens new window)
photoId integer (opens new window), null (opens new window) – Photo asset id
photoUrl string (opens new window), null (opens new window)
preferences array (opens new window) – The user’s preferences.
preferredLanguage string (opens new window), null (opens new window) – The preferred language
preferredLocale string (opens new window), null (opens new window) – The preferred locale
prev craft\base\ElementInterface, null (opens new window)
prevSibling craft\base\ElementInterface, null (opens new window)
previewTargets array (opens new window)
previewing boolean (opens new window) – Whether the element is currently being previewed.
propagateAll boolean (opens new window) – Whether all element attributes should be propagated across all its supported sites, even if that means overwriting existing site-specific values.
propagating boolean (opens new window) – Whether the element is being saved in the context of propagating another site's version of the element.
ref string (opens new window), null (opens new window)
remainingCooldownTime DateInterval (opens new window), null (opens new window)
resaving boolean (opens new window) – Whether the element is being resaved by a ResaveElement job or a resave console command.
revisionId integer (opens new window) – The ID of the revision’s row in the revisions table
rgt integer (opens new window), null (opens new window) – The element’s right position within its structure
root integer (opens new window), null (opens new window) – The element’s structure’s root ID
route mixed – The route that the request should use, or null if no special action should be taken
scenario (opens new window) string (opens new window) – The scenario that this model is in.
searchScore integer (opens new window), null (opens new window) – The element’s search score, if the craft\elements\db\ElementQuery::search() parameter was used when querying for the element
serializedFieldValues array (opens new window)
siblings craft\elements\db\ElementQueryInterface, craft\base\ElementInterface[]
site craft\models\Site
siteId integer (opens new window), null (opens new window) – The site ID the element is associated with
siteSettingsId integer (opens new window), null (opens new window) – The ID of the element’s record in the elements_sites table
slug string (opens new window), null (opens new window) – The element’s slug
sourceId integer (opens new window), null (opens new window)
sourceUid string (opens new window)
status string (opens new window), null (opens new window)
structureId integer (opens new window), null (opens new window) – The element’s structure ID
supportedSites integer (opens new window)[], array (opens new window)
suspended boolean (opens new window) – Suspended
tempId string (opens new window), null (opens new window) – The element’s temporary ID (only used if the element's URI format contains {id})
title string (opens new window), null (opens new window) – The element’s title
titleTranslationDescription string (opens new window), null (opens new window)
titleTranslationKey string (opens new window) – The translation key
totalDescendants integer (opens new window)
trashed boolean (opens new window) – Whether the element has been soft-deleted.
uiLabel string (opens new window)
uid string (opens new window), null (opens new window) – The element’s UID
unverifiedEmail string (opens new window), null (opens new window) – Unverified email
uri string (opens new window), null (opens new window) – The element’s URI
uriFormat string (opens new window), null (opens new window)
url string (opens new window), null (opens new window)
username string (opens new window), null (opens new window) – Username
validators (opens new window) ArrayObject (opens new window), yii\validators\Validator (opens new window) – All the validators declared in the model.
verificationCode string (opens new window), null (opens new window) – Verification code
verificationCodeIssuedDate DateTime (opens new window), null (opens new window) – Verification code issued date

# 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)
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
Access
Read-only

View source (opens new window)

# cpEditUrl

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

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)

# editorHtml

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

The HTML for the editor HUD

View source (opens new window)

# email

Type
string (opens new window), null (opens new window)
Default value
null

Email

View source (opens new window)

# fieldLayout

Type
craft\models\FieldLayout, null (opens new window)
Default value
null
Access
Read-only

View source (opens new window)

# firstName

Type
string (opens new window), null (opens new window)
Default value
null

First name

View source (opens new window)

# friendlyName

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

View source (opens new window)

# fullName

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

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

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)

# isCurrent

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

View source (opens new window)

# isEditable

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

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)

# lastName

Type
string (opens new window), null (opens new window)
Default value
null

Last name

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
Access
Read-only

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
Access
Read-only

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)

# photoUrl

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

View source (opens new window)

# preferences

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

The user’s preferences.

View source (opens new window)

# preferredLanguage

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

The preferred language

View source (opens new window)

# preferredLocale

Type
string (opens new window), null (opens new window)
Default value
null
Access
Read-only
Since
3.5.0

The preferred locale

View source (opens new window)

# ref

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

View source (opens new window)

# remainingCooldownTime

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

View source (opens new window)

# status

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

View source (opens new window)

# suspended

Type
boolean (opens new window)
Default value
false

Suspended

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 string (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() (opens new window) Constructor.
__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 an object property to 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.
addErrors() (opens new window) Adds a list of errors.
addModelErrors() Adds errors from another model, with a given attribute name prefix.
afterDelete() Performs actions after an element is deleted.
afterMoveInStructure() Performs actions after an element is moved within a structure.
afterPropagate() Performs actions after an element is fully saved and propagated to other sites.
afterRestore() Performs actions after an element is restored.
afterSave() Performs actions after an element is saved.
afterValidate() (opens new window) This method is invoked after validation ends.
attachBehavior() (opens new window) Attaches a behavior to this component.
attachBehaviors() (opens new window) Attaches a list of behaviors to the component.
attributeHints() (opens new window) Returns the attribute hints.
attributeLabels() Returns the attribute labels.
attributes() Returns the list of attribute names.
authenticate() Determines whether the user is allowed to be logged in with a given password.
beforeDelete() Performs actions before an element is deleted.
beforeMoveInStructure() Performs actions before an element is moved within a structure.
beforeRestore() Performs actions before an element is restored.
beforeSave() Performs actions before an element is saved.
beforeValidate() (opens new window) This method is invoked before validation starts.
behaviors() Returns a list of behaviors that this component should behave as.
can() Returns whether the user has permission to perform a given action.
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.
className() (opens new window) Returns the fully qualified name of this class.
clearErrors() (opens new window) Removes errors for all attributes or a single attribute.
createValidators() (opens new window) Creates validator objects based on the validation rules specified in rules() (opens new window).
datetimeAttributes() Returns the names of any attributes that should hold DateTime (opens new window) values.
defaultTableAttributes() Returns the list of table attribute keys that should be shown by default.
detachBehavior() (opens new window) Detaches a behavior from the component.
detachBehaviors() (opens new window) Detaches all behaviors from the component.
displayName() Returns the display name of this class.
eagerLoadingMap() Returns an array that maps source-to-target element IDs based on the given sub-property handle.
ensureBehaviors() (opens new window) Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component.
exporters() Returns the available export options for a given source.
extraFields() Returns the list of fields that can be expanded further and returned by toArray() (opens new window).
fieldLayouts() Returns all of the field layouts associated with elements from the given source.
fields() (opens new window) Returns the list of fields that should be returned by default by toArray() (opens new window) when no specific fields are specified.
find() Creates an craft\elements\db\ElementQueryInterface instance for query purpose.
findAll() Returns a list of elements that match the specified ID(s) or a set of element criteria parameters.
findIdentity() Finds an identity by the given ID.
findIdentityByAccessToken() Finds an identity by the given token.
findOne() Returns a single element instance by a primary key or a set of element criteria parameters.
formName() (opens new window) Returns the form name that this model class should use.
generateAttributeLabel() (opens new window) Generates a user friendly attribute label based on the give attribute name.
getActiveValidators() (opens new window) Returns the validators applicable to the current scenario (opens new window).
getAncestors() Returns the element’s ancestors.
getAttributeHint() (opens new window) Returns the text hint for the specified attribute.
getAttributeLabel() Returns the text label for the specified attribute.
getAttributeStatus() Returns the status of a given attribute.
getAttributes() (opens new window) Returns attribute values.
getAuthKey() Returns a key that can be used to check the validity of a given identity ID.
getBehavior() (opens new window) Returns the named behavior object.
getBehaviors() (opens new window) Returns all behaviors attached to this component.
getCacheTags() Returns the cache tags that should be cleared when this element is saved.
getChildren() Returns the element’s children.
getContentTable() Returns the name of the table this element’s content is stored in.
getCooldownEndTime() Returns the time when the user will be over their cooldown period.
getCpEditUrl() Returns the element’s edit URL in the control panel.
getCurrentRevision() Returns the element’s current revision, if one exists.
getDescendants() Returns the element’s descendants.
getDirtyAttributes() Returns a list of attribute names that have changed since the element was first loaded.
getDirtyFields() Returns a list of custom field handles that have changed since the element was first loaded.
getEagerLoadedElementCount() Returns the count of eager-loaded elements for a given handle.
getEagerLoadedElements() Returns the eager-loaded elements for a given handle.
getEditorHtml() Returns the HTML for the element’s editor HUD.
getEnabledForSite() Returns whether the element is enabled for the current site.
getError() Returns the first error of the specified attribute.
getErrorSummary() (opens new window) Returns the errors for all attributes as a one-dimensional array.
getErrors() (opens new window) Returns the errors for all attributes or a single attribute.
getFieldColumnPrefix() Returns the field column prefix this element’s content uses.
getFieldContext() Returns the field context this element’s content uses.
getFieldLayout() Returns the field layout used by this element.
getFieldParamNamespace() Returns the namespace used by custom field params on the request.
getFieldStatus() Returns the status of a given field.
getFieldValue() Returns the value for a given field.
getFieldValues() Returns the element’s normalized custom field values, indexed by their handles.
getFirstError() (opens new window) Returns the first error of the specified attribute.
getFirstErrors() (opens new window) Returns the first error of every attribute in the model.
getFriendlyName() Gets the user's first name or username.
getFullName() Returns the user's full name.
getGqlTypeName() Returns the GraphQL type name for this element type.
getGroups() Returns the user's groups.
getHasCheckeredThumb() Returns whether the element’s thumbnail should have a checkered background.
getHasDescendants() Returns whether the element has descendants.
getHasFreshContent() Returns whether the element’s content is "fresh" (unsaved and without validation errors).
getHasRoundedThumb() Returns whether the element’s thumbnail should be rounded.
getHtmlAttributes() Returns any attributes that should be included in the element’s DOM representation in the control panel.
getId() Returns the element’s ID.
getIsCurrent() Returns whether this is the current logged-in user.
getIsDeletable() Returns whether the current user can delete the element.
getIsDraft() Returns whether this is a draft.
getIsEditable() Returns whether the current user can edit the element.
getIsHomepage() Returns whether this element represents the site homepage.
getIsRevision() Returns whether this is a revision.
getIsTitleTranslatable() Returns whether the Title field should be shown as translatable in the UI.
getIsUnsavedDraft() Returns whether the element is an unsaved draft.
getIterator() (opens new window) Returns an iterator for traversing the attributes in the model.
getLanguage() Returns the language of the element.
getLink() Returns an anchor pre-filled with this element’s URL and title.
getLocalized() Returns the same element in other locales.
getName() Returns the user's full name or username.
getNext() Returns the next element relative to this one, from a given set of criteria.
getNextSibling() Returns the element’s next sibling.
getParent() Returns the element’s parent.
getPhoto() Returns the user's photo.
getPhotoUrl() Returns the URL to the user's photo.
getPreference() Returns one of the user’s preferences by its key.
getPreferences() Returns the user’s preferences.
getPreferredLanguage() Returns the user’s preferred language, if they have one.
getPreferredLocale() Returns the user’s preferred locale to be used for date/number formatting, if they have one.
getPrev() Returns the previous element relative to this one, from a given set of criteria.
getPrevSibling() Returns the element’s previous sibling.
getPreviewTargets() Returns the additional locations that should be available for previewing the element, besides its primary URL.
getRef() Returns the reference string to this element.
getRemainingCooldownTime() Returns the remaining cooldown time for this user, if they've entered their password incorrectly too many times.
getRoute() Returns the route that should be used when the element’s URI is requested.
getScenario() (opens new window) Returns the scenario that this model is used in.
getSearchKeywords() Returns the search keywords for a given search attribute.
getSerializedFieldValues() Returns an array of the element’s serialized custom field values, indexed by their handles.
getSiblings() Returns all of the element’s siblings.
getSite() Returns the site the element is associated with.
getSourceId() Returns the element’s ID, or if it’s a draft/revision, its source element’s ID.
getSourceUid() Returns the element’s UUID, or if it’s a draft/revision, its source element’s UUID.
getStatus() Returns the element’s status.
getSupportedSites() Returns the sites this element is associated with.
getTableAttributeHtml() Returns the HTML that should be shown for a given attribute in Table View.
getThumbUrl() Returns the URL to the element’s thumbnail, if there is one.
getTitleTranslationDescription() Returns the description of the Title field’s translation support.
getTitleTranslationKey() Returns the Title’s translation key.
getTotalDescendants() Returns the total number of descendants that the element has.
getUiLabel() Returns what the element should be called within the control panel.
getUriFormat() Returns the URI format used to generate this element’s URI.
getUrl() Returns the element’s full URL.
getValidators() (opens new window) Returns all the validators declared in rules() (opens new window).
gqlMutationNameByContext() Returns the GraphQL mutation name by an element's context.
gqlScopesByContext() Returns the GraphQL scopes required by element's context.
gqlTypeNameByContext() Returns the GraphQL type name by an element's context.
hasContent() Returns whether elements of this type will be storing any data in the content table (titles or custom fields).
hasEagerLoadedElements() Returns whether elements have been eager-loaded with a given handle.
hasErrors() Returns a value indicating whether there is any validation error.
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.
hasShunned() Returns whether the user has shunned a given message.
hasStatuses() Returns whether elements of this type have statuses.
hasTitles() Returns whether elements of this type have traditional titles.
hasUris() Returns whether elements of this type can have their own slugs and URIs.
indexHtml() Returns the element index HTML.
init() Initializes the object.
instance() (opens new window) Returns static class instance, which can be used to obtain meta information.
isAncestorOf() Returns whether this element is an ancestor of another one.
isAttributeActive() (opens new window) Returns a value indicating whether the attribute is active in the current scenario.
isAttributeDirty() Returns whether an attribute has changed since the element was first loaded.
isAttributeRequired() (opens new window) Returns a value indicating whether the attribute is required.
isAttributeSafe() (opens new window) Returns a value indicating whether the attribute is safe for massive assignments.
isChildOf() Returns whether this element is a direct child of another one.
isDescendantOf() Returns whether this element is a descendant of another one.
isFieldDirty() Returns whether a custom field value has changed since the element was first loaded.
isFieldEmpty() Returns whether a field is empty.
isInGroup() Returns whether the user is in a specific group.
isLocalized() Returns whether elements of this type store content on a per-site basis.
isNextSiblingOf() Returns whether this element is the direct next sibling of another one.
isParentOf() Returns whether this element is a direct parent of another one.
isPrevSiblingOf() Returns whether this element is the direct previous sibling of another one.
isSelectable() Returns whether the component should be selectable in component Type selects.
isSiblingOf() Returns whether this element is a sibling of another one.
load() (opens new window) Populates the model with input data.
loadMultiple() (opens new window) Populates a set of models with the data from end user.
lowerDisplayName() Returns the lowercase version of displayName().
markAsClean() Resets the record of dirty attributes and fields.
markAsDirty() Marks all fields and attributes as dirty.
mergePreferences() Merges new user preferences with the existing ones, and returns the result.
off() (opens new window) Detaches an existing event handler from this component.
offsetExists() Returns whether there is an element at the specified offset.
offsetGet() (opens new window) Returns the element at the specified offset.
offsetSet() (opens new window) Sets the element at the specified offset.
offsetUnset() (opens new window) Sets the element value at the specified offset to null.
on() (opens new window) Attaches an event handler to an event.
onUnsafeAttribute() (opens new window) This method is invoked when an unsafe attribute is being massively assigned.
pluralDisplayName() Returns the plural version of displayName().
pluralLowerDisplayName() Returns the plural, lowercase version of displayName().
refHandle() Returns the handle that should be used to refer to this element type from reference tags.
rules() Returns the validation rules for attributes.
safeAttributes() (opens new window) Returns the attribute names that are safe to be massively assigned in the current scenario.
scenarios() Returns a list of scenarios and the corresponding active attributes.
searchableAttributes() Defines which element attributes should be searchable.
setAttributes() (opens new window) Sets the attribute values in a massive way.
setDirtyAttributes() Sets the list of dirty attribute names.
setEagerLoadedElementCount() Sets the count of eager-loaded elements for a given handle.
setEagerLoadedElements() Sets some eager-loaded elements on a given handle.
setEnabledForSite() Sets whether the element is enabled for the current site.
setFieldParamNamespace() Sets the namespace used by custom field params on the request.
setFieldValue() Sets the value for a given field.
setFieldValues() Sets the element’s custom field values.
setFieldValuesFromRequest() Sets the element’s custom field values, when the values have come from post data.
setGroups() Sets an array of user groups on the user.
setNext() Sets the default next element.
setParent() Sets the element’s parent.
setPhoto() Sets the entry's author.
setPrev() Sets the default previous element.
setRevisionCreatorId() Sets the revision creator ID to be saved.
setRevisionNotes() Sets the revision notes to be saved.
setScenario() (opens new window) Sets the scenario for the model.
sortOptions() Returns the sort options for the element type.
sources() Returns the source definitions that elements of this type may belong to.
statuses() Returns all of the possible statuses that elements of this type may have.
tableAttributes() Defines all of the available columns that can be shown in table views.
toArray() (opens new window) Converts the model into an array.
trackChanges() Returns whether Craft should keep track of attribute and custom field changes made to this element type, including when the last time they were changed, and who was logged-in at the time.
trigger() (opens new window) Triggers an event.
validate() (opens new window) Performs the data validation.
validateAuthKey() Validates the given auth key.
validateCustomFieldAttribute() Calls a custom validation function on a custom field.
validateCustomFieldContentSize() Validates that the content size is going to fit within the field’s database column.
validateMultiple() (opens new window) Validates multiple models.
validateUnverifiedEmail() Validates the unverifiedEmail value is unique.

# __toString()

Use the full name or username as the string representation.

View source (opens new window)

Returns

string (opens new window)

# afterSave()

Performs actions after an element is saved.

View source (opens new window)

Arguments

Throws

# attributeLabels()

Returns the attribute labels.

Attribute labels are mainly used for display purpose. For example, given an attribute firstName, we can declare a label First Name which is more user-friendly and can be displayed to end users.

By default an attribute label is generated using generateAttributeLabel() (opens new window). This method allows you to explicitly specify attribute labels.

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

View source (opens new window)

Returns

array (opens new window) – Attribute labels (name => label)

# attributes()

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.

View source (opens new window)

Returns

array (opens new window) – List of attribute names.

# authenticate()

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

View source (opens new window)

Arguments

Returns

boolean (opens new window)

# beforeDelete()

Performs actions before an element is deleted.

View source (opens new window)

Returns

boolean (opens new window) – Whether the element should be deleted

# can()

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

View source (opens new window)

Arguments

Returns

boolean (opens new window)

# datetimeAttributes()

Returns the names of any attributes that should hold DateTime (opens new window) values.

View source (opens new window)

Returns

string (opens new window)[]

# displayName()

Returns the display name of this class.

View source (opens new window)

Returns

string (opens new window) – The display name of this class.

# eagerLoadingMap()

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.
use craft\db\Query;
use craft\helpers\ArrayHelper;

public static function eagerLoadingMap(array $sourceElements, string $handle) {
    switch ($handle) {
        case 'author':
            $bookIds = ArrayHelper::getColumn($sourceElements, 'id');
            $map = (new Query)
                ->select(['source' => 'id', 'target' => 'authorId'])
                ->from('{{%books}}')
                ->where(['id' => $bookIds)
                ->all();
            return [
                'elementType' => \my\plugin\Author::class,
                'map' => $map,
            ];
        case 'bookClubs':
            $bookIds = ArrayHelper::getColumn($sourceElements, 'id');
            $map = (new Query)
                ->select(['source' => 'bookId', 'target' => 'clubId'])
                ->from('{{%bookclub_books}}')
                ->where(['bookId' => $bookIds)
                ->all();
            return [
                'elementType' => \my\plugin\BookClub::class,
                'map' => $map,
            ];
        default:
            return parent::eagerLoadMap($sourceElements, $handle);
    }
}

View source (opens new window)

Arguments

Returns

array (opens new window), false (opens new window), null (opens new window) – The eager-loading element ID mappings, false if no mappings exist, or null if the result should be ignored

# extraFields()

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

This method is similar to fields() (opens new window) except that the list of fields returned by this method are not returned by default by toArray() (opens new window). Only when field names to be expanded are explicitly specified when calling toArray() (opens new window), 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).

View source (opens new window)

Returns

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

# find()

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);
    }
}

View source (opens new window)

Returns

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

# findIdentity()

Finds an identity by the given ID.

View source (opens new window)

Arguments

Returns

yii\web\IdentityInterface (opens new window), null (opens new window) – 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()

Finds an identity by the given token.

View source (opens new window)

Arguments

  • $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 (opens new window) will set this parameter to be yii\filters\auth\HttpBearerAuth.

Returns

yii\web\IdentityInterface (opens new window), null (opens new window) – 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()

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 yii\web\User::$enableAutoLogin (opens new window) is enabled. The returned key will be stored on the client side as a cookie and will be used to authenticate user even if PHP session has been expired.

Make sure to invalidate earlier issued authKeys when you implement force user logout, password change and other scenarios, that require forceful access revocation for old sessions.

View source (opens new window)

Returns

string (opens new window) – A key that is used to check the validity of a given identity ID.

# getCooldownEndTime()

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

View source (opens new window)

Returns

DateTime (opens new window), null (opens new window)

# getCpEditUrl()

Returns the element’s edit URL in the control panel.

View source (opens new window)

Returns

string (opens new window), null (opens new window)

# getEditorHtml()

Returns the HTML for the element’s editor HUD.

View source (opens new window)

Returns

string (opens new window) – The HTML for the editor HUD

# getFieldLayout()

Returns the field layout used by this element.

View source (opens new window)

Returns

craft\models\FieldLayout, null (opens new window)

# getFriendlyName()

Gets the user's first name or username.

View source (opens new window)

Returns

string (opens new window), null (opens new window)

# getFullName()

Returns the user's full name.

View source (opens new window)

Returns

string (opens new window), null (opens new window)

# getGqlTypeName()

Since
3.3.0

Returns the GraphQL type name for this element type.

View source (opens new window)

Returns

string (opens new window)

# getGroups()

Returns the user's groups.

View source (opens new window)

Returns

craft\models\UserGroup[]

# getHasRoundedThumb()

Since
3.5.5

Returns whether the element’s thumbnail should be rounded.

View source (opens new window)

Returns

boolean (opens new window)

# getIsCurrent()

Returns whether this is the current logged-in user.

View source (opens new window)

Returns

boolean (opens new window)

# getIsEditable()

Returns whether the current user can edit the element.

View source (opens new window)

Returns

boolean (opens new window)

# getName()

Returns the user's full name or username.

View source (opens new window)

Returns

string (opens new window)

# getPhoto()

Returns the user's photo.

View source (opens new window)

Returns

craft\elements\Asset, null (opens new window)

# getPhotoUrl()

DEPRECATED

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

Returns the URL to the user's photo.

View source (opens new window)

Arguments

Returns

string (opens new window), null (opens new window)

# getPreference()

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

View source (opens new window)

Arguments

  • $key (string (opens new window)) – The preference’s key
  • $default (mixed) – The default value, if the preference hasn’t been set

Returns

mixed – The user’s preference

# getPreferences()

Returns the user’s preferences.

View source (opens new window)

Returns

array (opens new window) – The user’s preferences.

# getPreferredLanguage()

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

View source (opens new window)

Returns

string (opens new window), null (opens new window) – The preferred language

# getPreferredLocale()

Since
3.5.0

Returns the user’s preferred locale to be used for date/number formatting, if they have one.

If the user doesn’t have a preferred locale, their preferred language will be used instead.

View source (opens new window)

Returns

string (opens new window), null (opens new window) – The preferred locale

# getRef()

Returns the reference string to this element.

View source (opens new window)

Returns

string (opens new window), null (opens new window)

# getRemainingCooldownTime()

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

View source (opens new window)

Returns

DateInterval (opens new window), null (opens new window)

# getStatus()

Returns the element’s status.

View source (opens new window)

Returns

string (opens new window), null (opens new window)

# getThumbUrl()

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

View source (opens new window)

Arguments

Returns

string (opens new window), null (opens new window)

# gqlTypeNameByContext()

Since
3.3.0

Returns the GraphQL type name by an element's context.

View source (opens new window)

Arguments

  • $context (mixed) – The element's context, such as a Volume, Entry Type or Matrix Block Type.

Returns

string (opens new window)

# hasContent()

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

View source (opens new window)

Returns

boolean (opens new window) – Whether elements of this type will be storing any data in the content table.

# hasShunned()

Returns whether the user has shunned a given message.

View source (opens new window)

Arguments

Returns

boolean (opens new window)

# hasStatuses()

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.

View source (opens new window)

Returns

boolean (opens new window) – Whether elements of this type have statuses.

# init()

Initializes the object.

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

View source (opens new window)

# isInGroup()

Returns whether the user is in a specific group.

View source (opens new window)

Arguments

Returns

boolean (opens new window)

# lowerDisplayName()

Since
3.3.17

Returns the lowercase version of displayName().

View source (opens new window)

Returns

string (opens new window)

# mergePreferences()

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

View source (opens new window)

Arguments

Returns

array (opens new window) – The user’s new preferences.

# pluralDisplayName()

Since
3.2.0

Returns the plural version of displayName().

View source (opens new window)

Returns

string (opens new window)

# pluralLowerDisplayName()

Since
3.3.17

Returns the plural, lowercase version of displayName().

View source (opens new window)

Returns

string (opens new window)

# refHandle()

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

View source (opens new window)

Returns

string (opens new window), null (opens new window) – The reference handle, or null if the element type doesn’t support reference tags

# scenarios()

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 (opens new window) 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.

View source (opens new window)

Returns

array (opens new window) – A list of scenarios and the corresponding active attributes.

# setEagerLoadedElements()

Sets some eager-loaded elements on a given handle.

View source (opens new window)

Arguments

# setGroups()

Sets an array of user groups on the user.

View source (opens new window)

Arguments

# setPhoto()

Sets the entry's author.

View source (opens new window)

Arguments

# statuses()

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().

View source (opens new window)

Returns

array (opens new window)

# validateAuthKey()

Validates the given auth key.

This is required if yii\web\User::$enableAutoLogin (opens new window) is enabled.

View source (opens new window)

Arguments

Returns

boolean (opens new window) – Whether the given auth key is valid.

# validateUnverifiedEmail()

Validates the unverifiedEmail value is unique.

View source (opens new window)

Arguments

# Protected Methods

Method Description
defineActions() Defines the available element actions for a given source.
defineDefaultTableAttributes() Returns the list of table attribute keys that should be shown by default.
defineExporters() Defines the available element exporters for a given source.
defineFieldLayouts() Defines the field layouts associated with elements for a given source.
defineRules() Returns the validation rules for attributes.
defineSearchableAttributes() Defines which element attributes should be searchable.
defineSortOptions() Returns the sort options for the element type.
defineSources() Defines the sources that elements of this type may belong to.
defineTableAttributes() Defines all of the available columns that can be shown in table views.
extractFieldsFor() (opens new window) 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".
extractRootFields() (opens new window) Extracts the root field names from nested fields.
fieldByHandle() Returns the field with a given handle.
fieldLayoutFields() Returns each of this element’s fields.
findByCondition() Finds Element instance(s) by the given condition.
htmlAttributes() Returns any attributes that should be included in the element’s DOM representation in the control panel.
normalizeFieldValue() Normalizes a field’s value.
prepElementQueryForTableAttribute() Preps the element criteria for a given table attribute
previewTargets() Returns the additional locations that should be available for previewing the element, besides its primary URL.
resolveFields() (opens new window) Determines which fields can be returned by toArray() (opens new window).
route() Returns the route that should be used when the element’s URI is requested.
searchKeywords() Returns the search keywords for a given search attribute.
tableAttributeHtml() Returns the HTML that should be shown for a given attribute in Table View.

# defineActions()

Defines the available element actions for a given source.

View source (opens new window)

Arguments

Returns

array (opens new window) – The available element actions.

# defineDefaultTableAttributes()

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

View source (opens new window)

Arguments

Returns

string (opens new window)[] – The table attributes.

# defineRules()

Since
3.4.0

Returns the validation rules for attributes.

See rules() for details about what should be returned.

Models should override this method instead of rules() so EVENT_DEFINE_RULES handlers can modify the class-defined rules.

View source (opens new window)

Returns

array (opens new window)

# defineSearchableAttributes()

Defines which element attributes should be searchable.

View source (opens new window)

Returns

string (opens new window)[] – The element attributes that should be searchable

# defineSortOptions()

Returns the sort options for the element type.

View source (opens new window)

Returns

array (opens new window) – The attributes that elements can be sorted by

# defineSources()

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

View source (opens new window)

Arguments

Returns

array (opens new window) – The sources.

# defineTableAttributes()

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

View source (opens new window)

Returns

array (opens new window) – The table attributes.

# tableAttributeHtml()

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

This method can be used to completely customize what actually shows up within the table’s body for a given attribute, rather than simply showing the attribute’s raw value.

For example, if your elements have an email attribute that you want to wrap in a mailto: link, your getTableAttributesHtml() method could do this:

switch ($attribute) {
    case 'email':
        return $this->email ? Html::mailto(Html::encode($this->email)) : '';
    // ...
}
return parent::tableAttributeHtml($attribute);

WARNING

All untrusted text should be passed through craft\helpers\Html::encode() (opens new window) to prevent XSS attacks.

By default the following will be returned:

  • If the attribute name is link or uri, it will be linked to the front-end URL.
  • If the attribute is a custom field handle, it will pass the responsibility off to the field type.
  • If the attribute value is a \craft\elements\DateTime object, the date will be formatted with a localized date format.
  • For anything else, it will output the attribute value as a string.

View source (opens new window)

Arguments

Returns

string (opens new window) – The HTML that should be shown for a given attribute in Table View.

Throws

# Constants

Constant Description
ATTR_STATUS_CONFLICTED
ATTR_STATUS_MODIFIED
ATTR_STATUS_OUTDATED
AUTH_ACCOUNT_COOLDOWN
AUTH_ACCOUNT_LOCKED
AUTH_ACCOUNT_SUSPENDED
AUTH_INVALID_CREDENTIALS
AUTH_NO_CP_ACCESS
AUTH_NO_CP_OFFLINE_ACCESS
AUTH_NO_SITE_OFFLINE_ACCESS
AUTH_PASSWORD_RESET_REQUIRED
AUTH_PENDING_VERIFICATION
HOMEPAGE_URI
IMPERSONATE_KEY
SCENARIO_DEFAULT The name of the default scenario.
SCENARIO_ESSENTIALS
SCENARIO_LIVE
SCENARIO_PASSWORD
SCENARIO_REGISTRATION
STATUS_ACTIVE
STATUS_ARCHIVED
STATUS_DISABLED
STATUS_ENABLED
STATUS_LOCKED
STATUS_PENDING
STATUS_SUSPENDED

# Events

# EVENT_BEFORE_AUTHENTICATE

Type
craft\events\AuthenticateUserEvent

The event that is triggered before a user is authenticated.

If you wish to offload authentication logic, then set craft\events\AuthenticateUserEvent::$performAuthentication to false, and set authError to something if there is an authentication error.