Element

Type: Abstract Class
Namespace: craft\base
Inherits: 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
Uses traits: craft\base\ClonefixTrait, craft\base\ElementTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait
Extended by: craft\elements\Address, craft\elements\Asset, craft\elements\Category, craft\elements\Entry, craft\elements\GlobalSet, craft\elements\Tag, craft\elements\User, craft\test\mockclasses\elements\ExampleElement
Since: 3.0.0

Element is the base class for classes representing elements in terms of objects.

Public Properties

Property	Description
actionMenuItems
activeValidators	yii\validators\Validator – The validators applicable to the current scenario.
additionalButtons	string
ancestors	craft\elements\db\ElementQueryInterface – The element’s ancestors
archived	boolean – Whether the element is archived
attributes	array – Attribute values (name => value).
attributesFromRequest	array – The attribute values
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
cardBodyHtml	string, null
children	craft\elements\db\ElementQueryInterface – The element’s children
chipLabelHtml	string
cpEditUrl	string, null – The element’s edit URL in the control panel
cpRevisionsUrl	string, null
crumbs	array
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
deletedWithOwner	boolean, null – Whether the element was deleted along with its owner
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.
eagerLoadInfo	craft\elements\db\EagerLoadInfo, null – Info about the eager loading setup used to query this element.
editorHtml	string – The HTML for the element’s editor HUD
elementQueryResult	craft\base\ElementInterface[], null – All elements that the element was queried with.
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.
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.
firstSave	boolean – Whether the element is being saved for the first time in a normal state (not as a draft or revision).
forceSave	boolean – Whether the element should definitely be saved, if it’s a nested element being considered for saving by `\craft\base\NestedElementManager`.
gqlTypeName	string
hardDelete	boolean – Whether the element is being hard-deleted.
hasDescendants	boolean – Whether the element has descendants
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
invalidNestedElementIds	integer[]
isCanonical	boolean – Whether this is the canonical element
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
lazyEagerLoadedElements	string – The handle that was used to eager-load the elements
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, craft\elements\ElementCollection
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[]
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
postEditUrl	string, null
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.
propagatingFrom	craft\base\ElementInterface, null – The element that this element is being propagated from.
ref	string, null – The reference string to this element
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
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
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
uiLabelPath	string[]
uid	string, null – The element’s UID
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
validators	ArrayObject, yii\validators\Validator – All the validators declared in the model.

`actionMenuItems`

Default value: null
Access: Read-only

View source

`additionalButtons`

Type: string
Default value: null
Access: Read-only
Since: 4.0.0

View source

`ancestors`

Type: craft\elements\db\ElementQueryInterface
Default value: null

The element’s ancestors

View source

`attributesFromRequest`

Type: array
Default value: null
Access: Write-only

The attribute values

View source

`cacheTags`

Type: string[]
Default value: null
Access: Read-only
Since: 3.5.0

View source

`canonical`

Type: craft\base\ElementInterface, null
Default value: null

The canonical element, if one exists for the current site

View source

`canonicalId`

Type: integer, null
Default value: null

The element’s canonical ID

View source

`canonicalUid`

Type: string
Default value: null

The element’s canonical UID

View source

`cardBodyHtml`

Type: string, null
Default value: null
Access: Read-only
Since: 5.0.0

View source

`children`

Type: craft\elements\db\ElementQueryInterface
Default value: null

The element’s children

View source

`chipLabelHtml`

Type: string
Default value: null
Access: Read-only
Since: 5.0.0

View source

`cpEditUrl`

Type: string, null
Default value: null

The element’s edit URL in the control panel

View source

`cpRevisionsUrl`

Type: string, null
Default value: null
Access: Read-only
Since: 4.4.0

View source

`crumbs`

Type: array
Default value: null
Access: Read-only
Since: 5.0.0

View source

`currentRevision`

Type: self, null
Default value: null
Access: Read-only
Since: 3.2.0

View source

`descendants`

Type: craft\elements\db\ElementQueryInterface
Default value: null

The element’s descendants

View source

`dirtyAttributes`

Type: string[]
Default value: null
Since: 3.4.0

View source

`dirtyFields`

Type: string[]
Default value: null
Since: 3.4.0

View source

`editorHtml`

Type: string
Default value: null

The HTML for the element’s editor HUD

View source

`enabledForSite`

Type: boolean
Default value: null

Whether the element is enabled for this site

View source

`fieldContext`

Type: string
Default value: null

The field context this element’s content uses

View source

`fieldLayout`

Type: craft\models\FieldLayout, null
Default value: null

The field layout used by this element

View source

`fieldParamNamespace`

Type: array
Default value: null

The namespace used by custom field params on the request

View source

`fieldValues`

Type: array
Default value: null

The element’s normalized custom field values, indexed by their handles

View source

`gqlTypeName`

Type: string
Default value: null
Access: Read-only
Since: 3.3.0

View source

`hasDescendants`

Type: boolean
Default value: null

Whether the element has descendants

View source

`htmlAttributes`

Type: array
Default value: null

Any attributes that should be included in the element’s DOM representation in the control panel

View source

`invalidNestedElementIds`

Type: integer[]
Default value: null
Access: Read-only
Since: 5.3.0

View source

`isCanonical`

Type: boolean
Default value: null

Whether this is the canonical element

View source

`isDerivative`

Type: boolean
Default value: null

Whether this is a derivative element, such as a draft or revision

View source

`isDraft`

Type: boolean
Default value: null
Access: Read-only
Since: 3.2.0

View source

`isFresh`

Type: boolean
Default value: null
Access: Read-only
Since: 3.7.14

View source

`isHomepage`

Type: boolean
Default value: null
Access: Read-only
Since: 3.3.6

View source

`isRevision`

Type: boolean
Default value: null
Access: Read-only
Since: 3.2.0

View source

`isSlugTranslatable`

Type: boolean
Default value: null
Access: Read-only
Since: 4.5.0

View source

`isTitleTranslatable`

Type: boolean
Default value: null
Access: Read-only
Since: 3.5.0

View source

`isUnpublishedDraft`

Type: boolean
Default value: null
Access: Read-only
Since: 3.6.0

View source

`iterator`

Type: ArrayIterator
Default value: null
Access: Read-only

An iterator for traversing the items in the list.

View source

`language`

Type: string
Default value: null
Access: Read-only
Since: 3.5.0

View source

`lazyEagerLoadedElements`

Type: string
Default value: null
Access: Write-only

The handle that was used to eager-load the elements

View source

`link`

Type: \Twig\Markup, null
Default value: null

An anchor pre-filled with this element’s URL and title

View source

`localized`

Type: craft\elements\db\ElementQueryInterface, craft\elements\ElementCollection
Default value: null
Access: Read-only
Since: 3.5.0

View source

`metadata`

Type: array
Default value: null
Access: Read-only
Since: 3.7.0

The data, with keys representing the labels. The values can either be strings or callables. If a value is false, it will be omitted.

View source

`modifiedAttributes`

Type: string[]
Default value: null
Access: Read-only
Since: 3.7.0

View source

`modifiedFields`

Type: string[]
Default value: null
Access: Read-only
Since: 3.7.0

View source

`next`

Type: craft\base\ElementInterface, null
Default value: null

The next element relative to this one, from a given set of criteria

View source

`nextSibling`

Type: craft\base\ElementInterface, null
Default value: null

The element’s next sibling

View source

`outdatedAttributes`

Type: string[]
Default value: null
Access: Read-only
Since: 3.7.0

View source

`outdatedFields`

Type: string[]
Default value: null
Access: Read-only
Since: 3.7.0

View source

`parent`

Type: craft\base\ElementInterface, null
Default value: null

The element’s parent

View source

`parentId`

Type: integer, null
Default value: null

The element’s parent’s ID

View source

`parentUri`

Type: string, null
Default value: null
Access: Read-only

View source

`postEditUrl`

Type: string, null
Default value: null
Access: Read-only
Since: 4.0.0

View source

`prev`

Type: craft\base\ElementInterface, null
Default value: null

The previous element relative to this one, from a given set of criteria

View source

`prevSibling`

Type: craft\base\ElementInterface, null
Default value: null

The element’s previous sibling

View source

`previewTargets`

Type: array
Default value: null
Access: Read-only
Since: 3.2.0

View source

`ref`

Type: string, null
Default value: null

The reference string to this element

View source

`rootOwner`

Type: self
Default value: null
Access: Read-only
Since: 5.4.0

View source

`route`

Type: mixed
Default value: null

The route that should be used when the element’s URI is requested

View source

`serializedFieldValues`

Type: array
Default value: null

Array of the element’s serialized custom field values, indexed by their handles

View source

`siblings`

Type: craft\elements\db\ElementQueryInterface
Default value: null

All of the element’s siblings

View source

`site`

Type: craft\models\Site
Default value: null

Site the element is associated with

View source

`slugTranslationDescription`

Type: string, null
Default value: null
Access: Read-only
Since: 4.5.0

View source

`slugTranslationKey`

Type: string
Default value: null
Access: Read-only
Since: 4.5.0

The translation key

View source

`sourceId`

Type: integer, null
Default value: null
Access: Read-only
Since: 3.2.0

View source

`sourceUid`

Type: string
Default value: null
Access: Read-only
Since: 3.2.0

View source

`status`

Type: string, null
Default value: null

The element’s status

View source

`supportedSites`

Type: integer[], array
Default value: null

The sites this element is associated with

View source

`titleTranslationDescription`

Type: string, null
Default value: null
Access: Read-only
Since: 3.5.0

View source

`titleTranslationKey`

Type: string
Default value: null
Access: Read-only
Since: 3.5.0

The translation key

View source

`totalDescendants`

Type: integer
Default value: null

The total number of descendants that the element has

View source

`uiLabel`

Default value: null

View source

`uiLabelPath`

Type: string[]
Default value: null
Since: 4.4.0

View source

`uriFormat`

Type: string, null
Default value: null

The URI format used to generate this element’s URL

View source

`url`

Type: string, null
Default value: null

The element’s full URL

View source

Protected Properties

Property	Description
revisionCreatorId	integer, null – Revision creator ID to be saved
revisionNotes	string, null – Revision notes to be saved

