Skip to content

User

Type
Class
Namespace
craft\elements
Inherits
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\ClonefixTrait, craft\base\ElementTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait
Since
3.0.0

User represents a user element.

View source

Public Properties

PropertyDescription
activeValidatorsyii\validators\Validator – The validators applicable to the current scenario.
adminboolean – Admin
ancestorscraft\elements\db\ElementQueryInterface – The element’s ancestors
archivedboolean – Whether the element is archived
attributesarray – Attribute values (name => value).
authErrorstring, null – Auth error
authKeystring, null – A key that is used to check the validity of a given identity ID.
awaitingFieldValuesboolean – Whether the element is still awaiting its custom field values
behaviorsyii\base\Behavior – List of behaviors attached to this component.
cacheTagsstring[]
canonicalcraft\base\ElementInterface, null – The canonical element, if one exists for the current site
canonicalIdinteger, null – The element’s canonical ID
canonicalUidstring – The element’s canonical UID
childrencraft\elements\db\ElementQueryInterface – The element’s children
contentIdinteger, null – The element’s content row ID
contentTablestring – The name of the table this element’s content is stored in
cooldownEndTimeDateTime, null – the time when the user will be over their cooldown period
cpEditUrlstring, null – The element’s edit URL in the control panel
currentPasswordstring, null – Current password
currentRevisionstatic, null
dateCreatedDateTime, null – The date that the element was created
dateDeletedDateTime, null – The date that the element was trashed
dateLastMergedDateTime, null – The date that the canonical element was last merged into this one
dateUpdatedDateTime, null – The date that the element was last updated
descendantscraft\elements\db\ElementQueryInterface – The element’s descendants
dirtyAttributesstring[]
dirtyFieldsstring[]
draftIdinteger, null – The ID of the draft’s row in the drafts table
duplicateOfcraft\base\ElementInterface, null – The element that this element is being duplicated by.
editorHtmlstring – The HTML for the element’s editor HUD
emailstring, null – Email
enabledboolean – Whether the element is enabled
enabledForSiteboolean – Whether the element is enabled for this site
errorsarray – Errors for all attributes or the specified attribute.
fieldColumnPrefixstring – The field column prefix this element’s content uses
fieldContextstring – The field context this element’s content uses
fieldLayoutcraft\models\FieldLayout, null – The field layout used by this element
fieldLayoutIdinteger, null – The element’s field layout ID
fieldParamNamespacearray – The namespace used by custom field params on the request
fieldValuesarray – The element’s normalized custom field values, indexed by their handles
firstErrorsarray – The first errors.
firstNamestring, null – First name
firstSaveboolean – Whether the element is being saved for the first time in a normal state (not as a draft or revision).
friendlyNamestring, null – the user's first name or username
fullNamestring, null – the user's full name
gqlTypeNamestring
groupscraft\models\UserGroup[] – the user's groups
hardDeleteboolean – Whether the element is being hard-deleted.
hasCheckeredThumbboolean
hasDashboardboolean – Whether the user has a dashboard
hasDescendantsboolean – Whether the element has descendants
hasFreshContentboolean – Whether the element’s content is "fresh" (unsaved and without validation errors)
hasRoundedThumbboolean
htmlAttributesarray – Any attributes that should be included in the element’s DOM representation in the control panel
idinteger, null – The element’s ID
inheritorOnDeleteself, null – The user who should take over the user’s content if the user is deleted.
invalidLoginCountinteger, null – Invalid login count
isCanonicalboolean
isCurrentboolean – whether this is the current logged-in user
isDeletableboolean
isDerivativeboolean
isDraftboolean
isEditableboolean – Whether the current user can edit the element
isFreshboolean
isHomepageboolean
isNewForSiteboolean – Whether the element is being saved to the current site for the first time.
isProvisionalDraftboolean – Whether this is a provisional draft.
isRevisionboolean
isTitleTranslatableboolean
isUnpublishedDraftboolean
isUnsavedDraftboolean
iteratorArrayIterator – An iterator for traversing the items in the list.
languagestring
lastInvalidLoginDateDateTime, null – Last invalid login date
lastLoginAttemptIpstring, null – Last login attempt IP address.
lastLoginDateDateTime, null – Last login date
lastNamestring, null – Last name
lastPasswordChangeDateDateTime, null – Last password change date
levelinteger, null – The element’s level within its structure
lftinteger, null – The element’s left position within its structure
link\Twig\Markup, null – An anchor pre-filled with this element’s URL and title
localizedcraft\elements\db\ElementQueryInterface[], static[]
lockedboolean – Locked
lockoutDateDateTime, null – Lockout date
mergingCanonicalChangesboolean – Whether recent changes to the canonical element are being merged into this element.
metadataarray – The data, with keys representing the labels.
modifiedAttributesstring[]
modifiedFieldsstring[]
namestring – the user's full name or username
newPasswordstring, null – New password
newSiteIdsinteger[] – The site IDs that the element was just propagated to for the first time.
nextcraft\base\ElementInterface, null – The next element relative to this one, from a given set of criteria
nextSiblingcraft\base\ElementInterface, null – The element’s next sibling
outdatedAttributesstring[]
outdatedFieldsstring[]
parentcraft\base\ElementInterface, null – The element’s parent
parentUristring, null
passwordstring, null – Password
passwordResetRequiredboolean – Password reset required
pendingboolean – Pending
photocraft\elements\Asset, null – the user's photo
photoIdinteger, null – Photo asset ID
photoUrlstring, null
preferencesarray – the user’s preferences
preferredLanguagestring, null – the user’s preferred language
preferredLocalestring, null – the user’s preferred formatting locale
prevcraft\base\ElementInterface, null – The previous element relative to this one, from a given set of criteria
prevSiblingcraft\base\ElementInterface, null – The element’s previous sibling
previewTargetsarray
previewingboolean – Whether the element is currently being previewed.
propagateAllboolean – Whether all element attributes should be propagated across all its supported sites, even if that means overwriting existing site-specific values.
propagatingboolean – Whether the element is being saved in the context of propagating another site's version of the element.
refstring, null – The reference string to this element
remainingCooldownTimeDateInterval, null – the remaining cooldown time for this user, if they've entered their password incorrectly too many times
resavingboolean – Whether the element is being resaved by a ResaveElement job or a resave console command.
revisionIdinteger – The ID of the revision’s row in the revisions table
rgtinteger, null – The element’s right position within its structure
rootinteger, null – The element’s structure’s root ID
routemixed – The route that should be used when the element’s URI is requested
scenariostring – The scenario that this model is in.
searchScoreinteger, null – The element’s search score, if the craft\elements\db\ElementQuery::search() parameter was used when querying for the element
serializedFieldValuesarray – Array of the element’s serialized custom field values, indexed by their handles
siblingscraft\elements\db\ElementQueryInterface – All of the element’s siblings
sidebarHtmlstring
sitecraft\models\Site – Site the element is associated with
siteIdinteger, null – The site ID the element is associated with
siteSettingsIdinteger, null – The ID of the element’s record in the elements_sites table
slugstring, null – The element’s slug
sourceIdinteger, null
sourceUidstring
statusstring, null – The element’s status
structureIdinteger, null – The element’s structure ID
supportedSitesinteger[], array – The sites this element is associated with
suspendedboolean – Suspended
tempIdstring, null – The element’s temporary ID (only used if the element's URI format contains {id})
titlestring, null – The element’s title
titleTranslationDescriptionstring, null
titleTranslationKeystring – The translation key
totalDescendantsinteger – The total number of descendants that the element has
trashedboolean – Whether the element has been soft-deleted.
uiLabelstring
uidstring, null – The element’s UID
unverifiedEmailstring, null – Unverified email
updatingFromDerivativeboolean – Whether the element is being updated from a derivative element, such as a draft or revision.
uristring, null – The element’s URI
uriFormatstring, null – The URI format used to generate this element’s URL
urlstring, null – The element’s full URL
usernamestring, null – Username
validatorsArrayObject, yii\validators\Validator – All the validators declared in the model.
verificationCodestring, null – Verification code
verificationCodeIssuedDateDateTime, null – Verification code issued date

admin

Type
boolean
Default value
false

Admin

View source

authError

Type
string, null
Default value
null

Auth error

View source

authKey

Type
string, null
Default value
null
Access
Read-only

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

View source

cooldownEndTime

Type
DateTime, null
Default value
null

the time when the user will be over their cooldown period

View source

currentPassword

Type
string, null
Default value
null

Current password

View source

email

Type
string, null
Default value
null

Email

View source

firstName

Type
string, null
Default value
null

First name

View source

friendlyName

Type
string, null
Default value
null

the user's first name or username

View source

fullName

Type
string, null
Default value
null

the user's full name

View source

gqlTypeName

Type
string
Default value
null
Access
Read-only
Since
3.3.0

View source

groups

Type
craft\models\UserGroup[]
Default value
null

the user's groups

View source

hasDashboard

Type
boolean
Default value
false
Since
3.0.4

Whether the user has a dashboard

View source

hasRoundedThumb

Type
boolean
Default value
null
Access
Read-only
Since
3.5.5

View source

inheritorOnDelete

Type
self, null
Default value
null

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

View source

invalidLoginCount

Type
integer, null
Default value
null

Invalid login count

View source

isCurrent

Type
boolean
Default value
null

whether this is the current logged-in user

View source

lastInvalidLoginDate

Type
DateTime, null
Default value
null

Last invalid login date

View source

lastLoginAttemptIp

Type
string, null
Default value
null

Last login attempt IP address.

View source

lastLoginDate

Type
DateTime, null
Default value
null

Last login date

View source

lastName

Type
string, null
Default value
null

Last name

View source

lastPasswordChangeDate

Type
DateTime, null
Default value
null

Last password change date

View source

locked

Type
boolean
Default value
false

Locked

View source

lockoutDate

Type
DateTime, null
Default value
null

Lockout date

View source

name

Type
string
Default value
null

the user's full name or username

View source

newPassword

Type
string, null
Default value
null

New password

View source

password

Type
string, null
Default value
null

Password

View source

passwordResetRequired

Type
boolean
Default value
false

Password reset required

View source

pending

Type
boolean
Default value
false

Pending

View source

photo

Type
craft\elements\Asset, null
Default value
null

the user's photo

View source

photoId

Type
integer, null
Default value
null

Photo asset ID

View source

photoUrl

Type
string, null
Default value
null
Access
Read-only

View source

preferences

Type
array
Default value
null

the user’s preferences

View source

preferredLanguage

Type
string, null
Default value
null

the user’s preferred language

View source

preferredLocale

Type
string, null
Default value
null

the user’s preferred formatting locale

View source

remainingCooldownTime

Type
DateInterval, null
Default value
null

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

View source

suspended

Type
boolean
Default value
false

Suspended

View source

unverifiedEmail

Type
string, null
Default value
null

Unverified email

View source

username

Type
string, null
Default value
null

Username

View source

verificationCode

Type
string, null
Default value
null

Verification code

View source

verificationCodeIssuedDate

Type
DateTime, null
Default value
null

Verification code issued date

View source

Protected Properties

PropertyDescription
revisionCreatorIdstring, null – Revision creator ID to be saved
revisionNotesstring, null – Revision notes to be saved

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__clone()
__construct()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()Sets a component property to be null.
actions()Returns the available element actions for a given source.
activeAttributes()Returns the attribute names that are subject to validation in the current scenario.
addError()Adds a new error to the specified attribute.
addErrors()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()This method is invoked after validation ends.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
attributeHints()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()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()Returns a value indicating whether a property can be read.
canSetProperty()Returns a value indicating whether a property can be set.
className()Returns the fully qualified name of this class.
clearErrors()Removes errors for all attributes or a single attribute.
createValidators()Creates validator objects based on the validation rules specified in rules().
datetimeAttributes()Returns the names of any attributes that should hold DateTime values.
defaultTableAttributes()Returns the list of table attribute keys that should be shown by default.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()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()Makes sure that the behaviors declared in behaviors() 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().
fieldLayouts()Returns all of the field layouts associated with elements from the given source.
fields()Returns the list of fields that should be returned by default by toArray() 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.
findSource()Returns a source definition by a given source key/path and context.
formName()Returns the form name that this model class should use.
generateAttributeLabel()Generates a user friendly attribute label based on the give attribute name.
getActiveValidators()Returns the validators applicable to the current scenario.
getAncestors()Returns the element’s ancestors.
getAttributeHint()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()Returns attribute values.
getAuthKey()Returns a key that can be used to check the validity of a given identity ID.
getBehavior()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
getCacheTags()Returns the cache tags that should be cleared when this element is saved.
getCanonical()Returns the canonical version of the element.
getCanonicalId()Returns the element’s canonical ID.
getCanonicalUid()Returns the element’s canonical UUID.
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 slideout.
getEnabledForSite()Returns whether the element is enabled for the current site.
getError()Returns the first error of the specified attribute.
getErrorSummary()Returns the errors for all attributes as a one-dimensional array.
getErrors()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()Returns the first error of the specified attribute.
getFirstErrors()Returns the first error of every attribute in the model.
getFriendlyName()Returns 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 is "fresh" (not yet explicitly saved, 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()
getIsCanonical()Returns whether this is the canonical element.
getIsCurrent()Returns whether this is the current logged-in user.
getIsDeletable()Returns whether the current user can delete the element.
getIsDerivative()Returns whether this is a derivative element, such as a draft or revision.
getIsDraft()Returns whether this is a draft.
getIsEditable()Returns whether the current user can edit the element.
getIsFresh()Returns whether the element is "fresh" (not yet explicitly saved, and without validation errors).
getIsHomepage()Returns whether this element represents the site homepage.
getIsProvisionalDraft()Returns whether this is a provisional draft.
getIsRevision()Returns whether this is a revision.
getIsTitleTranslatable()Returns whether the Title field should be shown as translatable in the UI.
getIsUnpublishedDraft()Returns whether the element is an unpublished draft.
getIsUnsavedDraft()Returns whether the element is an unpublished draft.
getIterator()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.
getMetadata()Returns element metadata that can be shown on its edit page or within element editor slideouts.
getModifiedAttributes()Returns the attribute names that have changed for this element.
getModifiedFields()Returns the field handles that have changed for this element.
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.
getOutdatedAttributes()Returns the attribute names that have been updated on the canonical element since the last time it was merged into this element.
getOutdatedFields()Returns the field handles that have been updated on the canonical element since the last time it was merged into this element.
getParent()Returns the element’s parent.
getParentUri()Returns the parent element’s URI, if there is one.
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()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.
getSidebarHtml()Returns the HTML for any fields/info that should be shown within the sidebar of element editor slideouts.
getSite()Returns the site the element is associated with.
getSourceId()Returns the element’s canonical ID.
getSourceUid()Returns the element’s canonical UID.
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()Returns all the validators declared in rules().
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()Returns a value indicating whether there is any handler attached to the named event.
hasMethod()Returns a value indicating whether a method is defined.
hasProperty()Returns a value indicating whether a property is defined for this component.
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.
indexElementCount()Returns the total number of elements that will be shown on an element index, for the given element query.
indexHtml()Returns the element index HTML.
init()Initializes the object.
instance()Returns static class instance, which can be used to obtain meta information.
isAncestorOf()Returns whether this element is an ancestor of another one.
isAttributeActive()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.
isAttributeModified()Returns whether an attribute value has changed for this element.
isAttributeOutdated()Returns whether an attribute value has fallen behind the canonical element’s value.
isAttributeRequired()Returns a value indicating whether the attribute is required.
isAttributeSafe()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.
isFieldModified()Returns whether a field value has changed for this element.
isFieldOutdated()Returns whether a field value has fallen behind the canonical element’s value.
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()Populates the model with input data.
loadMultiple()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.
mergeCanonicalChanges()Merges changes from the canonical element into this one.
mergePreferences()Merges new user preferences with the existing ones, and returns the result.
off()Detaches an existing event handler from this component.
offsetExists()Returns whether there is an element at the specified offset.
offsetGet()Returns the element at the specified offset.
offsetSet()Sets the element at the specified offset.
offsetUnset()Sets the element value at the specified offset to null.
on()Attaches an event handler to an event.
onUnsafeAttribute()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()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()Sets the attribute values in a massive way.
setCanonical()Sets the canonical version of the element.
setCanonicalId()Sets the element’s canonical ID.
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.
setFriendlyName()Sets the user’s friendly name.
setGroups()Sets an array of user groups on the user.
setIsFresh()Sets whether the element is "fresh" (not yet explicitly saved, and without validation errors).
setName()Sets the user’s name.
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()Sets the scenario for the model.
setUiLabel()Defines what the element should be called within the control panel.
sortOptions()Returns the sort options for the element type.
sourcePath()Returns the source path for a given source key, step key, and context.
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()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()Triggers an event.
validate()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()Validates multiple models.
validateUnverifiedEmail()Validates the unverifiedEmail value is unique.

__toString()

Use the full name or username as the string representation.

View source

Returns

string

afterSave()

Performs actions after an element is saved.

View source

Arguments

  • $isNew (boolean) – Whether the element is brand new

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

Returns

array – 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

Returns

string[] – List of attribute names.

authenticate()

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

View source

Arguments

  • $password (string) – The user's plain text password.

Returns

boolean

beforeDelete()

Performs actions before an element is deleted.

View source

Returns

boolean – Whether the element should be deleted

can()

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

View source

Arguments

Returns

boolean

datetimeAttributes()

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

View source

Returns

string[]

displayName()

Returns the display name of this class.

View source

Returns

string – 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.
php
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

Arguments

  • $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

Returns

array, false, null – 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().

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

View source

Returns

array – The list of expandable field names or field definitions. Please refer to fields() 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,

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

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

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

View source

Returns

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

findIdentity()

Finds an identity by the given ID.

View source

Arguments

Returns

yii\web\IdentityInterface, null – 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

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 will set this parameter to be yii\filters\auth\HttpBearerAuth.

Returns

yii\web\IdentityInterface, null – 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.

The returned key is used to validate session and auto-login (if yii\web\User::$enableAutoLogin is enabled).

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

Returns

string, null – 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

Returns

DateTime, null

getFieldLayout()

Returns the field layout used by this element.

View source

Returns

craft\models\FieldLayout, null

getFriendlyName()

Returns the user's first name or username.

View source

Returns

string, null

getFullName()

Returns the user's full name.

View source

Returns

string, null

getGqlTypeName()

Since
3.3.0

Returns the GraphQL type name for this element type.

View source

Returns

string

getGroups()

Returns the user's groups.

View source

Returns

craft\models\UserGroup[]

getHasRoundedThumb()

Since
3.5.5

Returns whether the element’s thumbnail should be rounded.

View source

Returns

boolean

getIsCurrent()

Returns whether this is the current logged-in user.

View source

Returns

boolean

getName()

Returns the user's full name or username.

View source

Returns

string

getPhoto()

Returns the user's photo.

View source

Returns

craft\elements\Asset, null

getPhotoUrl()

DEPRECATED

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

Returns the URL to the user's photo.

View source

Arguments

  • $size (integer) – The width and height the photo should be sized to

Returns

string, null

getPreference()

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

View source

Arguments

  • $key (string) – 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

Returns

array – The user’s preferences.

getPreferredLanguage()

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

View source

Returns

string, null – 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

Returns

string, null – The preferred locale

getRef()

Returns the reference string to this element.

View source

Returns

string, null

getRemainingCooldownTime()

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

View source

Returns

DateInterval, null

getStatus()

Returns the element’s status.

View source

Returns

string, null

getThumbUrl()

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

View source

Arguments

  • $size (integer) – The maximum width and height the thumbnail should have.

Returns

string, null

gqlTypeNameByContext()

Since
3.3.0

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

View source

Arguments

  • $context (mixed) – The element's context, such as a volume, entry type or Matrix block type.

Returns

string

hasContent()

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

View source

Returns

boolean – 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

Arguments

Returns

boolean

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

Returns

boolean – 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

isInGroup()

Returns whether the user is in a specific group.

View source

Arguments

Returns

boolean

lowerDisplayName()

Since
3.3.17

Returns the lowercase version of displayName().

View source

Returns

string

mergePreferences()

DEPRECATED

Deprecated in 3.7.27.

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

View source

Arguments

  • $preferences (array) – The new preferences

Returns

array – The user’s new preferences.

pluralDisplayName()

Since
3.2.0

Returns the plural version of displayName().

View source

Returns

string

pluralLowerDisplayName()

Since
3.3.17

Returns the plural, lowercase version of displayName().

View source

Returns

string

refHandle()

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

View source

Returns

string, null – 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:

php
[
    '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.

View source

Returns

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

setEagerLoadedElements()

Sets some eager-loaded elements on a given handle.

View source

Arguments

setFriendlyName()

Since
3.7.0

Sets the user’s friendly name.

View source

Arguments

Returns

void

setGroups()

Sets an array of user groups on the user.

View source

Arguments

setName()

Since
3.7.0

Sets the user’s name.

View source

Arguments

Returns

void

setPhoto()

Sets the entry's author.

View source

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. Possible values include green, orange, red, yellow, pink, purple, blue, turquoise, light, grey, black, and white. You can customize the database query condition that should be applied for your custom statuses from craft\elements\db\ElementQuery::statusCondition().

View source

Returns

array

trackChanges()

Since
3.4.0

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.

View source

Returns

boolean – Whether to track changes made to elements of this type.

validateAuthKey()

Validates the given auth key.

View source

Arguments

  • $authKey (string) – The given auth key

Returns

boolean, null – Whether the given auth key is valid.

validateUnverifiedEmail()

Validates the unverifiedEmail value is unique.

View source

Arguments

Protected Methods

MethodDescription
cpEditUrl()Returns the element’s edit URL in the control panel.
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()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()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.
hasFieldLayout()Returns whether the element has a field layout with at least one tab.
htmlAttributes()Returns any attributes that should be included in the element’s DOM representation in the control panel.
indexElements()Returns the resulting elements for an element index.
isDeletable()Returns whether the current user can delete the element.
isEditable()Returns whether the current user can edit the element.
metaFieldsHtml()Returns the HTML for any meta fields that should be shown within the sidebar of element editor slideouts. Or if the element doesn’t have a field layout, they’ll be shown in the main body of the slideout.
metadata()
normalizeFieldValue()Normalizes a field’s value.
prepElementQueryForTableAttribute()Prepares an element query for an element index that includes a given table attribute.
previewTargets()Returns the additional locations that should be available for previewing the element, besides its primary URL.
resolveFields()Determines which fields can be returned by toArray().
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.
slugFieldHtml()Returns the HTML for the element’s Slug field.
tableAttributeHtml()Returns the HTML that should be shown for a given attribute in Table View.
uiLabel()Returns what the element should be called within the control panel.

cpEditUrl()

Since
3.7.0

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

View source

Returns

string, null

defineActions()

Defines the available element actions for a given source.

View source

Arguments

  • $source (string, null) – The selected source’s key, if any.

Returns

array – The available element actions.

defineDefaultTableAttributes()

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

View source

Arguments

  • $source (string) – The selected source’s key

Returns

string[] – 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

Returns

array

defineSearchableAttributes()

Defines which element attributes should be searchable.

View source

Returns

string[] – The element attributes that should be searchable

defineSortOptions()

Returns the sort options for the element type.

View source

Returns

array – The attributes that elements can be sorted by

defineSources()

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

View source

Arguments

  • $context (string, null) – The context ('index' or 'modal').

Returns

array – The sources.

defineTableAttributes()

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

View source

Returns

array – The table attributes.

htmlAttributes()

Returns any attributes that should be included in the element’s DOM representation in the control panel.

View source

Arguments

  • $context (string) – The context that the element is being rendered in ('index', 'field', etc.)

Returns

array

isEditable()

Since
3.7.0

Returns whether the current user can edit the element.

View source

Returns

boolean

metaFieldsHtml()

Since
3.7.0

Returns the HTML for any meta fields that should be shown within the sidebar of element editor slideouts. Or if the element doesn’t have a field layout, they’ll be shown in the main body of the slideout.

View source

Returns

string

metadata()

View source

prepElementQueryForTableAttribute()

Prepares an element query for an element index that includes a given table attribute.

View source

Arguments

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 tableAttributeHtml() method could do this:

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

Arguments

  • $attribute (string) – The attribute name.

Returns

string – The HTML that should be shown for a given attribute in Table View.

Throws

Constants

ConstantDescription
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_DEFAULTThe 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.


EVENT_DEFINE_FRIENDLY_NAME

Type
craft\events\DefineValueEvent
Since
3.7.0

The event that is triggered when defining the user’s friendly name, as returned by getFriendlyName().


EVENT_DEFINE_NAME

Type
craft\events\DefineValueEvent
Since
3.7.0

The event that is triggered when defining the user’s name, as returned by getName() or __toString().