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, craft\base\ModelInterface, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface, yii\web\IdentityInterface
- Uses traits
- craft\base\ClonefixTrait, craft\base\ElementTrait, craft\base\NameTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait
- Since
- 3.0.0
User represents a user element.
Public Properties
Property | Description |
---|---|
active | boolean – Active |
activeValidators | yii\validators\Validator – The validators applicable to the current scenario. |
additionalButtons | string |
addresses | craft\elements\Address[], null – the user’s addresses |
admin | boolean – Admin |
ancestors | craft\elements\db\ElementQueryInterface – The element’s ancestors |
archived | boolean – Whether the element is archived |
attributes | array – Attribute values (name => value). |
authError | string, null – Auth error |
authKey | string, null – A key that is used to check the validity of a given identity ID. |
awaitingFieldValues | boolean – Whether the element is still awaiting its custom field values |
behaviors | yii\base\Behavior – List of behaviors attached to this component. |
cacheTags | string[] |
canonical | craft\base\ElementInterface, null – The canonical element, if one exists for the current site |
canonicalId | integer, null – The element’s canonical ID |
canonicalUid | string – The element’s canonical UID |
children | craft\elements\db\ElementQueryInterface – The element’s children |
contentId | integer, null – The element’s content row ID |
contentTable | string – The name of the table this element’s content is stored in |
cooldownEndTime | DateTime, null – the time when the user will be over their cooldown period |
cpEditUrl | string, null – The element’s edit URL in the control panel |
cpRevisionsUrl | string, null |
currentPassword | string, null – Current password |
currentRevision | self , null |
dateCreated | DateTime, null – The date that the element was created |
dateDeleted | DateTime, null – The date that the element was trashed |
dateLastMerged | DateTime, null – The date that the canonical element was last merged into this one |
dateUpdated | DateTime, null – The date that the element was last updated |
descendants | craft\elements\db\ElementQueryInterface – The element’s descendants |
dirtyAttributes | string[] |
dirtyFields | string[] |
draftId | integer, null – The ID of the draft’s row in the drafts table |
duplicateOf | craft\base\ElementInterface, null – The element that this element is being duplicated by. |
editorHtml | string – The HTML for the element’s editor HUD |
string, null – Email | |
enabled | boolean – Whether the element is enabled |
enabledForSite | boolean – Whether the element is enabled for this site |
errors | array – Errors for all attributes or the specified attribute. |
fieldColumnPrefix | string – The field column prefix this element’s content uses |
fieldContext | string – The field context this element’s content uses |
fieldLayout | craft\models\FieldLayout, null – The field layout used by this element |
fieldLayoutId | integer, null – The element’s field layout ID |
fieldParamNamespace | array – The namespace used by custom field params on the request |
fieldValues | array – The element’s normalized custom field values, indexed by their handles |
firstErrors | array – The first errors. |
firstName | string, null – First name |
firstSave | boolean – Whether the element is being saved for the first time in a normal state (not as a draft or revision). |
friendlyName | string, null – the user’s first name or username |
fullName | string, null – Full name |
gqlTypeName | string |
groups | craft\models\UserGroup[] – the user’s groups |
hardDelete | boolean – Whether the element is being hard-deleted. |
hasCheckeredThumb | boolean |
hasDashboard | boolean – Whether the user has a dashboard |
hasDescendants | boolean – Whether the element has descendants |
hasRoundedThumb | boolean |
htmlAttributes | array – Any attributes that should be included in the element’s DOM representation in the control panel |
id | integer, null – The element’s ID |
inheritorOnDelete | self , null – The user who should take over the user’s content if the user is deleted. |
invalidLoginCount | integer, null – Invalid login count |
isCanonical | boolean – Whether this is the canonical element |
isCredentialed | boolean – whether the user account can be logged into |
isCurrent | boolean – whether this is the current logged-in user |
isDerivative | boolean – Whether this is a derivative element, such as a draft or revision |
isDraft | boolean |
isFresh | boolean |
isHomepage | boolean |
isNewForSite | boolean – Whether the element is being saved to the current site for the first time. |
isProvisionalDraft | boolean – Whether this is a provisional draft. |
isRevision | boolean |
isSlugTranslatable | boolean |
isTitleTranslatable | boolean |
isUnpublishedDraft | boolean |
iterator | ArrayIterator – An iterator for traversing the items in the list. |
language | string |
lastInvalidLoginDate | DateTime, null – Last invalid login date |
lastLoginAttemptIp | string, null – Last login attempt IP address. |
lastLoginDate | DateTime, null – Last login date |
lastName | string, null – Last name |
lastPasswordChangeDate | DateTime, null – Last password change date |
level | integer, null – The element’s level within its structure |
lft | integer, null – The element’s left position within its structure |
link | \Twig\Markup , null – An anchor pre-filled with this element’s URL and title |
localized | craft\elements\db\ElementQueryInterface, \Illuminate\Support\Collection |
locked | boolean – Locked |
lockoutDate | DateTime, null – Lockout date |
mergingCanonicalChanges | boolean – Whether recent changes to the canonical element are being merged into this element. |
metadata | array – The data, with keys representing the labels. |
modifiedAttributes | string[] |
modifiedFields | string[] |
name | string – the user’s full name or username |
newPassword | string, null – New password |
newSiteIds | integer[] – The site IDs that the element was just propagated to for the first time. |
next | craft\base\ElementInterface, null – The next element relative to this one, from a given set of criteria |
nextSibling | craft\base\ElementInterface, null – The element’s next sibling |
outdatedAttributes | string[] |
outdatedFields | string[] |
parent | craft\base\ElementInterface, null – The element’s parent |
parentId | integer, null – The element’s parent’s ID |
parentUri | string, null |
password | string, null – Password |
passwordResetRequired | boolean – Password reset required |
pending | boolean – Pending |
photo | craft\elements\Asset, null – the user’s photo |
photoId | integer, null – Photo asset ID |
postEditUrl | string, null |
preferences | array – the user’s preferences |
preferredLanguage | string, null – the user’s preferred language |
preferredLocale | string, null – the user’s preferred formatting locale |
prev | craft\base\ElementInterface, null – The previous element relative to this one, from a given set of criteria |
prevSibling | craft\base\ElementInterface, null – The element’s previous sibling |
previewTargets | array |
previewing | boolean – Whether the element is currently being previewed. |
propagateAll | boolean – Whether all element attributes should be propagated across all its supported sites, even if that means overwriting existing site-specific values. |
propagating | boolean – Whether the element is being saved in the context of propagating another site's version of the element. |
ref | string, null – The reference string to this element |
remainingCooldownTime | DateInterval, null – the remaining cooldown time for this user, if they've entered their password incorrectly too many times |
resaving | boolean – Whether the element is being resaved by a ResaveElement job or a resave console command. |
revisionId | integer, null – The ID of the revision’s row in the revisions table |
rgt | integer, null – The element’s right position within its structure |
root | integer, null – The element’s structure’s root ID |
rootOwner | self |
route | mixed – The route that should be used when the element’s URI is requested |
scenario | string – The scenario that this model is in. |
searchScore | integer, null – The element’s search score, if the craft\elements\db\ElementQuery::search() parameter was used when querying for the element |
serializedFieldValues | array – Array of the element’s serialized custom field values, indexed by their handles |
siblings | craft\elements\db\ElementQueryInterface – All of the element’s siblings |
site | craft\models\Site – Site the element is associated with |
siteId | integer, null – The site ID the element is associated with |
siteSettingsId | integer, null – The ID of the element’s record in the elements_sites table |
slug | string, null – The element’s slug |
slugTranslationDescription | string, null |
slugTranslationKey | string – The translation key |
sourceId | integer, null |
sourceUid | string |
status | string, null – The element’s status |
structureId | integer, null – The element’s structure ID |
supportedSites | integer[], array – The sites this element is associated with |
suspended | boolean – Suspended |
tempId | string, null – The element’s temporary ID (only used if the element’s URI format contains {id}) |
thumbAlt | string, null |
title | string, null – The element’s title |
titleTranslationDescription | string, null |
titleTranslationKey | string – The translation key |
totalDescendants | integer – The total number of descendants that the element has |
trashed | boolean – Whether the element has been soft-deleted. |
uiLabel | string |
uiLabelPath | string[] |
uid | string, null – The element’s UID |
unverifiedEmail | string, null – Unverified email |
updatingFromDerivative | boolean – Whether the element is being updated from a derivative element, such as a draft or revision. |
uri | string, null – The element’s URI |
uriFormat | string, null – The URI format used to generate this element’s URL |
url | string, null – The element’s full URL |
username | string, null – Username |
validatingRelatedElement | boolean – Whether the element is currently being validated via BaseRelationField::validateRelatedElements() |
validators | ArrayObject, yii\validators\Validator – All the validators declared in the model. |
verificationCode | string, null – Verification code |
verificationCodeIssuedDate | DateTime, null – Verification code issued date |
active
- Type
- boolean
- Default value
false
- Since
- 4.0.0
Active
addresses
- Type
- craft\elements\Address[], null
- Default value
null
the user’s addresses
admin
- Type
- boolean
- Default value
false
Admin
authError
Auth error
authKey
A key that is used to check the validity of a given identity ID.
cooldownEndTime
the time when the user will be over their cooldown period
currentPassword
Current password
email
friendlyName
the user’s first name or username
gqlTypeName
- Type
- string
- Default value
null
- Access
- Read-only
- Since
- 3.3.0
groups
- Type
- craft\models\UserGroup[]
- Default value
null
the user’s groups
hasDashboard
- Type
- boolean
- Default value
false
- Since
- 3.0.4
Whether the user has a dashboard
hasRoundedThumb
- Type
- boolean
- Default value
null
- Access
- Read-only
- Since
- 3.5.5
inheritorOnDelete
- Type
self
, null- Default value
null
The user who should take over the user’s content if the user is deleted.
invalidLoginCount
Invalid login count
isCredentialed
- Type
- boolean
- Default value
null
whether the user account can be logged into
isCurrent
- Type
- boolean
- Default value
null
whether this is the current logged-in user
lastInvalidLoginDate
Last invalid login date
lastLoginAttemptIp
Last login attempt IP address.
lastLoginDate
Last login date
lastPasswordChangeDate
Last password change date
locked
- Type
- boolean
- Default value
false
Locked
lockoutDate
Lockout date
name
- Type
- string
- Default value
null
the user’s full name or username
newPassword
New password
password
Password
passwordResetRequired
- Type
- boolean
- Default value
false
Password reset required
pending
- Type
- boolean
- Default value
false
Pending
photo
- Type
- craft\elements\Asset, null
- Default value
null
the user’s photo
photoId
Photo asset ID
preferences
- Type
- array
- Default value
null
the user’s preferences
preferredLanguage
the user’s preferred language
preferredLocale
the user’s preferred formatting locale
remainingCooldownTime
- Type
- DateInterval, null
- Default value
null
the remaining cooldown time for this user, if they've entered their password incorrectly too many times
suspended
- Type
- boolean
- Default value
false
Suspended
thumbAlt
unverifiedEmail
Unverified email
username
Username
verificationCode
Verification code
verificationCodeIssuedDate
Verification code issued date
Protected Properties
Property | Description |
---|---|
revisionCreatorId | integer, null – Revision creator ID to be saved |
revisionNotes | string, null – Revision notes to be saved |
Public Methods
Method | Description |
---|---|
__call() | Calls the named method which is not a class method. |
__clone() | |
__construct() | |
__get() | Returns the value of a component property. |
__isset() | Checks if a property is set. |
__set() | Sets the value of a component property. |
__toString() | Use the full name or username as the string representation. |
__unset() | 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. |
afterDeleteForSite() | Performs actions after an element is deleted for a site. |
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. |
beforeDeleteForSite() | Performs actions before an element is deleted for a site. |
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. |
canAssignUserGroups() | Returns whether the user is authorized to assign any user groups to users. |
canCreateDrafts() | Returns whether the given user is authorized to create drafts for this element. |
canDelete() | Returns whether the given user is authorized to delete this element. |
canDeleteForSite() | Returns whether the given user is authorized to delete this element for its current site. |
canDuplicate() | Returns whether the given user is authorized to duplicate this element. |
canGetProperty() | Returns a value indicating whether a property can be read. |
canSave() | Returns whether the given user is authorized to save this element in its current form. |
canSetProperty() | Returns a value indicating whether a property can be set. |
canView() | Returns whether the given user is authorized to view this element’s edit page. |
className() | Returns the fully qualified name of this class. |
clearErrors() | Removes errors for all attributes or a single attribute. |
createAnother() | Creates a new element (without saving it) based on this one. |
createCondition() | Returns an element condition for the element type. |
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. |
getAdditionalButtons() | Returns additional buttons that should be shown at the top of the element’s edit page. |
getAddresses() | Gets the user’s addresses. |
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. |
getCpRevisionsUrl() | Returns the element’s revisions index 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. |
getEnabledForSite() | Returns whether the element is enabled for the current site. |
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. |
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. |
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. |
getIsCredentialed() | Returns whether the user account can be logged into. |
getIsCurrent() | Returns whether this is the current logged-in user. |
getIsDerivative() | Returns whether this is a derivative element, such as a draft or revision. |
getIsDraft() | Returns whether this is a draft. |
getIsFresh() | Returns whether the element is "fresh" (not yet explicitly saved, and without validation errors). |
getIsHomepage() | Returns whether this element represents the site homepage. |
getIsRevision() | Returns whether this is a revision. |
getIsSlugTranslatable() | Returns whether the Slug field should be shown as translatable in the UI. |
getIsTitleTranslatable() | Returns whether the Title field should be shown as translatable in the UI. |
getIsUnpublishedDraft() | 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 should be shown within the editor sidebar. |
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. |
getParentId() | Returns the parent ID. |
getParentUri() | Returns the parent element’s URI, if there is one. |
getPhoto() | Returns the user’s photo. |
getPostEditUrl() | Returns the URL that users should be redirected to after editing the element. |
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. |
getRootOwner() | Returns the root owner element. |
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 editor sidebar. |
getSite() | Returns the site the element is associated with. |
getSlugTranslationDescription() | Returns the description of the Slug field’s translation support. |
getSlugTranslationKey() | Returns the Slug’s translation key. |
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. |
getThumbAlt() | Returns alt text for the element’s thumbnail. |
getThumbHtml() | Returns the HTML for the element’s thumbnail, if it has one. |
getThumbUrl() | Returns the URL to the element’s thumbnail, if it has 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. |
getUiLabelPath() | Returns any path segment labels that should be prepended to the element’s UI label. |
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. |
hasRevisions() | Returns whether revisions should be created when this element is saved. |
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. |
modifyCustomSource() | Modifies a custom source’s config, before it’s returned by craft\services\ElementSources::getSources() |
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(). |
prepareEditScreen() | Prepares the response for the element’s Edit screen. |
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. |
setDirtyFields() | Sets the list of dirty field handles. |
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. |
setFieldValueFromRequest() | Sets the value for a given field. The value should have originated from post data. |
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. |
setParentId() | Sets the parent ID. |
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. |
setUiLabelPath() | Defines any path segment labels that should be prepended to the element’s UI label. |
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. |
validateMultiple() | Validates multiple models. |
validateUnverifiedEmail() | Validates the unverifiedEmail value is unique. |
__toString()
Use the full name or username as the string representation.
Returns
afterSave()
Performs actions after an element is saved.
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()
.
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.
Returns
string[] – List of attribute names.
authenticate()
Determines whether the user is allowed to be logged in with a given password.
Arguments
$password
(string) – The user’s plain text password.
Returns
beforeDelete()
Performs actions before an element is deleted.
Returns
boolean – Whether the element should be deleted
can()
Returns whether the user has permission to perform a given action.
Arguments
$permission
(string)
Returns
canAssignUserGroups()
- Since
- 4.0.0
Returns whether the user is authorized to assign any user groups to users.
Returns
canDelete()
- Since
- 4.0.0
Returns whether the given user is authorized to delete this element.
This will only be called if the element can be viewed and/or saved.
Arguments
$user
(craft\elements\User)
Returns
canDuplicate()
- Since
- 4.0.0
Returns whether the given user is authorized to duplicate this element.
This will only be called if the element can be viewed and/or saved.
Arguments
$user
(craft\elements\User)
Returns
canSave()
- Since
- 4.0.0
Returns whether the given user is authorized to save this element in its current form.
This will only be called if the element can be viewed.
Arguments
$user
(craft\elements\User)
Returns
canView()
- Since
- 4.0.0
Returns whether the given user is authorized to view this element’s edit page.
If they can view but not save, the edit form will either render statically, or be restricted to only saving changes as a draft, depending on canCreateDrafts().
Arguments
$user
(craft\elements\User)
Returns
createCondition()
- Since
- 4.0.0
Returns an element condition for the element type.
Returns
craft\elements\conditions\users\UserCondition
displayName()
Returns the display name of this class.
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-loadedmap
– an array of element ID mappings, where each element is a sub-array withsource
andtarget
keyscriteria
(optional) – any criteria parameters that should be applied to the element query when fetching the eager-loaded elementscreateElement
(optional) - an element factory function, which will be passed the element query, the current query result data, and the first source element that the result was eager-loaded for
use craft\base\ElementInterface;
use craft\db\Query;
public static function eagerLoadingMap(array $sourceElements, string $handle)
{
switch ($handle) {
case 'author':
$bookIds = array_map(fn(ElementInterface $element) => $element->id, $sourceElements);
$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 = array_map(fn(ElementInterface $element) => $element->id, $sourceElements);
$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);
}
}
Arguments
$sourceElements
(self[]
) – 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, null, false – 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).
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\base\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(): ElementQueryInterface
{
// 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(): ElementQueryInterface
{
return parent::find()->limit(50);
}
}
Returns
craft\elements\db\UserQuery – The newly created craft\elements\db\UserQuery instance.
findIdentity()
Finds an identity by the given ID.
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.
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 beyii\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.)
getAddresses()
- Since
- 4.0.0
Gets the user’s addresses.
Returns
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.
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.
Returns
getFieldLayout()
Returns the field layout used by this element.
Returns
craft\models\FieldLayout, null
getFriendlyName()
Returns the user’s first name or username.
Returns
getFullName()
DEPRECATED
Deprecated in 4.0.0. fullName should be used instead.
Returns the user’s full name.
Returns
getGqlTypeName()
- Since
- 3.3.0
Returns the GraphQL type name for this element type.
Returns
getGroups()
Returns the user’s groups.
Returns
getHasRoundedThumb()
- Since
- 3.5.5
Returns whether the element’s thumbnail should be rounded.
Returns
getIsCredentialed()
- Since
- 4.0.0
Returns whether the user account can be logged into.
Returns
getIsCurrent()
Returns whether this is the current logged-in user.
Returns
getName()
Returns the user’s full name or username.
Returns
getPhoto()
Returns the user’s photo.
Returns
getPreference()
Returns one of the user’s preferences by its key.
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.
Returns
array – The user’s preferences.
getPreferredLanguage()
Returns the user’s preferred language, if they have one.
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.
Returns
string, null – The preferred locale
getRef()
Returns the reference string to this element.
Returns
getRemainingCooldownTime()
Returns the remaining cooldown time for this user, if they’ve entered their password incorrectly too many times.
Returns
getStatus()
Returns the element’s status.
Returns
getThumbAlt()
- Since
- 4.0.0
Returns alt text for the element’s thumbnail.
Returns
getThumbUrl()
Returns the URL to the element’s thumbnail, if it has one.
Arguments
$size
(integer) – The maximum width and height the thumbnail should have.
Returns
gqlTypeNameByContext()
- Since
- 3.3.0
Returns the GraphQL type name by an element’s context.
Arguments
$context
(mixed
) – The element’s context, such as a volume, entry type or Matrix block type.
Returns
hasContent()
Returns whether elements of this type will be storing any data in the content
table (titles or custom fields).
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.
Arguments
$message
(string)
Returns
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.
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.
isInGroup()
Returns whether the user is in a specific group.
Arguments
$group
(integer, string, craft\models\UserGroup) – The user group model, its handle, or ID.
Returns
lowerDisplayName()
- Since
- 3.3.17
Returns the lowercase version of displayName().
Returns
pluralDisplayName()
- Since
- 3.2.0
Returns the plural version of displayName().
Returns
pluralLowerDisplayName()
- Since
- 3.3.17
Returns the plural, lowercase version of displayName().
Returns
refHandle()
Returns the handle that should be used to refer to this element type from reference tags.
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:
[
'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.
Returns
array – A list of scenarios and the corresponding active attributes.
setAttributes()
- Since
- 4.0.0
Sets the attribute values in a massive way.
Arguments
$values
(array) – Attribute values (name => value) to be assigned to the model.$safeOnly
(boolean) – Whether the assignments should only be done to the safe attributes. A safe attribute is one that is associated with a validation rule in the current scenario.
setEagerLoadedElements()
Sets some eager-loaded elements on a given handle.
Arguments
$handle
(string) – The handle that was used to eager-load the elements$elements
(self[]
) – The eager-loaded elements
setFriendlyName()
- Since
- 3.7.0
Sets the user’s friendly name.
Arguments
$friendlyName
(string)
setGroups()
Sets an array of user groups on the user.
Arguments
$groups
(craft\models\UserGroup[]) – An array of UserGroup objects.
setName()
- Since
- 3.7.0
Sets the user’s name.
Arguments
$name
(string)
setPhoto()
Sets the entry’s author.
Arguments
$photo
(craft\elements\Asset, null)
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 includegreen
,orange
,red
,yellow
,pink
,purple
,blue
,turquoise
,light
,grey
,black
, andwhite
. You can customize the database query condition that should be applied for your custom statuses from craft\elements\db\ElementQuery::statusCondition().
Returns
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.
Returns
boolean – Whether to track changes made to elements of this type.
validateAuthKey()
Validates the given auth key.
Arguments
$authKey
(string) – The given auth key
Returns
boolean, null – Whether the given auth key is valid.
validateUnverifiedEmail()
Validates the unverifiedEmail value is unique.
Arguments
$attribute
(string)$params
(array, null)$validator
(yii\validators\InlineValidator)
Protected Methods
Method | Description |
---|---|
cacheTags() | Returns the cache tags that should be cleared when this element is saved. |
cpEditUrl() | Returns the element’s edit URL in the control panel. |
cpRevisionsUrl() | Returns the element’s revisions index URL in the control panel. |
defineActions() | Defines the available element actions for a given source. |
defineBehaviors() | Returns the behaviors to attach to this class. |
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. |
hasNewParent() | Returns whether the element has been assigned a new parent. |
htmlAttributes() | Returns any attributes that should be included in the element’s DOM representation in the control panel. |
includeSetStatusAction() | Returns whether the Set Status action should be included in actions() automatically. |
indexElements() | Returns the resulting elements for an element index. |
metaFieldsHtml() | Returns the HTML for any meta fields that should be shown within the editor sidebar. |
metadata() | Returns element metadata that should be shown within the editor sidebar. |
normalizeFieldValue() | Normalizes a field’s value. |
normalizeNames() | Normalizes the name properties. |
notesFieldHtml() | Returns the notes field HTML for the sidebar. |
prepElementQueryForTableAttribute() | Prepares an element query for an element index that includes a given table attribute. |
prepareNamesForSave() | Parses fullName if set, or sets it based on firstName and lastName . |
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. |
showStatusField() | Returns whether the Status field should be shown for this element. |
slugFieldHtml() | Returns the HTML for the element’s Slug field. |
statusFieldHtml() | Returns the status field HTML for the sidebar. |
tableAttributeHtml() | Returns the HTML that should be shown for a given attribute in Table View. |
thumbSvg() | Returns the element’s thumbnail SVG contents, which should be used as a fallback when getThumbUrl() returns null . |
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.
Returns
defineActions()
Defines the available element actions for a given source.
Arguments
$source
(string) – 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.
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.
Returns
defineSearchableAttributes()
Defines which element attributes should be searchable.
Returns
string[] – The element attributes that should be searchable
defineSortOptions()
Returns the sort options for the element type.
Returns
array – The attributes that elements can be sorted by
defineSources()
Defines the sources that elements of this type may belong to.
Arguments
$context
(string) – The context ('index', 'modal', 'field', or 'settings').
Returns
array – The sources.
defineTableAttributes()
Defines all of the available columns that can be shown in table views.
Returns
array – The table attributes.
htmlAttributes()
Returns any attributes that should be included in the element’s DOM representation in the control panel.
Arguments
$context
(string) – The context that the element is being rendered in ('index', 'modal', 'field', or 'settings'.)
Returns
metaFieldsHtml()
- Since
- 3.7.0
Returns the HTML for any meta fields that should be shown within the editor sidebar.
Arguments
$static
(boolean) – Whether the fields should be static (non-interactive)
Returns
metadata()
- Since
- 3.7.0
Returns element metadata that should be shown within the editor sidebar.
Returns
array – The data, with keys representing the labels. The values can either be strings or callables. If a value is false
, it will be omitted.
prepElementQueryForTableAttribute()
Prepares an element query for an element index that includes a given table attribute.
Arguments
$elementQuery
(craft\elements\db\ElementQueryInterface)$attribute
(string)
statusFieldHtml()
- Since
- 4.0.0
Returns the status field HTML for the sidebar.
Returns
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:
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
oruri
, 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 DateTime object, the date will be formatted with a localized date format.
- For anything else, it will output the attribute value as a string.
Arguments
$attribute
(string) – The attribute name.
Returns
string – The HTML that should be shown for a given attribute in Table View.
Throws
thumbSvg()
- Since
- 4.5.0
Returns the element’s thumbnail SVG contents, which should be used as a fallback when getThumbUrl() returns null
.
Returns
uiLabel()
- Since
- 3.6.4
Returns what the element should be called within the control panel.
Returns
Constants
Constant | Description |
---|---|
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_ACTIVATION | |
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_INACTIVE | |
STATUS_LOCKED | |
STATUS_PENDING | |
STATUS_SUSPENDED |
Events
EVENT_BEFORE_AUTHENTICATE
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().