`revisionCreatorId`

Type: integer, null
Default value: null

Revision creator ID to be saved

`revisionNotes`

Type: string, null
Default value: 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()	Returns the string representation of the element.
__unset()	Sets a component property to be null.
actions()	Returns the available bulk 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.
addInvalidNestedElementIds()	Registers invalid nested element IDs with the element, so an `error` class can be added on their cards.
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.
attributePreviewHtml()	Return HTML for the attribute in the card preview.
attributes()	Returns the list of attribute names.
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.
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.
canDuplicateAsDraft()	Returns whether the given user is authorized to duplicate this element as an unpublished draft.
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.
cardAttributes()	Defines all the available attributes that can be shown in card views.
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.
defaultCardAttributes()	Returns the list of card attribute keys that should be shown by default, if the field layout hasn't been customised.
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 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.
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.
get()
getActionMenuItems()
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.
getAncestors()	Returns the element’s ancestors.
getAttributeHint()	Returns the text hint for the specified attribute.
getAttributeHtml()	Returns the HTML that should be shown for a given attribute in table and card views.
getAttributeLabel()	Returns the text label for the specified attribute.
getAttributeStatus()	Returns the status of a given attribute.
getAttributes()	Returns attribute values.
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.
getCardBodyHtml()	Returns the body HTML for element cards.
getChildren()	Returns the element’s children.
getChipLabelHtml()	Returns the label HTML for element chips.
getCpEditUrl()
getCpRevisionsUrl()	Returns the element’s revisions index URL in the control panel.
getCrumbs()	Returns the breadcrumbs that lead up to the element.
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.
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.
getGqlTypeName()	Returns the GraphQL type name for this element type.
getHasDescendants()	Returns whether the element has descendants.
getHtmlAttributes()	Returns any attributes that should be included in the element’s chips and cards.
getId()
getInlineAttributeInputHtml()	Returns the HTML that should be shown for a given attribute's inline editing input.
getInvalidNestedElementIds()	Returns the element’s invalid nested element IDs.
getIsCanonical()	Returns whether this is the canonical element.
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.
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.
getPostEditUrl()	Returns the URL that users should be redirected to after editing the element.
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.
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()
getSupportedSites()	Returns the sites this element is associated with.
getThumbHtml()
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()
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().
gqlScopesByContext()	Returns the GraphQL scopes required by element’s context.
hasDrafts()	Returns whether element indexes should show the “Drafts” status option.
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.
hasStatuses()	Returns whether elements of this type have statuses.
hasThumbs()	Returns whether element indexes should include a thumbnail view by default.
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.
indexViewModes()	Returns the view modes available for the element type.
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.
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.
render()	Renders the element using its partial template.
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.
setAttributesFromRequest()	Sets the element’s attributes from an element editor submission.
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.
setIsFresh()	Sets whether the element is "fresh" (not yet explicitly saved, and without validation errors).
setLazyEagerLoadedElements()	Sets whether the given eager-loaded element handles were eager-loaded lazily.
setNext()	Sets the default next element.
setParent()	Sets the element’s parent.
setParentId()	Sets the parent ID.
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.
showStatusIndicator()	Returns whether chips and cards for this element should include a status indicator.
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()
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.
validateCustomFieldAttribute()	Calls a custom validation function on a custom field.
validateMultiple()	Validates multiple models.

`__call()`

Calls the named method which is not a class method.

This method will check if any attached behavior has the named method and will execute it if available.

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

View source

Arguments

$name (string) – The method name
$params (array) – Method parameters

Returns

mixed – The method return value

Arguments

$config

`__get()`

Returns the value of a component property.

This method will check in the following order and act accordingly:

a property defined by a getter: return the getter result
a property of a behavior: return the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $component->property;.

View source

Arguments

$name (string) – The property name

Returns

mixed – The property value or the value of a behavior's property

Throws

yii\base\UnknownPropertyException
if the property is not defined
yii\base\InvalidCallException
if the property is write-only.

`__isset()`

Checks if a property is set.

This method will check if $name is one of the following:

"title"
a magic property supported by yii\base\Component::__isset()
a custom field handle

View source

Arguments

$name (string) – The property name

Returns

boolean – Whether the property is set

`__set()`

Sets the value of a component property.

This method will check in the following order and act accordingly:

a property defined by a setter: set the property value
an event in the format of "on xyz": attach the handler to the event "xyz"
a behavior in the format of "as xyz": attach the behavior named as "xyz"
a property of a behavior: set the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $component->property = $value;.

View source

Arguments

$name (string) – The property name or the event name
$value (mixed) – The property value

Throws

yii\base\UnknownPropertyException
if the property is not defined
yii\base\InvalidCallException
if the property is read-only.

`__toString()`

Returns the string representation of the element.

View source

Returns

string

`actions()`

Returns the available bulk element actions for a given source.

The actions can be represented by their fully qualified class name, a config array with the class name set to a type key, or by an instantiated element action object.

TIP

Element types that extend craft\base\Element should override craft\base\Element::defineActions() instead of this method.

View source

Arguments

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

Returns

array – The available bulk element actions.

`addError()`

Adds a new error to the specified attribute.

View source

Arguments

$attribute (string) – Attribute name
$error (string) – New error message

`addInvalidNestedElementIds()`

Since: 5.3.0

Registers invalid nested element IDs with the element, so an error class can be added on their cards.

View source

Arguments

$ids (integer[])

`afterDelete()`

Performs actions after an element is deleted.

View source

`afterDeleteForSite()`

Since: 4.7.0

Performs actions after an element is deleted for a site.

View source

`afterMoveInStructure()`

Performs actions after an element is moved within a structure.

View source

Arguments

$structureId (integer) – The structure ID

`afterPropagate()`

Since: 3.2.0

Performs actions after an element is fully saved and propagated to other sites.

TIP

This will get called regardless of whether $propagate is true or false for craft\services\Elements::saveElement().

View source

Arguments

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

`afterRestore()`

Since: 3.1.0

Performs actions after an element is restored.

View source

`afterSave()`

Performs actions after an element is saved.

View source

Arguments

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

`afterValidate()`

This method is invoked after validation ends.

The default implementation raises an afterValidate event. You may override this method to do postprocessing after validation. Make sure the parent implementation is invoked so that the event can be raised.

View source

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

`attributePreviewHtml()`

Since: 5.5.0

Return HTML for the attribute in the card preview.

View source

Arguments

$attribute (array)

Returns

mixed

`attributes()`

Returns the list of attribute names.

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

View source

Returns

string[] – List of attribute names.

`beforeDelete()`

Performs actions before an element is deleted.

View source

Returns

boolean – Whether the element should be deleted

`beforeDeleteForSite()`

Since: 4.7.0

Performs actions before an element is deleted for a site.

View source

Returns

boolean – Whether the element should be deleted

`beforeMoveInStructure()`

Performs actions before an element is moved within a structure.

View source

Arguments

$structureId (integer) – The structure ID

Returns

boolean – Whether the element should be moved within the structure

`beforeRestore()`

Since: 3.1.0

Performs actions before an element is restored.

View source

Returns

boolean – Whether the element should be restored

`beforeSave()`

Performs actions before an element is saved.

View source

Arguments

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

Returns

boolean – Whether the element should be saved

`canCreateDrafts()`

Since: 4.0.0

Returns whether the given user is authorized to create drafts for this element.

This will only be called if the element can be viewed and/or saved.

TIP

If this is going to return true under any circumstances, make sure trackChanges() is returning true, so drafts can be automatically updated with upstream content changes.

View source

Arguments

$user (craft\elements\User)

Returns

boolean

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

View source

Arguments

$user (craft\elements\User)

Returns

boolean

`canDeleteForSite()`

Since: 4.0.0

Returns whether the given user is authorized to delete this element for its current site.

This will only be called if the element can be viewed and/or saved.

View source

Arguments

$user (craft\elements\User)

Returns

boolean

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

View source

Arguments

$user (craft\elements\User)

Returns

boolean

`canDuplicateAsDraft()`

Since: 5.0.0

Returns whether the given user is authorized to duplicate this element as an unpublished draft.

View source

Arguments

$user (craft\elements\User)

Returns

boolean

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

View source

Arguments

$user (craft\elements\User)

Returns

boolean

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

View source

Arguments

$user (craft\elements\User)

Returns

boolean

`cardAttributes()`

Since: 5.5.0

Defines all the available attributes that can be shown in card views.

This method should return an array whose keys represent element attribute names, and whose values make up the table’s column headers.

View source

Returns

array – The card attributes.

`createAnother()`

Creates a new element (without saving it) based on this one.

This will be called by the “Save and add another” action on the element’s edit page.

Note that permissions don’t need to be considered here. The created element’s canSave() method will be called before saving.

View source

Returns

self, null

`createCondition()`

Since: 4.0.0

Returns an element condition for the element type.

View source

Returns

craft\elements\conditions\ElementConditionInterface

`defaultCardAttributes()`

Since: 5.5.0

Returns the list of card attribute keys that should be shown by default, if the field layout hasn't been customised.

This method should return an array where each element in the array maps to one of the keys of the array returned by cardAttributes().

View source

Returns

string[] – The card attribute keys

`defaultTableAttributes()`

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

This method should return an array where each element in the array maps to one of the keys of the array returned by tableAttributes().

View source

Arguments

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

Returns

string[] – The table attribute keys

