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

Property Description
activeValidators yii\validators\Validator – The validators applicable to the current scenario.
admin boolean – Admin
ancestors craft\elements\db\ElementQueryInterface, craft\base\ElementInterface[]
archived boolean – Whether the element is archived
attributes array – Attribute values (name => value).
authError string, null – Auth error
authKey string – 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
children craft\elements\db\ElementQueryInterface, craft\base\ElementInterface[]
contentId integer, null – The element’s content row ID
contentTable string
cooldownEndTime DateTime, null
cpEditUrl string, null
currentPassword string, null – Current password
currentRevision craft\base\ElementInterface, null
dateCreated DateTime, null – The date that the element was created
dateDeleted DateTime, null – The date that the element was trashed
dateUpdated DateTime, null – The date that the element was last updated
descendants craft\elements\db\ElementQueryInterface, craft\base\ElementInterface[]
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 editor HUD
email string, null – Email
enabled boolean – Whether the element is enabled
enabledForSite boolean, null – Whether the element is enabled for the given site.
errors array – Errors for all attributes or the specified attribute.
fieldColumnPrefix string
fieldContext string
fieldLayout craft\models\FieldLayout, null
fieldLayoutId integer, null – The element’s field layout ID
fieldParamNamespace string, null – The field param namespace
fieldValues array – The field values (handle => value)
firstErrors array – The first errors.
firstName string, null – First name
friendlyName string, null
fullName string, null
gqlTypeName string
groups craft\models\UserGroup[]
hardDelete boolean – Whether the element is being hard-deleted.
hasDashboard boolean – Whether the user has a dashboard
hasDescendants boolean
hasFreshContent boolean – Whether the element’s content is fresh
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
isCurrent boolean
isDraft boolean
isEditable boolean
isHomepage boolean
isRevision boolean
isUnsavedDraft boolean
iterator ArrayIterator – An iterator for traversing the items in the list.
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
locked boolean – Locked
lockoutDate DateTime, null – Lockout date
name string
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
nextSibling craft\base\ElementInterface, null
parent craft\base\ElementInterface, null
password string, null – Password
passwordResetRequired boolean – Password reset required
pending boolean – Pending
photo craft\elements\Asset, null
photoId integer, null – Photo asset id
photoUrl string, null
preferences array – The user’s preferences.
preferredLanguage string, null – The preferred language
prev craft\base\ElementInterface, null
prevSibling craft\base\ElementInterface, null
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
remainingCooldownTime DateInterval, null
resaving boolean – Whether the element is being resaved by a ResaveElement job or a resave console command.
revisionId integer – 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
route mixed – The route that the request should use, or null if no special action should be taken
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
siblings craft\elements\db\ElementQueryInterface, craft\base\ElementInterface[]
site craft\models\Site
siteId integer, null – The site ID the element is associated with
slug string, null – The element’s slug
sourceId integer, null
sourceUid string
status string, null
structureId integer, null – The element’s structure ID
supportedSites integer[], array
suspended boolean – Suspended
tempId string, null – The element’s temporary ID (only used if the element's URI format contains {id})
title string, null – The element’s title
totalDescendants integer
trashed boolean – Whether the element has been soft-deleted.
uiLabel string
uid string, null – The element’s UID
unverifiedEmail string, null – Unverified email
uri string, null – The element’s URI
uriFormat string, null
url string, null
username string, null – Username
validators ArrayObject, yii\validators\Validator – All the validators declared in the model.
verificationCode string, null – Verification code
verificationCodeIssuedDate DateTime, null – Verification code issued date

# admin

Type
boolean

Admin

View source

# authError

Type
string, null

Auth error

View source

# authKey

Type
string
Access
Read-only

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

View source

# cooldownEndTime

Type
DateTime, null
Access
Read-only

View source

# cpEditUrl

Type
string, null
Access
Read-only

View source

# currentPassword

Type
string, null

Current password

View source

# editorHtml

Type
string
Access
Read-only

The HTML for the editor HUD

View source

# email

Type
string, null

Email

View source

# fieldLayout

Type
craft\models\FieldLayout, null
Access
Read-only

View source

# firstName

Type
string, null

First name

View source

# friendlyName

Type
string, null
Access
Read-only

View source

# fullName

Type
string, null
Access
Read-only

View source

# gqlTypeName

Type
string
Access
Read-only
Since
3.3.0

View source

# groups

Type
craft\models\UserGroup[]

View source

# hasDashboard

Type
boolean
Since
3.0.4

Whether the user has a dashboard

View source

# inheritorOnDelete

Type
self, null

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

View source

# invalidLoginCount

Type
integer, null

Invalid login count

View source

# isCurrent

Type
boolean
Access
Read-only

View source

# isEditable

Type
boolean
Access
Read-only

View source

# lastInvalidLoginDate

Type
DateTime, null

Last invalid login date

View source

# lastLoginAttemptIp

Type
string, null

Last login attempt IP address.

View source

# lastLoginDate

Type
DateTime, null

Last login date

View source

# lastName

Type
string, null

Last name

View source

# lastPasswordChangeDate

Type
DateTime, null

Last password change date

View source

# locked

Type
boolean

Locked

View source

# lockoutDate

Type
DateTime, null

Lockout date

View source

# name

Type
string
Access
Read-only

View source

# newPassword

Type
string, null

New password

View source

# password

Type
string, null

Password

View source

# passwordResetRequired

Type
boolean

Password reset required

View source

# pending

Type
boolean

Pending

View source

# photo

Type
craft\elements\Asset, null
Access
Read-only

View source

# photoId

Type
integer, null

Photo asset id

View source

# photoUrl

Type
string, null
Access
Read-only

View source

# preferences

Type
array
Access
Read-only

The user’s preferences.

View source

# preferredLanguage

Type
string, null
Access
Read-only

The preferred language

View source

# ref

Type
string, null
Access
Read-only

View source

# remainingCooldownTime

Type
DateInterval, null
Access
Read-only

View source

# status

Type
string, null
Access
Read-only

View source

# suspended

Type
boolean

Suspended

View source

# unverifiedEmail

Type
string, null

Unverified email

View source

# username

Type
string, null

Username

View source

# verificationCode

Type
string, null

Verification code

View source

# verificationCodeIssuedDate

Type
DateTime, null

Verification code issued date

View source

# Protected Properties

Property Description
revisionCreatorId string, 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() 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 an object property to 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().
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.
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.
getChildren() Returns the element’s children.
getContentTable() Returns the name of the table this element’s content is stored in.
getCooldownEndTime() Returns the time when the user will be over their cooldown period.
getCpEditUrl() Returns the element’s edit URL in the control panel.
getCurrentRevision() Returns the element’s current revision, if one exists.
getDescendants() Returns the element’s descendants.
getDirtyAttributes() Returns a list of attribute names that have changed since the element was first loaded.
getDirtyFields() Returns a list of custom field handles that have changed since the element was first loaded.
getEagerLoadedElementCount() Returns the count of eager-loaded elements for a given handle.
getEagerLoadedElements() Returns the eager-loaded elements for a given handle.
getEditorHtml() Returns the HTML for the element’s editor HUD.
getEnabledForSite() Returns whether the element is enabled for the current site.
getError() Returns the first error of the specified attribute.
getErrorSummary() 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() Gets the user's first name or username.
getFullName() Returns the user's full name.
getGqlTypeName() Returns the GraphQL type name for this element type.
getGroups() Returns the user's groups.
getHasDescendants() Returns whether the element has descendants.
getHasFreshContent() Returns whether the element’s content is "fresh" (unsaved and without validation errors).
getHtmlAttributes() Returns any attributes that should be included in the element’s DOM representation in the control panel.
getId() Returns the element’s ID.
getIsCurrent() Returns whether this is the current logged-in user.
getIsDraft() Returns whether this is a draft.
getIsEditable() Returns whether the current user can edit the element.
getIsHomepage() Returns whether this element represents the site homepage.
getIsRevision() Returns whether this is a revision.
getIsUnsavedDraft() Returns whether the element is an unsaved draft.
getIterator() Returns an iterator for traversing the attributes in the model.
getLink() Returns an anchor pre-filled with this element’s URL and title.
getName() Returns the user's full name or username.
getNext() Returns the next element relative to this one, from a given set of criteria.
getNextSibling() Returns the element’s next sibling.
getParent() Returns the element’s parent.
getPhoto() Returns the user's photo.
getPhotoUrl() Returns the URL to the user's photo.
getPreference() Returns one of the user’s preferences by its key.
getPreferences() Returns the user’s preferences.
getPreferredLanguage() Returns the user’s preferred language, if they have one.
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.
getSite() Returns the site the element is associated with.
getSourceId() Returns the element’s ID, or if it’s a draft/revision, its source element’s ID.
getSourceUid() Returns the element’s UUID, or if it’s a draft/revision, its source element’s UUID.
getStatus() Returns the element’s status.
getSupportedSites() Returns the sites this element is associated with.
getTableAttributeHtml() Returns the HTML that should be shown for a given attribute in Table View.
getThumbUrl() Returns the URL to the element’s thumbnail, if there is one.
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().
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.
hasShunned() Returns whether the user has shunned a given message.
hasStatuses() Returns whether elements of this type have statuses.
hasTitles() Returns whether elements of this type have traditional titles.
hasUris() Returns whether elements of this type can have their own slugs and URIs.
indexHtml() Returns the element index HTML.
init() Initializes the object.
instance() 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.
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.
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.
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.
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.
setDirtyAttributes() Sets the list of dirty attribute names.
setEagerLoadedElementCount() Sets the count of eager-loaded elements for a given handle.
setEagerLoadedElements() Sets some eager-loaded elements on a given handle.
setEnabledForSite() Sets whether the element is enabled for the current site.
setFieldParamNamespace() Sets the namespace used by custom field params on the request.
setFieldValue() Sets the value for a given field.
setFieldValues() Sets the element’s custom field values.
setFieldValuesFromRequest() Sets the element’s custom field values, when the values have come from post data.
setGroups() Sets an array of user groups on the user.
setNext() Sets the default next element.
setParent() Sets the element’s parent.
setPhoto() Sets the entry's author.
setPrev() Sets the default previous element.
setRevisionCreatorId() Sets the revision creator ID to be saved.
setRevisionNotes() Sets the revision notes to be saved.
setScenario() Sets the scenario for the model.
sortOptions() Returns the sort options for the element type.
sources() Returns the source definitions that elements of this type may belong to.
statuses() Returns all of the possible statuses that elements of this type may have.
tableAttributes() Defines all of the available columns that can be shown in table views.
toArray() 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

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

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

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

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

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

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

View source

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.

This is required if yii\web\User::$enableAutoLogin is enabled. The returned key will be stored on the client side as a cookie and will be used to authenticate user even if PHP session has been expired.

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

View source

Returns

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

# getCpEditUrl()

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

View source

Returns

string, null

# getEditorHtml()

Returns the HTML for the element’s editor HUD.

View source

Returns

string – The HTML for the editor HUD

# getFieldLayout()

Returns the field layout used by this element.

View source

Returns

craft\models\FieldLayout, null

# getFriendlyName()

Gets 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[]

# getIsCurrent()

Returns whether this is the current logged-in user.

View source

Returns

boolean

# getIsEditable()

Returns whether the current user can edit the element.

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

# 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

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

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:

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

# setGroups()

Sets an array of user groups on the user.

View source

Arguments

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

View source

Returns

array

# validateAuthKey()

Validates the given auth key.

This is required if yii\web\User::$enableAutoLogin is enabled.

View source

Arguments

  • $authKey (string) – The given auth key

Returns

boolean – Whether the given auth key is valid.

# validateUnverifiedEmail()

Validates the unverifiedEmail value is unique.

View source

Arguments

# Protected Methods

Method Description
defineActions() Defines the available element actions for a given source.
defineDefaultTableAttributes() Returns the list of table attribute keys that should be shown by default.
defineExporters() Defines the available element exporters for a given source.
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.
htmlAttributes() Returns any attributes that should be included in the element’s DOM representation in the control panel.
normalizeFieldValue() Normalizes a field’s value.
prepElementQueryForTableAttribute() Preps the element criteria for a given table attribute
previewTargets() Returns the additional locations that should be available for previewing the element, besides its primary URL.
resolveFields() Determines which fields can be returned by toArray().
route() Returns the route that should be used when the element’s URI is requested.
tableAttributeHtml() Returns the HTML that should be shown for a given attribute in Table View.

# defineActions()

Defines the available element actions for a given source.

View source

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.

# tableAttributeHtml()

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

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

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

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

WARNING

All untrusted text should be passed through craft\helpers\Html::encode() 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

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

# Events

# EVENT_BEFORE_AUTHENTICATE

Type
craft\events\AuthenticateUserEvent

The event that is triggered before a user is authenticated.

You may set craft\events\AuthenticateUserEvent::$performAuthentication to false to prevent the user from getting authenticated