`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
createElement (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

php

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

View source

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

`exporters()`

Since: 3.4.0

Returns the available export options for a given source.

The exporters can be represented by their fully qualified class name, a config array with the class name set to a type key, or by an instantiated element exporter object.

TIP

Element types that extend craft\base\Element should override craft\base\Element::defineExporters() instead of this method.

View source

Arguments

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

Returns

array – The available element exporters.

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

`fieldLayouts()`

Since: 3.5.0

Returns all the field layouts associated with elements from the given source.

This is used to determine which custom fields should be included in the element index sort menu, and other things.

View source

Arguments

$source (string, null) – The selected source’s key, or null if all known field layouts should be returned

Returns

craft\models\FieldLayout[]

`fields()`

Returns the list of fields that should be returned by default by toArray() when no specific fields are specified.

A field is a named element in the returned array by toArray().

This method should return an array of field names or field definitions. If the former, the field name will be treated as an object property name whose value will be used as the field value. If the latter, the array key should be the field name while the array value should be the corresponding field definition which can be either an object property name or a PHP callable returning the corresponding field value. The signature of the callable should be:

php

function ($model, $field) {
    // return field value
}

For example, the following code declares four fields:

email: the field name is the same as the property name email;
firstName and lastName: the field names are firstName and lastName, and their values are obtained from the first_name and last_name properties;
fullName: the field name is fullName. Its value is obtained by concatenating first_name and last_name.

php

return [
    'email',
    'firstName' => 'first_name',
    'lastName' => 'last_name',
    'fullName' => function () {
        return $this->first_name . ' ' . $this->last_name;
    },
];

In this method, you may also want to return different lists of fields based on some context information. For example, depending on the privilege of the current application user, you may return different sets of visible fields or filter out some fields.

The default implementation of this method returns the public object member variables indexed by themselves.

View source

Returns

array – The list of field names or field definitions.

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

php

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

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

php

class Product extends Element
{
    public static function find(): 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,

php

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

View source

Returns

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

`findAll()`

Returns a list of elements that match the specified ID(s) or a set of element criteria parameters.

The method accepts:

an int: query by a single ID value and return an array containing the corresponding element (or an empty array if not found).
an array of integers: query by a list of ID values and return the corresponding elements (or an empty array if none was found). Note that an empty array will result in an empty result as it will be interpreted as a search for primary keys and not an empty set of element criteria parameters.
an array of name-value pairs: query by a set of parameter values and return an array of elements matching all of them (or an empty array if none was found).

Note that this method will automatically call the all() method and return an array of \craft\base\Element instances. For example,

php

// find the entries whose ID is 10
$entries = Entry::findAll(10);
// the above code is equivalent to:
$entries = Entry::find()->id(10)->all();
// find the entries whose ID is 10, 11 or 12.
$entries = Entry::findAll([10, 11, 12]);
// the above code is equivalent to:
$entries = Entry::find()->id([10, 11, 12]])->all();
// find users whose email ends in "example.com"
$users = User::findAll(['email' => '*example.com']);
// the above code is equivalent to:
$users = User::find()->email('*example.com')->all();

View source

Arguments

$criteria (mixed) – The element ID, an array of IDs, or a set of element criteria parameters

Returns

static[] – An array of Element instances, or an empty array if nothing matches.

`findOne()`

Returns a single element instance by a primary key or a set of element criteria parameters.

The method accepts:

an int: query by a single ID value and return the corresponding element (or null if not found).
an array of name-value pairs: query by a set of parameter values and return the first element matching all of them (or null if not found).

Note that this method will automatically call the one() method and return an \craft\base\Element instance. For example,

php

// find a single entry whose ID is 10
$entry = Entry::findOne(10);
// the above code is equivalent to:
$entry = Entry::find->id(10)->one();
// find the first user whose email ends in "example.com"
$user = User::findOne(['email' => '*example.com']);
// the above code is equivalent to:
$user = User::find()->email('*example.com')->one();

View source

Arguments

$criteria (mixed) – The element ID or a set of element criteria parameters

Returns

static, null – Element instance matching the condition, or null if nothing matches.

`findSource()`

Since: 4.4.0

Returns a source definition by a given source key/path and context.

View source

Arguments

$sourceKey (string)
$context (string, null)

Returns

array, null

`get()`

View source

Arguments

$id

`getActionMenuItems()`

View source

`getAdditionalButtons()`

Since: 4.0.0

Returns additional buttons that should be shown at the top of the element’s edit page.

View source

Returns

string

`getAncestors()`

Returns the element’s ancestors.

View source

Arguments

$dist (integer, null)

Returns

craft\elements\db\ElementQueryInterface, craft\elements\ElementCollection

`getAttributeHtml()`

Since: 5.0.0

Returns the HTML that should be shown for a given attribute in table and card views.

TIP

Element types that extend craft\base\Element should override craft\base\Element::attributeHtml() instead of this method.

View source

Arguments

$attribute (string) – The attribute name.

Returns

string – The HTML that should be shown for a given attribute in table and card views.

`getAttributeLabel()`

Returns the text label for the specified attribute.

View source

Arguments

$attribute (string) – The attribute name

Returns

string – The attribute label

`getAttributeStatus()`

Since: 3.4.0

Returns the status of a given attribute.

View source

Arguments

$attribute (string)

`getCacheTags()`

Since: 3.5.0

Returns the cache tags that should be cleared when this element is saved.

View source

Returns

string[]

`getCanonical()`

Since: 3.7.0

Returns the canonical version of the element.

If this is a draft or revision, the canonical element will be returned.

View source

Arguments

$anySite (boolean) – Whether the canonical element can be retrieved in any site

Returns

self

`getCanonicalId()`

Since: 3.7.0

Returns the element’s canonical ID.

If this is a draft or revision, the canonical element’s ID will be returned.

View source

Returns

integer, null

`getCanonicalUid()`

Since: 3.7.11

Returns the element’s canonical UUID.

If this is a draft or revision, the canonical element’s UUID will be returned.

View source

Returns

string, null

`getCardBodyHtml()`

Since: 5.0.0

Returns the body HTML for element cards.

View source

Returns

string, null

`getChildren()`

Returns the element’s children.

View source

Returns

craft\elements\db\ElementQueryInterface, craft\elements\ElementCollection

`getChipLabelHtml()`

Since: 5.0.0

Returns the label HTML for element chips.

View source

Returns

string

`getCpEditUrl()`

View source

`getCpRevisionsUrl()`

Since: 4.4.0

Returns the element’s revisions index URL in the control panel.

View source

Returns

string, null

`getCrumbs()`

Since: 5.0.0

Returns the breadcrumbs that lead up to the element.

Returns

array

`getCurrentRevision()`

Since: 3.2.0

Returns the element’s current revision, if one exists.

View source

Returns

self, null

`getDescendants()`

Returns the element’s descendants.

View source

Arguments

$dist (integer, null)

Returns

craft\elements\db\ElementQueryInterface, craft\elements\ElementCollection

`getDirtyAttributes()`

Since: 3.4.0

Returns a list of attribute names that have changed since the element was first loaded.

View source

Returns

string[]

`getDirtyFields()`

Since: 3.4.0

Returns a list of custom field handles that have changed since the element was first loaded.

View source

Returns

string[]

`getEagerLoadedElementCount()`

Since: 3.4.0

Returns the count of eager-loaded elements for a given handle.

View source

Arguments

$handle (string) – The handle of the eager-loaded elements

Returns

integer, null – The eager-loaded element count, or null if it hadn't been eager-loaded

`getEagerLoadedElements()`

Returns the eager-loaded elements for a given handle.

View source

Arguments

$handle (string) – The handle of the eager-loaded elements

Returns

craft\elements\ElementCollection, null – The eager-loaded elements, or null if they hadn't been eager-loaded

`getEnabledForSite()`

Since: 3.4.0

Returns whether the element is enabled for the current site.

This can also be set to an array of site ID/site-enabled mappings.

View source

Arguments

$siteId (integer, null) – The ID of the site to return for. If null, the current site status will be returned.

Returns

boolean, null – Whether the element is enabled for the given site. null will be returned if a $siteId was passed, but that site’s status wasn’t provided via setEnabledForSite().

`getFieldContext()`

Returns the field context this element’s content uses.

View source

Returns

string

`getFieldLayout()`

Returns the field layout used by this element.

View source

Returns

craft\models\FieldLayout, null

`getFieldParamNamespace()`

Returns the namespace used by custom field params on the request.

View source

Returns

string, null – The field param namespace

`getFieldValue()`

Returns the value for a given field.

View source

Arguments

$fieldHandle (string) – The field handle whose value needs to be returned

Returns

mixed – The field value

Throws

craft\errors\InvalidFieldException
if the element doesn’t have a field with the handle specified by $fieldHandle

`getFieldValues()`

Returns the element’s normalized custom field values, indexed by their handles.

View source

Arguments

$fieldHandles (string[], null) – The list of field handles whose values need to be returned. Defaults to null, meaning all fields’ values will be returned. If it is an array, only the fields in the array will be returned.

Returns

array – The field values (handle => value)

`getGqlTypeName()`

Since: 3.3.0

Returns the GraphQL type name for this element type.

View source

Returns

string

`getHasDescendants()`

Returns whether the element has descendants.

View source

Returns

boolean

`getHtmlAttributes()`

Returns any attributes that should be included in the element’s chips and cards.

The attribute HTML will be rendered with yii\helpers\BaseHtml::renderTagAttributes().

TIP

Element types that extend craft\base\Element should override craft\base\Element::htmlAttributes() instead of this method.

View source

Arguments

$context (string) – The context that the element is being rendered in ('index', 'modal', 'field', or 'settings'.)

Returns

array

`getId()`

View source

`getInlineAttributeInputHtml()`

Since: 5.0.0

Returns the HTML that should be shown for a given attribute's inline editing input.

View source

Arguments

$attribute (string) – The attribute name.

Returns

string – The HTML that should be shown for the element input.

`getInvalidNestedElementIds()`

Since: 5.3.0

Returns the element’s invalid nested element IDs.

View source

Returns

integer[]

`getIsCanonical()`

Since: 3.7.0

Returns whether this is the canonical element.

View source

Returns

boolean

`getIsDerivative()`

Since: 3.7.0

Returns whether this is a derivative element, such as a draft or revision.

View source

Returns

boolean

`getIsDraft()`

Since: 3.2.0

Returns whether this is a draft.

View source

Returns

boolean

`getIsFresh()`

Since: 3.7.14

Returns whether the element is "fresh" (not yet explicitly saved, and without validation errors).

View source

Returns

boolean

`getIsHomepage()`

Since: 3.3.6

Returns whether this element represents the site homepage.

View source

Returns

boolean

`getIsRevision()`

Since: 3.2.0

Returns whether this is a revision.

View source

Returns

boolean

`getIsSlugTranslatable()`

Since: 4.5.0

Returns whether the Slug field should be shown as translatable in the UI.

Note this method has no effect on whether slugs will get copied over to other sites when the element is actually getting saved. That is determined by getSlugTranslationKey().

View source

Returns

boolean

`getIsTitleTranslatable()`

Since: 3.5.0

Returns whether the Title field should be shown as translatable in the UI.

Note this method has no effect on whether titles will get copied over to other sites when the element is actually getting saved. That is determined by getTitleTranslationKey().

View source

Returns

boolean

`getIsUnpublishedDraft()`

Since: 3.6.0

Returns whether the element is an unpublished draft.

View source

Returns

boolean

`getIterator()`

Returns an iterator for traversing the attributes in the model.

This method is required by the interface IteratorAggregate.

View source

Returns

ArrayIterator – An iterator for traversing the items in the list.

`getLanguage()`

Since: 3.5.0

Returns the language of the element.

View source

Returns

string

`getLink()`

Returns an anchor pre-filled with this element’s URL and title.

View source

Returns

\Twig\Markup, null

`getLocalized()`

Since: 3.5.0

Returns the same element in other locales.

View source

Returns

craft\elements\db\ElementQueryInterface, craft\elements\ElementCollection

`getMetadata()`

Since: 3.7.0

Returns element metadata that should be shown within the editor sidebar.

View source

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.

`getModifiedAttributes()`

Since: 3.7.0

Returns the attribute names that have changed for this element.

View source

Returns

string[]

`getModifiedFields()`

Since: 3.7.0

Returns the field handles that have changed for this element.

View source

Arguments

$anySite (boolean) – Whether to check for fields that have changed across any site

Returns

string[]

`getNext()`

Returns the next element relative to this one, from a given set of criteria.

View source

Arguments

$criteria (mixed)

Returns

self, null

`getNextSibling()`

Returns the element’s next sibling.

View source

Returns

self, null

`getOutdatedAttributes()`

Since: 3.7.0

Returns the attribute names that have been updated on the canonical element since the last time it was merged into this element.

View source

Returns

string[]

`getOutdatedFields()`

Since: 3.7.0

Returns the field handles that have been updated on the canonical element since the last time it was merged into this element.

View source

Returns

string[]

`getParent()`

Returns the element’s parent.

View source

Returns

self, null

`getParentId()`

Since: 4.0.0

Returns the parent ID.

View source

Returns

integer, null

`getParentUri()`

Returns the parent element’s URI, if there is one.

If the parent’s URI is __home__ (the homepage URI), then null will be returned.

View source

Returns

string, null

`getPostEditUrl()`

Since: 4.0.0

Returns the URL that users should be redirected to after editing the element.

View source

Returns

string, null

`getPrev()`

Returns the previous element relative to this one, from a given set of criteria.

View source

Arguments

$criteria (mixed)

Returns

self, null

`getPrevSibling()`

Returns the element’s previous sibling.

View source

Returns

self, null

`getPreviewTargets()`

Since: 3.2.0

Returns the additional locations that should be available for previewing the element, besides its primary URL.

Each target should be represented by a sub-array with the following keys:

label – What the preview target will be called in the control panel.
url – The URL that the preview target should open.
refresh – Whether preview frames should be automatically refreshed when content changes (true by default).

TIP

Element types that extend craft\base\Element should override craft\base\Element::previewTargets() instead of this method.

View source

Returns

array

`getRef()`

Returns the reference string to this element.

View source

Returns

string, null

`getRootOwner()`

Since: 5.4.0

Returns the root owner element.

View source

Returns

self

`getRoute()`

Returns the route that should be used when the element’s URI is requested.

TIP

Element types that extend craft\base\Element should override craft\base\Element::route() instead of this method.

View source

Returns

mixed – The route that the request should use, or null if no special action should be taken

`getSearchKeywords()`

Returns the search keywords for a given search attribute.

View source

Arguments

$attribute (string)

Returns

string

`getSerializedFieldValues()`

Returns an array of the element’s serialized custom field values, indexed by their handles.

View source

Arguments

$fieldHandles (string[], null) – The list of field handles whose values need to be returned. Defaults to null, meaning all fields’ values will be returned. If it is an array, only the fields in the array will be returned.

Returns

array

`getSiblings()`

Returns all of the element’s siblings.

View source

Returns

craft\elements\db\ElementQueryInterface, craft\elements\ElementCollection

`getSidebarHtml()`

Since: 3.7.0

Returns the HTML for any fields/info that should be shown within the editor sidebar.

View source

Arguments

$static (boolean) – Whether any fields within the sidebar should be static (non-interactive)

Returns

string

`getSite()`

Returns the site the element is associated with.

View source

Returns

craft\models\Site

Throws

yii\base\InvalidConfigException
if siteId is invalid

`getSlugTranslationDescription()`

Since: 4.5.0

Returns the description of the Slug field’s translation support.

View source

Returns

string, null

`getSlugTranslationKey()`

Since: 4.5.0

Returns the Slug’s translation key.

When saving an element on a multi-site Craft install, if $propagate is true for craft\services\Elements::saveElement(), then getSlugTranslationKey() will be called for each site the element should be propagated to. If the method returns the same value as it did for the initial site, then the initial site’s slug will be copied over to the target site.

View source

Returns

string – The translation key

`getSourceId()`

DEPRECATED

Deprecated in 3.7.0. Use getCanonicalId() instead.

Since: 3.2.0

Returns the element’s canonical ID.

View source

Returns

integer, null

`getSourceUid()`

DEPRECATED

Deprecated in 3.7.0. Use getCanonicalUid() instead.

Since: 3.2.0

Returns the element’s canonical UID.

View source

Returns

string

`getStatus()`

View source

`getSupportedSites()`

Returns the sites this element is associated with.

The function can either return an array of site IDs, or an array of sub-arrays, each with the following keys:

siteId (integer) - The site ID
propagate (boolean) – Whether the element should be propagated to this site on save (true by default)
enabledByDefault (boolean) – Whether the element should be enabled in this site by default (true by default)

View source

Returns

array

`getThumbHtml()`

View source

Arguments

$size

`getTitleTranslationDescription()`

Since: 3.5.0

Returns the description of the Title field’s translation support.

View source

Returns

string, null

`getTitleTranslationKey()`

Since: 3.5.0

Returns the Title’s translation key.

When saving an element on a multi-site Craft install, if $propagate is true for craft\services\Elements::saveElement(), then getTitleTranslationKey() will be called for each site the element should be propagated to. If the method returns the same value as it did for the initial site, then the initial site’s title will be copied over to the target site.

View source

Returns

string – The translation key

`getTotalDescendants()`

Returns the total number of descendants that the element has.

View source

Returns

integer

`getUiLabel()`

View source

`getUiLabelPath()`

Since: 4.4.0

Returns any path segment labels that should be prepended to the element’s UI label.

View source

Returns

string[]

`getUriFormat()`

Returns the URI format used to generate this element’s URI.

Note that element types that can have URIs must return true from hasUris().

View source

Returns

string, null

`getUrl()`

Returns the element’s full URL.

View source

Returns

string, null

`gqlScopesByContext()`

Since: 3.3.0

Returns the GraphQL scopes required by element’s context.

View source

Arguments

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

Returns

array

`hasDrafts()`

Since: 5.0.0

Returns whether element indexes should show the “Drafts” status option.

View source

Returns

boolean

`hasEagerLoadedElements()`

Returns whether elements have been eager-loaded with a given handle.

View source

Arguments

$handle (string) – The handle of the eager-loaded elements

Returns

boolean – Whether elements have been eager-loaded with the given handle

`hasRevisions()`

Since: 4.0.0

Returns whether revisions should be created when this element is saved.

View source

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.

`hasThumbs()`

Since: 5.0.0

Returns whether element indexes should include a thumbnail view by default.

View source

Returns

boolean

`hasTitles()`

Returns whether elements of this type have traditional titles.

View source

Returns

boolean – Whether elements of this type have traditional titles.

`hasUris()`

Returns whether elements of this type can have their own slugs and URIs.

Note that individual elements must also return a URI format from getUriFormat() if they are to actually get a URI.

View source

Returns

boolean – Whether elements of this type can have their own slugs and URIs.

`indexElementCount()`

Since: 4.4.0

Returns the total number of elements that will be shown on an element index, for the given element query.

View source

Arguments

$elementQuery (craft\elements\db\ElementQueryInterface)
$sourceKey (string, null)

Returns

integer

`indexHtml()`

Returns the element index HTML.

View source

Arguments

$elementQuery (craft\elements\db\ElementQueryInterface)
$disabledElementIds (integer[], null)
$viewState (array)
$sourceKey (string, null)
$context (string, null)
$includeContainer (boolean)
$selectable (boolean)
$sortable (boolean)

Returns

string – The element index HTML

`indexViewModes()`

Since: 5.5.0

Returns the view modes available for the element type.

This method should return an array, where each item is a sub-array with the following keys:

mode – Name of the view mode
title – How this mode should be described to the user
icon – Icon representing this view mode
availableOnMobile - Whether the view mode is available on mobile devices (defaults to true)
structuresOnly – Whether the view mode should only be available for structured sources (defaults to false)

php

return [
    [
        'mode' => 'table',
        'title' => Craft::t('app', 'Display in a table'),
        'icon' => 'list',
        'availableOnMobile' => false,
    ],
];

View source

Returns

array – The view modes.

`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

`isAncestorOf()`

Returns whether this element is an ancestor of another one.

View source

Arguments

$element (self)

Returns

boolean

`isAttributeDirty()`

Since: 3.5.0

Returns whether an attribute has changed since the element was first loaded.

View source

Arguments

$name (string)

Returns

boolean

`isAttributeModified()`

Since: 3.7.0

Returns whether an attribute value has changed for this element.

View source

Arguments

$name (string)

Returns

boolean

`isAttributeOutdated()`

Since: 3.7.0

Returns whether an attribute value has fallen behind the canonical element’s value.

View source

Arguments

$name (string)

Returns

boolean

`isChildOf()`

Returns whether this element is a direct child of another one.

View source

Arguments

$element (self)

Returns

boolean

`isDescendantOf()`

Returns whether this element is a descendant of another one.

View source

Arguments

$element (self)

Returns

boolean

`isFieldDirty()`

Since: 3.4.0

Returns whether a custom field value has changed since the element was first loaded.

View source

Arguments

$fieldHandle (string)

Returns

boolean

`isFieldEmpty()`

Returns whether a field is empty.

View source

Arguments

$handle (string)

Returns

boolean

`isFieldModified()`

Since: 3.7.0

Returns whether a field value has changed for this element.

View source

Arguments

$fieldHandle (string)
$anySite (boolean) – Whether to check if the field has changed across any site

Returns

boolean

`isFieldOutdated()`

Since: 3.7.0

Returns whether a field value has fallen behind the canonical element’s value.

View source

Arguments

$fieldHandle (string)

Returns

boolean

`isLocalized()`

Returns whether elements of this type store content on a per-site basis.

If this returns true, the element’s getSupportedSites() method will be responsible for defining which sites its content should be stored in.

View source

Returns

boolean – Whether elements of this type store data on a per-site basis.

`isNextSiblingOf()`

Returns whether this element is the direct next sibling of another one.

View source

Arguments

$element (self)

Returns

boolean

`isParentOf()`

Returns whether this element is a direct parent of another one.

View source

Arguments

$element (self)

Returns

boolean

`isPrevSiblingOf()`

Returns whether this element is the direct previous sibling of another one.

View source

Arguments

$element (self)

Returns

boolean

`isSiblingOf()`

Returns whether this element is a sibling of another one.

View source

Arguments

$element (self)

Returns

boolean

`lowerDisplayName()`

Since: 3.3.17

Returns the lowercase version of displayName().

View source

Returns

string

`markAsClean()`

Since: 3.4.0

Resets the record of dirty attributes and fields.

View source

`markAsDirty()`

Since: 3.4.10

Marks all fields and attributes as dirty.

View source

`mergeCanonicalChanges()`

Since: 3.7.0

Merges changes from the canonical element into this one.

View source

`modifyCustomSource()`

Since: 4.5.0

Modifies a custom source’s config, before it’s returned by craft\services\ElementSources::getSources()

View source

Arguments

$config (array)

Returns

array

`offsetExists()`

Returns whether there is an element at the specified offset.

This method is required by the SPL interface ArrayAccess. It is implicitly called when you use something like isset($model[$offset]).

View source

Arguments

$offset (string) – The offset to check on.

Returns

boolean – Whether or not an offset exists.

`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

`prepareEditScreen()`

Since: 4.0.0

Prepares the response for the element’s Edit screen.

View source

Arguments

$response (yii\web\Response) – The response being prepared
$containerId (string) – The ID of the element editor’s container element

`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

`render()`

Since: 5.0.0

Renders the element using its partial template.

If no partial template exists for the element, its string representation will be output instead.

Arguments

$variables (array)

Returns

\Twig\Markup

Throws

`searchableAttributes()`

Defines which element attributes should be searchable.

This method should return an array of attribute names that can be accessed on your elements. craft\services\Search will call this method when it is indexing keywords for one of your elements, and for each attribute it returns, it will fetch the corresponding property’s value on the element. For example, if your elements have a “color” attribute which you want to be indexed, this method could return:

php

return ['color'];

Not only will the “color” attribute’s values start getting indexed, but users will also be able to search directly against that attribute’s values using this search syntax:

color:blue

There is no need for this method to worry about the ‘title’ or ‘slug’ attributes, or custom field handles; those are indexed automatically.

TIP

Element types that extend craft\base\Element should override craft\base\Element::defineSearchableAttributes() instead of this method.

View source

Returns

string[] – The element attributes that should be searchable

`setAttributesFromRequest()`

Sets the element’s attributes from an element editor submission.

View source

Arguments

$values (array) – The attribute values

`setCanonical()`

Since: 3.7.0

Sets the canonical version of the element.

View source

Arguments

$element (self)

`setCanonicalId()`

Since: 3.7.0

Sets the element’s canonical ID.

View source

Arguments

$canonicalId (integer, null)

`setDirtyAttributes()`

Since: 3.5.0

Sets the list of dirty attribute names.

View source

Arguments

$names (string[])
$merge (boolean) – Whether these attributes should be merged with existing dirty attributes

`setDirtyFields()`

Since: 4.5.0

Sets the list of dirty field handles.

View source

Arguments

$fieldHandles (string[])
$merge (boolean) – Whether these fields should be merged with existing dirty fields

`setEagerLoadedElementCount()`

Since: 3.4.0

Sets the count of eager-loaded elements for a given handle.

View source

Arguments

$handle (string) – The handle to load the elements with in the future
$count (integer) – The eager-loaded element count

`setEagerLoadedElements()`

Sets some eager-loaded elements on a given handle.

View source

Arguments

$handle (string) – The handle that was used to eager-load the elements
$elements (self[]) – The eager-loaded elements
$plan (craft\elements\db\EagerLoadPlan) – The eager-loading plan

`setEnabledForSite()`

Since: 3.4.0

Sets whether the element is enabled for the current site.

This can also be set to an array of site ID/site-enabled mappings.

View source

Arguments

$enabledForSite (boolean, boolean[])

`setFieldParamNamespace()`

Sets the namespace used by custom field params on the request.

View source

Arguments

$namespace (string) – The field param namespace

`setFieldValue()`

Sets the value for a given field.

View source

Arguments

$fieldHandle (string) – The field handle whose value needs to be set
$value (mixed) – The value to set on the field

`setFieldValueFromRequest()`

Since: 4.5.0

Sets the value for a given field. The value should have originated from post data.

View source

Arguments

$fieldHandle (string) – The field handle whose value needs to be set
$value (mixed) – The value to set on the field

Throws

craft\errors\InvalidFieldException
if $fieldHandle is an invalid field handle

`setFieldValues()`

Sets the element’s custom field values.

View source

Arguments

$values (array) – The custom field values (handle => value)

`setFieldValuesFromRequest()`

Sets the element’s custom field values, when the values have come from post data.

View source

Arguments

$paramNamespace (string) – The field param namespace

`setIsFresh()`

Since: 3.7.14

Sets whether the element is "fresh" (not yet explicitly saved, and without validation errors).

View source

Arguments

$isFresh (boolean)

`setLazyEagerLoadedElements()`

Sets whether the given eager-loaded element handles were eager-loaded lazily.

View source

Arguments

$handle (string) – The handle that was used to eager-load the elements
$value (boolean)

`setNext()`

Sets the default next element.

View source

Arguments

$element (self, false)

`setParent()`

Sets the element’s parent.

View source

Arguments

$parent (self, null)

`setParentId()`

Since: 4.0.0

Sets the parent ID.

View source

Arguments

$parentId (integer, integer[], string, false, null)

`setPrev()`

Sets the default previous element.

View source

Arguments

$element (self, false)

`setRevisionCreatorId()`

Since: 3.2.0

Sets the revision creator ID to be saved.

View source

Arguments

$creatorId (integer, null)

`setRevisionNotes()`

Since: 3.2.0

Sets the revision notes to be saved.

View source

Arguments

$notes (string, null)

`setUiLabel()`

Since: 3.6.3

Defines what the element should be called within the control panel.

View source

Arguments

$label (string, null)

`setUiLabelPath()`

Since: 4.4.0

Defines any path segment labels that should be prepended to the element’s UI label.

View source

Arguments

$path (string[])

`showStatusIndicator()`

Since: 5.4.0

Returns whether chips and cards for this element should include a status indicator.

View source

Returns

boolean

`sortOptions()`

Returns the sort options for the element type.

This method should return an array, where each item is a sub-array with the following keys:

label – The sort option label
orderBy – An array, comma-delimited string, or a callback function that defines the columns to order the query by. If set to a callback function, the function will be passed two arguments: $dir (either SORT_ASC or SORT_DESC) and $db (a craft\db\Connection object), and it should return an array of column names or an yii\db\ExpressionInterface object.
attribute (optional) – The table attribute name that this option is associated with (required if orderBy is an array or more than one column name)
defaultDir (optional) – The default sort direction that should be used when sorting by this option (set to either asc or desc). Defaults to asc if not specified.

php

return [
    [
        'label' => Craft::t('app', 'Attribute Label'),
        'orderBy' => 'columnName',
        'attribute' => 'attributeName',
        'defaultDir' => 'asc',
    ],
];

A shorthand syntax is also supported, if there is no corresponding table attribute, or the table attribute has the exact same name as the column.

php

return [
    'columnName' => Craft::t('app', 'Attribute Label'),
];

Note that this method will only get called once for the entire index; not each time that a new source is selected.

View source

Returns

array – The attributes that elements can be sorted by

`sourcePath()`

Since: 4.4.12

Returns the source path for a given source key, step key, and context.

View source

Arguments

$sourceKey (string)
$stepKey (string)
$context (string, null)

Returns

array[], null

`sources()`

Returns the source definitions that elements of this type may belong to.

This defines what will show up in the source list on element indexes and element selector modals.

Each item in the array should be set to an array that has the following keys:

key – The source’s key. This is the string that will be passed into the $source argument of actions(), indexHtml(), and defaultTableAttributes().
label – The human-facing label of the source.
status – The status color that should be shown beside the source label. Possible values include green, orange, red, yellow, pink, purple, blue, turquoise, light, grey, black, and white. (Optional)
badgeCount – The badge count that should be displayed alongside the label. (Optional)
badgeLabel – The badge count label that should be provided for screen readers. (Optional)
sites – An array of site IDs or UUIDs that the source should be shown for, on multi-site element indexes. (Optional; by default the source will be shown for all sites.)
criteria – An array of element criteria parameters that the source should use when the source is selected. (Optional)
data – An array of data-X attributes that should be set on the source’s <a> tag in the source list’s, HTML, where each key is the name of the attribute (without the “data-” prefix), and each value is the value of the attribute. (Optional)
defaultSort – A string identifying the sort attribute that should be selected by default, or an array where the first value identifies the sort attribute, and the second determines which direction to sort by. (Optional)
defaultFilter – An element condition instance or config, which should be used by default when the source is first selected.
hasThumbs – A bool that defines whether this source supports Thumbs View. (Use your element’s \craft\base\getThumbUrl() method to define your elements’ thumb URL.) (Optional)
structureId – The ID of the Structure that contains the elements in this source. If set, Structure View will be available to this source. (Optional)
newChildUrl – The URL that should be loaded when a user selects the “New child” menu option on an element in this source while it is in Structure View. (Optional)
nested – An array of sources that are nested within this one. Each nested source can have the same keys as top-level sources.

TIP

Element types that extend craft\base\Element should override craft\base\Element::defineSources() instead of this method.

View source

Arguments

$context (string) – The context ('index', 'modal', 'field', or 'settings').

Returns

array – The sources.

`statuses()`

View source

`tableAttributes()`

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

This method should return an array whose keys represent element attribute names, and whose values make up the table’s column headers.

View source

Returns

array – The table attributes.

`toArray()`

Converts the model into an array.

This method will first identify which fields to be included in the resulting array by calling resolveFields(). It will then turn the model into an array with these fields. If $recursive is true, any embedded objects will also be converted into arrays. When embedded objects are \craft\base\Arrayable, their respective nested fields will be extracted and passed to toArray().

If the model implements the \craft\base\Linkable interface, the resulting array will also have a _link element which refers to a list of links as specified by the interface.

View source

Arguments

$fields (array) – The fields being requested. If empty or if it contains '*', all fields as specified by fields() will be returned. Fields can be nested, separated with dots (.). e.g.: item.field.sub-field $recursive must be true for nested fields to be extracted. If $recursive is false, only the root fields will be extracted.
$expand (array) – The additional fields being requested for exporting. Only fields declared in extraFields() will be considered. Expand can also be nested, separated with dots (.). e.g.: item.expand1.expand2 $recursive must be true for nested expands to be extracted. If $recursive is false, only the root expands will be extracted.
$recursive (boolean) – Whether to recursively return array representation of embedded objects.

Returns

array – The array representation of the object

`trackChanges()`

Since: 3.4.0

Returns whether Craft should keep track of attribute and custom field changes made to this element type, including when the last time they were changed, and who was logged-in at the time.

View source

Returns

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

`validate()`

Performs the data validation.

This method executes the validation rules applicable to the current scenario. The following criteria are used to determine whether a rule is currently applicable:

the rule must be associated with the attributes relevant to the current scenario;
the rules must be effective for the current scenario.

This method will call beforeValidate() and afterValidate() before and after the actual validation, respectively. If beforeValidate() returns false, the validation will be cancelled and afterValidate() will not be called.

Errors found during the validation can be retrieved via getErrors(), getFirstErrors() and getFirstError().

View source

Arguments

$attributeNames (string[], string, null) – Attribute name or list of attribute names that should be validated. If this parameter is empty, it means any attribute listed in the applicable validation rules should be validated.
$clearErrors (boolean) – Whether to call clearErrors() before performing validation

Returns

boolean – Whether the validation is successful without any error.

Throws

yii\base\InvalidArgumentException
if the current scenario is unknown.

`validateCustomFieldAttribute()`

Calls a custom validation function on a custom field.

This will be called by yii\validators\InlineValidator if a custom field specified a closure or the name of a class-level method as the validation type.

View source

Arguments

$attribute (string) – The field handle
$params (array, null)

Protected Methods

Method	Description
attributeHtml()	Returns the HTML that should be shown for a given attribute in table and card views.
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.
crumbs()	Returns the breadcrumbs that lead up to the element.
defineActions()	Defines the available bulk element actions for a given source.
defineBehaviors()	Returns the behaviors to attach to this class.
defineCardAttributes()	Defines all the available attributes that can be shown in card views along with their default placeholder values.
defineDefaultCardAttributes()	Returns the list of card attribute keys that should be shown by default.
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.
destructiveActionMenuItems()	Returns destructive action menu items for the element’s edit screens.
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.
hasCheckeredThumb()	Returns whether the element’s thumbnail should have a checkered background.
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.
hasRoundedThumb()	Returns whether the element’s thumbnail should be rounded.
htmlAttributes()	Returns any attributes that should be included in the element’s chips and cards.
includeSetStatusAction()	Returns whether the Set Status action should be included in actions() automatically.
indexElements()	Returns the resulting elements for an element index.
inlineAttributeInputHtml()	Returns the HTML that should be shown for a given attribute’s inline input.
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.
notesFieldHtml()	Returns the notes field HTML for the sidebar.
prepElementQueryForTableAttribute()	Prepares an element query for an element index that includes a given table attribute.
previewTargets()	Returns the additional locations that should be available for previewing the element, besides its primary URL.
resolveFields()	Determines which fields can be returned by toArray().
route()	Returns the route that should be used when the element’s URI is requested.
safeActionMenuItems()	Returns action menu items for the element’s edit screens.
searchKeywords()	Returns the search keywords for a given search attribute.
shouldValidateTitle()	Returns whether the element’s `title` attribute should be validated
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.
thumbAlt()	Returns alt text for the element’s thumbnail.
thumbSvg()	Returns the element’s thumbnail SVG contents, which should be used as a fallback when `\craft\base\getThumbUrl()` returns `null`.
thumbUrl()	Returns the URL to the element’s thumbnail, if it has one.
uiLabel()	Returns what the element should be called within the control panel.

`attributeHtml()`

Since: 5.0.0

Returns the HTML that should be shown for a given attribute in table and card views.

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

php

return match ($attribute) {
    'email' => $this->email ? Html::mailto(Html::encode($this->email)) : '',
    default => parent::attributeHtml($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\base\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 and card views.

Throws

yii\base\InvalidConfigException

`cacheTags()`

Since: 4.1.0

Returns the cache tags that should be cleared when this element is saved.

View source

Returns

string[]

`cpEditUrl()`

Since: 3.7.0

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

View source

Returns

string, null

`cpRevisionsUrl()`

Since: 4.4.0

Returns the element’s revisions index URL in the control panel.

View source

Returns

string, null

`crumbs()`

Since: 5.0.0

Returns the breadcrumbs that lead up to the element.

Returns

array

`defineActions()`

Defines the available bulk element actions for a given source.

Arguments

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

Returns

array – The available bulk element actions.

`defineBehaviors()`

Since: 4.0.0

Returns the behaviors to attach to this class.

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

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

View source

Returns

array

`defineCardAttributes()`

Since: 5.5.0

Defines all the available attributes that can be shown in card views along with their default placeholder values.

Returns

array – The card attributes.

`defineDefaultCardAttributes()`

Since: 5.5.0

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

See also:

View source

Returns

string[] – The card attributes.

`defineDefaultTableAttributes()`

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

See also:

View source

Arguments

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

Returns

string[] – The table attributes.

`defineExporters()`

Since: 3.4.0

Defines the available element exporters for a given source.

Arguments

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

Returns

array – The available element exporters

`defineFieldLayouts()`

Since: 3.5.0

Defines the field layouts associated with elements for a given source.

Arguments

$source (string, null) – The selected source’s key, or null if all known field layouts should be returned

Returns

craft\models\FieldLayout[] – The associated field layouts

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

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.

`destructiveActionMenuItems()`

Since: 5.0.0

Returns destructive action menu items for the element’s edit screens.

See craft\helpers\Cp::disclosureMenu() for documentation on supported item properties.

'destructive' => true will be automatically added to all returned items.

See also:

View source

Returns

array

`fieldByHandle()`

Returns the field with a given handle.

View source

Arguments

$handle (string)

Returns

craft\base\FieldInterface, null

`fieldLayoutFields()`

Returns each of this element’s fields.

View source

Arguments

$visibleOnly (boolean) – Whether to only return fields that are visible for this element

Returns

craft\base\FieldInterface[] – This element’s fields

`findByCondition()`

Finds Element instance(s) by the given condition.

This method is internally called by findOne() and findAll().

View source

Arguments

$criteria (mixed) – Refer to findOne() and findAll() for the explanation of this parameter
$one (boolean) – Whether this method is called by findOne() or findAll()

Returns

static, static[], null

`hasCheckeredThumb()`

Since: 5.0.0

Returns whether the element’s thumbnail should have a checkered background.

View source

Returns

boolean

`hasFieldLayout()`

Since: 3.7.0

Returns whether the element has a field layout with at least one tab.

View source

Returns

boolean – Returns whether the element has a field layout with at least one tab.

`hasNewParent()`

Returns whether the element has been assigned a new parent.

View source

Returns

boolean

`hasRoundedThumb()`

Since: 5.0.0

Returns whether the element’s thumbnail should be rounded.

View source

Returns

boolean

`htmlAttributes()`

Returns any attributes that should be included in the element’s chips and cards.

Arguments

$context (string) – The context that the element is being rendered in ('index', 'modal', 'field', or 'settings'.)

Returns

array

`includeSetStatusAction()`

Since: 4.3.2

Returns whether the Set Status action should be included in actions() automatically.

View source

Returns

boolean

`indexElements()`

Since: 4.4.0

Returns the resulting elements for an element index.

View source

Arguments

$elementQuery (craft\elements\db\ElementQueryInterface)
$sourceKey (string, null)

Returns

craft\base\ElementInterface[]

`inlineAttributeInputHtml()`

Since: 5.0.0

Returns the HTML that should be shown for a given attribute’s inline input.

Arguments

$attribute (string) – The attribute name.

Returns

string – The HTML that should be shown for a given attribute’s inline input.

`metaFieldsHtml()`

Since: 3.7.0

Returns the HTML for any meta fields that should be shown within the editor sidebar.

View source

Arguments

$static (boolean) – Whether the fields should be static (non-interactive)

Returns

string

`metadata()`

Since: 3.7.0

Returns element metadata that should be shown within the editor sidebar.

View source

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.

`normalizeFieldValue()`

Normalizes a field’s value.

View source

Arguments

$fieldHandle (string) – The field handle

Throws

craft\errors\InvalidFieldException
if the element doesn’t have a field with the handle specified by $fieldHandle

`notesFieldHtml()`

Since: 4.0.0

Returns the notes field HTML for the sidebar.

View source

Returns

string

`prepElementQueryForTableAttribute()`

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

View source

Arguments

$elementQuery (craft\elements\db\ElementQueryInterface)
$attribute (string)

`previewTargets()`

Since: 3.2.0

Returns the additional locations that should be available for previewing the element, besides its primary URL.

Each target should be represented by a sub-array with 'label' and 'url' keys.

Returns

array

`route()`

Returns the route that should be used when the element’s URI is requested.

Returns

string, array, null – The route that the request should use, or null if no special action should be taken

`safeActionMenuItems()`

Since: 5.0.0

Returns action menu items for the element’s edit screens.

See craft\helpers\Cp::disclosureMenu() for documentation on supported item properties.

See also:

View source

Returns

array

`searchKeywords()`

Since: 3.5.0

Returns the search keywords for a given search attribute.

View source

Arguments

$attribute (string)

Returns

string

`shouldValidateTitle()`

Since: 5.0.0

Returns whether the element’s title attribute should be validated

View source

Returns

boolean

`showStatusField()`

Since: 4.5.0

Returns whether the Status field should be shown for this element.

If set to false, the element’s status can't be updated via edit forms, the Set Status action, or resave/* commands.

View source

Returns

boolean

`slugFieldHtml()`

Since: 3.7.0

Returns the HTML for the element’s Slug field.

View source

Arguments

$static (boolean) – Whether the fields should be static (non-interactive)

Returns

string

`statusFieldHtml()`

Since: 4.0.0

Returns the status field HTML for the sidebar.

View source

Returns

string

`thumbAlt()`

Since: 5.0.0

Returns alt text for the element’s thumbnail.

View source

Returns

string, null

`thumbSvg()`

Since: 4.5.0

Returns the element’s thumbnail SVG contents, which should be used as a fallback when \craft\base\getThumbUrl() returns null.

View source

Returns

string, null

`thumbUrl()`

Since: 5.0.0

Returns the URL to the element’s thumbnail, if it has one.

View source

Arguments

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

Returns

string, null

`uiLabel()`

Since: 3.6.4

Returns what the element should be called within the control panel.

View source

Returns

string, null

Constants

Constant	Description
`HOMEPAGE_URI`
`SCENARIO_DEFAULT`	The name of the default scenario.
`SCENARIO_ESSENTIALS`
`SCENARIO_LIVE`
`STATUS_ARCHIVED`
`STATUS_DISABLED`
`STATUS_DRAFT`
`STATUS_ENABLED`

Events

EVENT_AFTER_DELETE

Type: yii\base\Event

The event that is triggered after the element is deleted.

EVENT_AFTER_MOVE_IN_STRUCTURE

DEPRECATED

Deprecated in 4.5.0. craft\services\Structures::EVENT_AFTER_INSERT_ELEMENT or EVENT_AFTER_MOVE_ELEMENT should be used instead.

Type: craft\events\ElementStructureEvent

The event that is triggered after the element is moved in a structure.

EVENT_AFTER_PROPAGATE

Type: craft\events\ModelEvent
Since: 3.2.0

The event that is triggered after the element is fully saved and propagated to other sites.

If you want to ignore events for drafts or revisions, call craft\helpers\ElementHelper::isDraftOrRevision() from your event handler:

php

use craft\base\Element;
use craft\elements\Entry;
use craft\events\ModelEvent;
use craft\helpers\ElementHelper;
use yii\base\Event;

Event::on(Entry::class, Element::EVENT_AFTER_PROPAGATE, function(ModelEvent $e) {
    // @var Entry $entry
    $entry = $e->sender;

    if (ElementHelper::isDraftOrRevision($entry) {
        return;
    }

    // ...
});

EVENT_AFTER_RESTORE

Type: yii\base\Event
Since: 3.1.0

The event that is triggered after the element is restored.

EVENT_AFTER_SAVE

Type: craft\events\ModelEvent

The event that is triggered after the element is saved.

If you want to ignore events for drafts or revisions, call craft\helpers\ElementHelper::isDraftOrRevision() from your event handler:

php

use craft\base\Element;
use craft\elements\Entry;
use craft\events\ModelEvent;
use craft\helpers\ElementHelper;
use yii\base\Event;

Event::on(Entry::class, Element::EVENT_AFTER_SAVE, function(ModelEvent $e) {
    // @var Entry $entry
    $entry = $e->sender;

    if (ElementHelper::isDraftOrRevision($entry)) {
        return;
    }

    // ...
});

EVENT_AUTHORIZE_CREATE_DRAFTS

DEPRECATED

Deprecated in 4.3.0. craft\services\Elements::EVENT_AUTHORIZE_CREATE_DRAFTS should be used instead.

Type: craft\events\AuthorizationCheckEvent
Since: 4.0.0

The event that is triggered when determining whether a user is authorized to create drafts for the element.

To authorize the user, set craft\events\AuthorizationCheckEvent::$authorized to true.

php

Event::on(
    Entry::class,
    Element::EVENT_AUTHORIZE_CREATE_DRAFTS,
    function(AuthorizationCheckEvent $event) {
        $event->authorized = true;
    }
);

EVENT_AUTHORIZE_DELETE

DEPRECATED

Deprecated in 4.3.0. craft\services\Elements::EVENT_AUTHORIZE_DELETE should be used instead.

Type: craft\events\AuthorizationCheckEvent
Since: 4.0.0

The event that is triggered when determining whether a user is authorized to delete the element.

To authorize the user, set craft\events\AuthorizationCheckEvent::$authorized to true.

php

Event::on(
    Entry::class,
    Element::EVENT_AUTHORIZE_DELETE,
    function(AuthorizationCheckEvent $event) {
        $event->authorized = true;
    }
);

EVENT_AUTHORIZE_DELETE_FOR_SITE

DEPRECATED

Deprecated in 4.3.0. craft\services\Elements::EVENT_AUTHORIZE_DELETE_FOR_SITE should be used instead.

Type: craft\events\AuthorizationCheckEvent
Since: 4.0.0

The event that is triggered when determining whether a user is authorized to delete the element for its current site.

To authorize the user, set craft\events\AuthorizationCheckEvent::$authorized to true.

php

Event::on(
    Entry::class,
    Element::EVENT_AUTHORIZE_DELETE_FOR_SITE,
    function(AuthorizationCheckEvent $event) {
        $event->authorized = true;
    }
);

EVENT_AUTHORIZE_DUPLICATE

DEPRECATED

Deprecated in 4.3.0. craft\services\Elements::EVENT_AUTHORIZE_DUPLICATE should be used instead.

Type: craft\events\AuthorizationCheckEvent
Since: 4.0.0

The event that is triggered when determining whether a user is authorized to duplicate the element.

To authorize the user, set craft\events\AuthorizationCheckEvent::$authorized to true.

php

Event::on(
    Entry::class,
    Element::EVENT_AUTHORIZE_DUPLICATE,
    function(AuthorizationCheckEvent $event) {
        $event->authorized = true;
    }
);

EVENT_AUTHORIZE_SAVE

DEPRECATED

Deprecated in 4.3.0. craft\services\Elements::EVENT_AUTHORIZE_SAVE should be used instead.

Type: craft\events\AuthorizationCheckEvent
Since: 4.0.0

The event that is triggered when determining whether a user is authorized to save the element in its current state.

To authorize the user, set craft\events\AuthorizationCheckEvent::$authorized to true.

php

Event::on(
    Entry::class,
    Element::EVENT_AUTHORIZE_SAVE,
    function(AuthorizationCheckEvent $event) {
        $event->authorized = true;
    }
);

EVENT_AUTHORIZE_VIEW

DEPRECATED

Deprecated in 4.3.0. craft\services\Elements::EVENT_AUTHORIZE_VIEW should be used instead.

Type: craft\events\AuthorizationCheckEvent
Since: 4.0.0

The event that is triggered when determining whether a user is authorized to view the element’s edit page.

To authorize the user, set craft\events\AuthorizationCheckEvent::$authorized to true.

php

Event::on(
    Entry::class,
    Element::EVENT_AUTHORIZE_VIEW,
    function(AuthorizationCheckEvent $event) {
        $event->authorized = true;
    }
);

EVENT_BEFORE_DEFINE_URL

Type: craft\events\DefineUrlEvent
Since: 4.4.6

The event that is triggered before defining the element’s URL.

It can be used to provide a custom URL, completely bypassing the default URL generation.

php

use craft\base\Element;
use craft\elements\Entry;
use craft\events\DefineUrlEvent;
use craft\helpers\UrlHelper;
use yii\base\Event;

Event::on(
    Entry::class,
    Element::EVENT_BEFORE_DEFINE_URL,
    function(DefineUrlEvent $e
) {
    // @var Entry $entry
    $entry = $e->sender;

    $event->url = '...';
});

To prevent the element from getting a URL, ensure $event->url is set to null, and set $event->handled to true.

Note that EVENT_DEFINE_URL will still be called regardless of what happens with this event.

EVENT_BEFORE_DELETE

Type: craft\events\ModelEvent

The event that is triggered before the element is deleted.

You may set yii\base\ModelEvent::$isValid to false to prevent the element from getting deleted.

EVENT_BEFORE_MOVE_IN_STRUCTURE

DEPRECATED

Deprecated in 4.5.0. craft\services\Structures::EVENT_BEFORE_INSERT_ELEMENT or EVENT_BEFORE_MOVE_ELEMENT should be used instead.

Type: craft\events\ElementStructureEvent

The event that is triggered before the element is moved in a structure.

You may set yii\base\ModelEvent::$isValid to false to prevent the element from getting moved.

EVENT_BEFORE_RESTORE

Type: craft\events\ModelEvent
Since: 3.1.0

The event that is triggered before the element is restored.

You may set yii\base\ModelEvent::$isValid to false to prevent the element from getting restored.

EVENT_BEFORE_SAVE

Type: craft\events\ModelEvent

The event that is triggered before the element is saved.

You may set yii\base\ModelEvent::$isValid to false to prevent the element from getting saved.

If you want to ignore events for drafts or revisions, call craft\helpers\ElementHelper::isDraftOrRevision() from your event handler:

php

use craft\base\Element;
use craft\elements\Entry;
use craft\events\ModelEvent;
use craft\helpers\ElementHelper;
use yii\base\Event;

Event::on(Entry::class, Element::EVENT_BEFORE_SAVE, function(ModelEvent $e) {
    // @var Entry $entry
    $entry = $e->sender;

    if (ElementHelper::isDraftOrRevision($entry)) {
        return;
    }

    // ...
});

Type: craft\events\DefineMenuItemsEvent
Since: 5.0.0

The event that is triggered when defining action menu items..

EVENT_DEFINE_ADDITIONAL_BUTTONS

Type: craft\events\DefineHtmlEvent
Since: 4.0.0

The event that is triggered when defining additional buttons that should be shown at the top of the element’s edit page.

EVENT_DEFINE_ATTRIBUTE_HTML

Type: craft\events\DefineAttributeHtmlEvent
Since: 5.0.0

The event that is triggered when defining an attribute’s HTML for table and card views.

EVENT_DEFINE_CACHE_TAGS

Type: craft\events\DefineValueEvent
Since: 4.1.0

The event that is triggered when defining the cache tags that should be cleared when this element is saved.

EVENT_DEFINE_EAGER_LOADING_MAP

Type: craft\events\DefineEagerLoadingMapEvent
Since: 3.1.0

The event that is triggered when defining an eager-loading map.

php

use craft\base\Element;
use craft\base\ElementInterface;
use craft\db\Query;
use craft\elements\Entry;
use craft\events\DefineEagerLoadingMapEvent;
use yii\base\Event;

// Add support for `with(['bookClub'])` to entries
Event::on(
    Entry::class,
    Element::EVENT_DEFINE_EAGER_LOADING_MAP,
    function(DefineEagerLoadingMapEvent $event) {
        if ($event->handle === 'bookClub') {
            $bookEntryIds = array_map(fn(ElementInterface $element) => $element->id, $event->elements);
            $event->elementType = \my\plugin\BookClub::class,
            $event->map = (new Query)
                ->select(['source' => 'bookId', 'target' => 'clubId'])
                ->from('{{%bookclub_books}}')
                ->where(['bookId' => $bookEntryIds])
                ->all();
            $event->handled = true;
        }
    }
);

EVENT_DEFINE_INLINE_ATTRIBUTE_INPUT_HTML

Type: craft\events\DefineAttributeHtmlEvent
Since: 5.0.0

The event that is triggered when defining an attribute’s inline input HTML.

EVENT_DEFINE_KEYWORDS

Type: craft\events\DefineAttributeKeywordsEvent
Since: 3.5.0

The event that is triggered when defining the search keywords for an element attribute.

Note that you must set yii\base\Event::$handled to true if you want the element to accept your custom $keywords value.

php

Event::on(
    craft\elements\Entry::class,
    craft\base\Element::EVENT_DEFINE_KEYWORDS,
    function(craft\events\DefineAttributeKeywordsEvent $e
) {
    // @var craft\elements\Entry $entry
    $entry = $e->sender;

    // Prevent entry titles in the Parts section from getting search keywords
    if ($entry->section->handle === 'parts' && $e->attribute === 'title') {
        $e->keywords = '';
        $e->handled = true;
    }
});

EVENT_DEFINE_METADATA

Type: craft\events\DefineMetadataEvent
Since: 3.7.0

The event that is triggered when defining the element’s metadata info.

EVENT_DEFINE_META_FIELDS_HTML

Type: craft\events\DefineHtmlEvent
Since: 3.7.0

The event that is triggered when defining the HTML for meta fields within the editor sidebar.

EVENT_DEFINE_URL

Type: craft\events\DefineUrlEvent
Since: 4.3.0

The event that is triggered when defining the element’s URL.

php

use craft\base\Element;
use craft\elements\Entry;
use craft\events\DefineUrlEvent;
use craft\helpers\UrlHelper;
use yii\base\Event;

Event::on(
    Entry::class,
    Element::EVENT_DEFINE_URL,
    function(DefineUrlEvent $e
) {
    // @var Entry $entry
    $entry = $e->sender;

    // Add a custom query string param to the URL
    if ($event->value !== null) {
        $event->url = UrlHelper::urlWithParams($event->url, [
            'foo' => 'bar',
        ]);
    }
});

To prevent the element from getting a URL, ensure $event->url is set to null, and set $event->handled to true.

EVENT_PREP_QUERY_FOR_TABLE_ATTRIBUTE

Type: craft\events\ElementIndexTableAttributeEvent
Since: 3.7.14

The event that is triggered when preparing an element query for an element index, for each attribute present in the table.

Paired with EVENT_REGISTER_TABLE_ATTRIBUTES and \craft\base\EVENT_SET_TABLE_ATTRIBUTE_HTML, this allows optimization of queries on element indexes.

php

use craft\base\Element;
use craft\elements\Entry;
use craft\events\DefineAttributeHtmlEvent;
use craft\events\PrepareElementQueryForTableAttributeEvent;
use craft\events\RegisterElementTableAttributesEvent;
use craft\helpers\Cp;
use yii\base\Event;

Event::on(
    Entry::class,
    Element::EVENT_REGISTER_TABLE_ATTRIBUTES,
    function(RegisterElementTableAttributesEvent $e) {
        $e->attributes[] = 'authorExpertise';
    }
);

Event::on(
    Entry::class,
    Element::EVENT_PREP_QUERY_FOR_TABLE_ATTRIBUTE,
    function(PrepareElementQueryForTableAttributeEvent $e) {
        $query = $e->query;
        $attr = $e->attribute;

        if ($attr === 'authorExpertise') {
            $query->andWith(['author.areasOfExpertiseCategoryField']);
        }
    }
);

Event::on(
    Entry::class,
    Element::EVENT_SET_TABLE_ATTRIBUTE_HTML,
    function(DefineAttributeHtmlEvent $e) {
        $attribute = $e->attribute;

        if ($attribute !== 'authorExpertise') {
            return;
        }

        // The field data is eager-loaded!
        $author = $e->sender->getAuthor();
        $categories = $author->areasOfExpertiseCategoryField;

        $e->html = Cp::elementPreviewHtml($categories);
    }
);

EVENT_REGISTER_ACTIONS

Type: craft\events\RegisterElementActionsEvent

The event that is triggered when registering the available bulk actions for the element type.

EVENT_REGISTER_CARD_ATTRIBUTES

Type: craft\events\RegisterElementCardAttributesEvent
Since: 5.5.0

The event that is triggered when registering the card attributes for the element type.

EVENT_REGISTER_DEFAULT_CARD_ATTRIBUTES

Type: craft\events\RegisterElementCardAttributesEvent
Since: 5.5.0

The event that is triggered when registering the card attributes for the element type.

EVENT_REGISTER_DEFAULT_TABLE_ATTRIBUTES

Type: craft\events\RegisterElementTableAttributesEvent

The event that is triggered when registering the table attributes for the element type.

EVENT_REGISTER_EXPORTERS

Type: craft\events\RegisterElementExportersEvent
Since: 3.4.0

The event that is triggered when registering the available exporters for the element type.

EVENT_REGISTER_FIELD_LAYOUTS

Type: craft\events\RegisterElementFieldLayoutsEvent
Since: 3.5.0

The event that is triggered when registering all of the field layouts associated with elements from a given source.

EVENT_REGISTER_HTML_ATTRIBUTES

Type: craft\events\RegisterElementHtmlAttributesEvent

The event that is triggered when registering the HTML attributes that should be included in the element’s DOM representation in the control panel.

EVENT_REGISTER_PREVIEW_TARGETS

Type: craft\events\RegisterPreviewTargetsEvent
Since: 3.2.0

The event that is triggered when registering the element’s preview targets.

EVENT_REGISTER_SEARCHABLE_ATTRIBUTES

Type: craft\events\RegisterElementSearchableAttributesEvent

The event that is triggered when registering the searchable attributes for the element type.

EVENT_REGISTER_SORT_OPTIONS

Type: craft\events\RegisterElementSortOptionsEvent

The event that is triggered when registering the sort options for the element type.

EVENT_REGISTER_SOURCES

Type: craft\events\RegisterElementSourcesEvent

The event that is triggered when registering the available sources for the element type.

EVENT_REGISTER_TABLE_ATTRIBUTES

Type: craft\events\RegisterElementTableAttributesEvent

The event that is triggered when registering the table attributes for the element type.

EVENT_SET_EAGER_LOADED_ELEMENTS

Type: craft\events\SetEagerLoadedElementsEvent
Since: 3.5.0

The event that is triggered when setting eager-loaded elements.

Set yii\base\Event::$handled to true to prevent the elements from getting stored to the private $_eagerLoadedElements array.

EVENT_SET_ROUTE

Type: craft\events\SetElementRouteEvent

The event that is triggered when defining the route that should be used when this element’s URL is requested.

Set yii\base\Event::$handled to true to explicitly tell the element that a route has been set (even if you’re setting it to null).

php

Event::on(craft\elements\Entry::class, craft\base\Element::EVENT_SET_ROUTE, function(craft\events\SetElementRouteEvent $e) {
    // @var craft\elements\Entry $entry
    $entry = $e->sender;

    if ($entry->uri === 'pricing') {
        $e->route = 'module/pricing/index';

        // Explicitly tell the element that a route has been set,
        // and prevent other event handlers from running, and tell
        $e->handled = true;
    }
});

mapper

utils

addresses

assets

categories

entries

tags

users

elements

mutations

elements

elements

mutations

elements

generators

input

criteria

elements

arrayable

components

controllers

elements

gql

models

serializable

admintable

assetindexes

authmethodsetup

axios

clearcaches

conditionbuilder

cp

craftsupport

d3

dashboard

datepickeri18n

dbbackup

deprecationerrors

editsection

edittransform

elementresizedetector

fabric

feed

fieldsettings

fileupload

findreplace

focalpoint

focusvisible

garnish

generalsettings

graphiql

htmx

iframeresizer

inputmask

installer

jquerypayment

jquerytouchevents

jqueryui

matrix

money

newusers

passkeysetup

picturefill

plugins

pluginstore

prismjs

queuemanager

recententries

recoverycodes

routes

selectize

sites

systemmessages