Skip to content

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, 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\Asset, craft\elements\Category, craft\elements\Entry, craft\elements\GlobalSet, craft\elements\MatrixBlock, craft\elements\Tag, craft\elements\User, craft\models\BaseEntryRevisionModel, craft\models\EntryDraft, craft\models\EntryVersion, craft\test\mockclasses\elements\ExampleElement
Since
3.0.0

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

View source

Public Properties

PropertyDescription
activeValidatorsyii\validators\Validator – The validators applicable to the current scenario.
ancestorscraft\elements\db\ElementQueryInterface – The element’s ancestors
archivedboolean – Whether the element is archived
attributesarray – Attribute values (name => value).
awaitingFieldValuesboolean – Whether the element is still awaiting its custom field values
behaviorsyii\base\Behavior – List of behaviors attached to this component.
cacheTagsstring[]
canonicalcraft\base\ElementInterface, null – The canonical element, if one exists for the current site
canonicalIdinteger, null – The element’s canonical ID
canonicalUidstring – The element’s canonical UID
childrencraft\elements\db\ElementQueryInterface – The element’s children
contentIdinteger, null – The element’s content row ID
contentTablestring – The name of the table this element’s content is stored in
cpEditUrlstring, null – The element’s edit URL in the control panel
currentRevisionstatic, null
dateCreatedDateTime, null – The date that the element was created
dateDeletedDateTime, null – The date that the element was trashed
dateLastMergedDateTime, null – The date that the canonical element was last merged into this one
dateUpdatedDateTime, null – The date that the element was last updated
descendantscraft\elements\db\ElementQueryInterface – The element’s descendants
dirtyAttributesstring[]
dirtyFieldsstring[]
draftIdinteger, null – The ID of the draft’s row in the drafts table
duplicateOfcraft\base\ElementInterface, null – The element that this element is being duplicated by.
editorHtmlstring – The HTML for the element’s editor HUD
enabledboolean – Whether the element is enabled
enabledForSiteboolean – Whether the element is enabled for this site
errorsarray – Errors for all attributes or the specified attribute.
fieldColumnPrefixstring – The field column prefix this element’s content uses
fieldContextstring – The field context this element’s content uses
fieldLayoutcraft\models\FieldLayout, null – The field layout used by this element
fieldLayoutIdinteger, null – The element’s field layout ID
fieldParamNamespacearray – The namespace used by custom field params on the request
fieldValuesarray – The element’s normalized custom field values, indexed by their handles
firstErrorsarray – The first errors.
firstSaveboolean – Whether the element is being saved for the first time in a normal state (not as a draft or revision).
gqlTypeNamestring
hardDeleteboolean – Whether the element is being hard-deleted.
hasCheckeredThumbboolean
hasDescendantsboolean – Whether the element has descendants
hasFreshContentboolean – Whether the element’s content is "fresh" (unsaved and without validation errors)
hasRoundedThumbboolean
htmlAttributesarray – Any attributes that should be included in the element’s DOM representation in the control panel
idinteger, null – The element’s ID
isCanonicalboolean
isDeletableboolean
isDerivativeboolean
isDraftboolean
isEditableboolean – Whether the current user can edit the element
isFreshboolean
isHomepageboolean
isNewForSiteboolean – Whether the element is being saved to the current site for the first time.
isProvisionalDraftboolean – Whether this is a provisional draft.
isRevisionboolean
isTitleTranslatableboolean
isUnpublishedDraftboolean
isUnsavedDraftboolean
iteratorArrayIterator – An iterator for traversing the items in the list.
languagestring
levelinteger, null – The element’s level within its structure
lftinteger, null – The element’s left position within its structure
link\Twig\Markup, null – An anchor pre-filled with this element’s URL and title
localizedcraft\elements\db\ElementQueryInterface[], static[]
mergingCanonicalChangesboolean – Whether recent changes to the canonical element are being merged into this element.
metadataarray – The data, with keys representing the labels.
modifiedAttributesstring[]
modifiedFieldsstring[]
newSiteIdsinteger[] – The site IDs that the element was just propagated to for the first time.
nextcraft\base\ElementInterface, null – The next element relative to this one, from a given set of criteria
nextSiblingcraft\base\ElementInterface, null – The element’s next sibling
outdatedAttributesstring[]
outdatedFieldsstring[]
parentcraft\base\ElementInterface, null – The element’s parent
parentUristring, null
prevcraft\base\ElementInterface, null – The previous element relative to this one, from a given set of criteria
prevSiblingcraft\base\ElementInterface, null – The element’s previous sibling
previewTargetsarray
previewingboolean – Whether the element is currently being previewed.
propagateAllboolean – Whether all element attributes should be propagated across all its supported sites, even if that means overwriting existing site-specific values.
propagatingboolean – Whether the element is being saved in the context of propagating another site's version of the element.
refstring, null – The reference string to this element
resavingboolean – Whether the element is being resaved by a ResaveElement job or a resave console command.
revisionIdinteger – The ID of the revision’s row in the revisions table
rgtinteger, null – The element’s right position within its structure
rootinteger, null – The element’s structure’s root ID
routemixed – The route that should be used when the element’s URI is requested
scenariostring – The scenario that this model is in.
searchScoreinteger, null – The element’s search score, if the craft\elements\db\ElementQuery::search() parameter was used when querying for the element
serializedFieldValuesarray – Array of the element’s serialized custom field values, indexed by their handles
siblingscraft\elements\db\ElementQueryInterface – All of the element’s siblings
sidebarHtmlstring
sitecraft\models\Site – Site the element is associated with
siteIdinteger, null – The site ID the element is associated with
siteSettingsIdinteger, null – The ID of the element’s record in the elements_sites table
slugstring, null – The element’s slug
sourceIdinteger, null
sourceUidstring
statusstring, null – The element’s status
structureIdinteger, null – The element’s structure ID
supportedSitesinteger[], array – The sites this element is associated with
tempIdstring, null – The element’s temporary ID (only used if the element's URI format contains {id})
titlestring, null – The element’s title
titleTranslationDescriptionstring, null
titleTranslationKeystring – The translation key
totalDescendantsinteger – The total number of descendants that the element has
trashedboolean – Whether the element has been soft-deleted.
uiLabelstring
uidstring, null – The element’s UID
updatingFromDerivativeboolean – Whether the element is being updated from a derivative element, such as a draft or revision.
uristring, null – The element’s URI
uriFormatstring, null – The URI format used to generate this element’s URL
urlstring, null – The element’s full URL
validatorsArrayObject, yii\validators\Validator – All the validators declared in the model.

ancestors

Type
craft\elements\db\ElementQueryInterface
Default value
null

The element’s ancestors

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

children

Type
craft\elements\db\ElementQueryInterface
Default value
null

The element’s children

View source

contentTable

Type
string
Default value
null

The name of the table this element’s content is stored in

View source

cpEditUrl

Type
string, null
Default value
null

The element’s edit URL in the control panel

View source

currentRevision

Type
static, 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
Access
Read-only
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

fieldColumnPrefix

Type
string
Default value
null

The field column prefix this element’s content uses

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

hasCheckeredThumb

Type
boolean
Default value
null
Access
Read-only
Since
3.5.5

View source

hasDescendants

Type
boolean
Default value
null

Whether the element has descendants

View source

hasFreshContent

Type
boolean
Default value
null

Whether the element’s content is "fresh" (unsaved and without validation errors)

View source

hasRoundedThumb

Type
boolean
Default value
null
Access
Read-only
Since
3.5.5

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

isCanonical

Type
boolean
Default value
null
Access
Read-only
Since
3.7.0

View source

isDeletable

Type
boolean
Default value
null
Access
Read-only
Since
3.5.12

View source

isDerivative

Type
boolean
Default value
null
Access
Read-only
Since
3.7.0

View source

isDraft

Type
boolean
Default value
null
Access
Read-only
Since
3.2.0

View source

isEditable

Type
boolean
Default value
null

Whether the current user can edit the element

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

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

isUnsavedDraft

Type
boolean
Default value
null
Access
Read-only
Since
3.2.0

View source

language

Type
string
Default value
null
Access
Read-only
Since
3.5.0

View source

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[], static[]
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

parentUri

Type
string, null
Default value
null
Access
Read-only

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

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

sidebarHtml

Type
string
Default value
null
Access
Read-only
Since
3.7.0

View source

site

Type
craft\models\Site
Default value
null

Site the element is associated with

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

Type
string
Default value
null
Since
3.2.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

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

revisionCreatorId

Type
string, null
Default value
null

Revision creator ID to be saved

See also setRevisionCreatorId()

View source

revisionNotes

Type
string, null
Default value
null

Revision notes to be saved

See also setRevisionNotes()

View source

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__clone()
__construct()Constructor.
__get()Returns the value of a component property.
__isset()Checks if a property is set.
__set()Sets the value of a component property.
__toString()Returns the string representation of the element.
__unset()Sets a component property to be null.
actions()Returns the available element actions for a given source.
activeAttributes()Returns the attribute names that are subject to validation in the current scenario.
addError()Adds a new error to the specified attribute.
addErrors()Adds a list of errors.
addModelErrors()Adds errors from another model, with a given attribute name prefix.
afterDelete()Performs actions after an element is deleted.
afterMoveInStructure()Performs actions after an element is moved within a structure.
afterPropagate()Performs actions after an element is fully saved and propagated to other sites.
afterRestore()Performs actions after an element is restored.
afterSave()Performs actions after an element is saved.
afterValidate()This method is invoked after validation ends.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
attributeHints()Returns the attribute hints.
attributeLabels()Returns the attribute labels.
attributes()Returns the list of attribute names.
beforeDelete()Performs actions before an element is deleted.
beforeMoveInStructure()Performs actions before an element is moved within a structure.
beforeRestore()Performs actions before an element is restored.
beforeSave()Performs actions before an element is saved.
beforeValidate()This method is invoked before validation starts.
behaviors()Returns a list of behaviors that this component should behave as.
canGetProperty()Returns a value indicating whether a property can be read.
canSetProperty()Returns a value indicating whether a property can be set.
className()Returns the fully qualified name of this class.
clearErrors()Removes errors for all attributes or a single attribute.
createValidators()Creates validator objects based on the validation rules specified in rules().
datetimeAttributes()Returns the names of any attributes that should hold DateTime values.
defaultTableAttributes()Returns the list of table attribute keys that should be shown by default.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
displayName()Returns the display name of this class.
eagerLoadingMap()Returns an array that maps source-to-target element IDs based on the given sub-property handle.
ensureBehaviors()Makes sure that the behaviors declared in behaviors() are attached to this component.
exporters()Returns the available export options for a given source.
extraFields()Returns the list of fields that can be expanded further and returned by toArray().
fieldLayouts()Returns all of the field layouts associated with elements from the given source.
fields()Returns the list of fields that should be returned by default by toArray() when no specific fields are specified.
find()Creates an craft\elements\db\ElementQueryInterface instance for query purpose.
findAll()Returns a list of elements that match the specified ID(s) or a set of element criteria parameters.
findOne()Returns a single element instance by a primary key or a set of element criteria parameters.
findSource()Returns a source definition by a given source key/path and context.
formName()Returns the form name that this model class should use.
generateAttributeLabel()Generates a user friendly attribute label based on the give attribute name.
getActiveValidators()Returns the validators applicable to the current scenario.
getAncestors()Returns the element’s ancestors.
getAttributeHint()Returns the text hint for the specified attribute.
getAttributeLabel()Returns the text label for the specified attribute.
getAttributeStatus()Returns the status of a given attribute.
getAttributes()Returns attribute values.
getBehavior()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
getCacheTags()Returns the cache tags that should be cleared when this element is saved.
getCanonical()Returns the canonical version of the element.
getCanonicalId()Returns the element’s canonical ID.
getCanonicalUid()Returns the element’s canonical UUID.
getChildren()Returns the element’s children.
getContentTable()Returns the name of the table this element’s content is stored in.
getCpEditUrl()Returns the element’s edit URL in the control panel.
getCurrentRevision()Returns the element’s current revision, if one exists.
getDescendants()Returns the element’s descendants.
getDirtyAttributes()Returns a list of attribute names that have changed since the element was first loaded.
getDirtyFields()Returns a list of custom field handles that have changed since the element was first loaded.
getEagerLoadedElementCount()Returns the count of eager-loaded elements for a given handle.
getEagerLoadedElements()Returns the eager-loaded elements for a given handle.
getEditorHtml()Returns the HTML for the element’s editor slideout.
getEnabledForSite()Returns whether the element is enabled for the current site.
getError()Returns the first error of the specified attribute.
getErrorSummary()Returns the errors for all attributes as a one-dimensional array.
getErrors()Returns the errors for all attributes or a single attribute.
getFieldColumnPrefix()Returns the field column prefix this element’s content uses.
getFieldContext()Returns the field context this element’s content uses.
getFieldLayout()Returns the field layout used by this element.
getFieldParamNamespace()Returns the namespace used by custom field params on the request.
getFieldStatus()Returns the status of a given field.
getFieldValue()Returns the value for a given field.
getFieldValues()Returns the element’s normalized custom field values, indexed by their handles.
getFirstError()Returns the first error of the specified attribute.
getFirstErrors()Returns the first error of every attribute in the model.
getGqlTypeName()Returns the GraphQL type name for this element type.
getHasCheckeredThumb()Returns whether the element’s thumbnail should have a checkered background.
getHasDescendants()Returns whether the element has descendants.
getHasFreshContent()Returns whether the element is "fresh" (not yet explicitly saved, and without validation errors).
getHasRoundedThumb()Returns whether the element’s thumbnail should be rounded.
getHtmlAttributes()Returns any attributes that should be included in the element’s DOM representation in the control panel.
getId()
getIsCanonical()Returns whether this is the canonical element.
getIsDeletable()Returns whether the current user can delete the element.
getIsDerivative()Returns whether this is a derivative element, such as a draft or revision.
getIsDraft()Returns whether this is a draft.
getIsEditable()Returns whether the current user can edit the element.
getIsFresh()Returns whether the element is "fresh" (not yet explicitly saved, and without validation errors).
getIsHomepage()Returns whether this element represents the site homepage.
getIsProvisionalDraft()Returns whether this is a provisional draft.
getIsRevision()Returns whether this is a revision.
getIsTitleTranslatable()Returns whether the Title field should be shown as translatable in the UI.
getIsUnpublishedDraft()Returns whether the element is an unpublished draft.
getIsUnsavedDraft()Returns whether the element is an unpublished draft.
getIterator()Returns an iterator for traversing the attributes in the model.
getLanguage()Returns the language of the element.
getLink()Returns an anchor pre-filled with this element’s URL and title.
getLocalized()Returns the same element in other locales.
getMetadata()Returns element metadata that can be shown on its edit page or within element editor slideouts.
getModifiedAttributes()Returns the attribute names that have changed for this element.
getModifiedFields()Returns the field handles that have changed for this element.
getNext()Returns the next element relative to this one, from a given set of criteria.
getNextSibling()Returns the element’s next sibling.
getOutdatedAttributes()Returns the attribute names that have been updated on the canonical element since the last time it was merged into this element.
getOutdatedFields()Returns the field handles that have been updated on the canonical element since the last time it was merged into this element.
getParent()Returns the element’s parent.
getParentUri()Returns the parent element’s URI, if there is one.
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.
getRoute()Returns the route that should be used when the element’s URI is requested.
getScenario()Returns the scenario that this model is used in.
getSearchKeywords()Returns the search keywords for a given search attribute.
getSerializedFieldValues()Returns an array of the element’s serialized custom field values, indexed by their handles.
getSiblings()Returns all of the element’s siblings.
getSidebarHtml()Returns the HTML for any fields/info that should be shown within the sidebar of element editor slideouts.
getSite()Returns the site the element is associated with.
getSourceId()Returns the element’s canonical ID.
getSourceUid()Returns the element’s canonical UID.
getStatus()Returns the element’s status.
getSupportedSites()Returns the sites this element is associated with.
getTableAttributeHtml()Returns the HTML that should be shown for a given attribute in Table View.
getThumbUrl()Returns the URL to the element’s thumbnail, if there is one.
getTitleTranslationDescription()Returns the description of the Title field’s translation support.
getTitleTranslationKey()Returns the Title’s translation key.
getTotalDescendants()Returns the total number of descendants that the element has.
getUiLabel()Returns what the element should be called within the control panel.
getUriFormat()Returns the URI format used to generate this element’s URI.
getUrl()Returns the element’s full URL.
getValidators()Returns all the validators declared in rules().
gqlMutationNameByContext()Returns the GraphQL mutation name by an element's context.
gqlScopesByContext()Returns the GraphQL scopes required by element's context.
gqlTypeNameByContext()Returns the GraphQL type name by an element's context.
hasContent()Returns whether elements of this type will be storing any data in the content table (titles or custom fields).
hasEagerLoadedElements()Returns whether elements have been eager-loaded with a given handle.
hasErrors()Returns a value indicating whether there is any validation error.
hasEventHandlers()Returns a value indicating whether there is any handler attached to the named event.
hasMethod()Returns a value indicating whether a method is defined.
hasProperty()Returns a value indicating whether a property is defined for this component.
hasStatuses()Returns whether elements of this type have statuses.
hasTitles()Returns whether elements of this type have traditional titles.
hasUris()Returns whether elements of this type can have their own slugs and URIs.
indexElementCount()Returns the total number of elements that will be shown on an element index, for the given element query.
indexHtml()Returns the element index HTML.
init()Initializes the object.
instance()Returns static class instance, which can be used to obtain meta information.
isAncestorOf()Returns whether this element is an ancestor of another one.
isAttributeActive()Returns a value indicating whether the attribute is active in the current scenario.
isAttributeDirty()Returns whether an attribute has changed since the element was first loaded.
isAttributeModified()Returns whether an attribute value has changed for this element.
isAttributeOutdated()Returns whether an attribute value has fallen behind the canonical element’s value.
isAttributeRequired()Returns a value indicating whether the attribute is required.
isAttributeSafe()Returns a value indicating whether the attribute is safe for massive assignments.
isChildOf()Returns whether this element is a direct child of another one.
isDescendantOf()Returns whether this element is a descendant of another one.
isFieldDirty()Returns whether a custom field value has changed since the element was first loaded.
isFieldEmpty()Returns whether a field is empty.
isFieldModified()Returns whether a field value has changed for this element.
isFieldOutdated()Returns whether a field value has fallen behind the canonical element’s value.
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.
off()Detaches an existing event handler from this component.
offsetExists()Returns whether there is an element at the specified offset.
offsetGet()Returns the element at the specified offset.
offsetSet()Sets the element at the specified offset.
offsetUnset()Sets the element value at the specified offset to null.
on()Attaches an event handler to an event.
onUnsafeAttribute()This method is invoked when an unsafe attribute is being massively assigned.
pluralDisplayName()Returns the plural version of displayName().
pluralLowerDisplayName()Returns the plural, lowercase version of displayName().
refHandle()Returns the handle that should be used to refer to this element type from reference tags.
rules()Returns the validation rules for attributes.
safeAttributes()Returns the attribute names that are safe to be massively assigned in the current scenario.
scenarios()Returns a list of scenarios and the corresponding active attributes.
searchableAttributes()Defines which element attributes should be searchable.
setAttributes()Sets the attribute values in a massive way.
setCanonical()Sets the canonical version of the element.
setCanonicalId()Sets the element’s canonical ID.
setDirtyAttributes()Sets the list of dirty attribute names.
setEagerLoadedElementCount()Sets the count of eager-loaded elements for a given handle.
setEagerLoadedElements()Sets some eager-loaded elements on a given handle.
setEnabledForSite()Sets whether the element is enabled for the current site.
setFieldParamNamespace()Sets the namespace used by custom field params on the request.
setFieldValue()Sets the value for a given field.
setFieldValues()Sets the element’s custom field values.
setFieldValuesFromRequest()Sets the element’s custom field values, when the values have come from post data.
setIsFresh()Sets whether the element is "fresh" (not yet explicitly saved, and without validation errors).
setNext()Sets the default next element.
setParent()Sets the element’s parent.
setPrev()Sets the default previous element.
setRevisionCreatorId()Sets the revision creator ID to be saved.
setRevisionNotes()Sets the revision notes to be saved.
setScenario()Sets the scenario for the model.
setUiLabel()Defines what the element should be called within the control panel.
sortOptions()Returns the sort options for the element type.
sourcePath()Returns the source path for a given source key, step key, and context.
sources()Returns the source definitions that elements of this type may belong to.
statuses()Returns all of the possible statuses that elements of this type may have.
tableAttributes()Defines all of the available columns that can be shown in table views.
toArray()Converts the model into an array.
trackChanges()Returns whether Craft should keep track of attribute and custom field changes made to this element type, including when the last time they were changed, and who was logged-in at the time.
trigger()Triggers an event.
validate()Performs the data validation.
validateCustomFieldAttribute()Calls a custom validation function on a custom field.
validateCustomFieldContentSize()Validates that the content size is going to fit within the field’s database column.
validateMultiple()Validates multiple models.

__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

Throws

__clone()

View source

__construct()

Constructor.

The default implementation does two things:

  • Initializes the object with the given configuration $config.
  • Call init().

If this method is overridden in a child class, it is recommended that

  • the last parameter of the constructor is a configuration array, like $config here.
  • call the parent implementation at the end of the constructor.

View source

Arguments

  • $config (array) – Name-value pairs that will be used to initialize the object properties

__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

__isset()

Checks if a property is set.

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

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

__toString()

Returns the string representation of the element.

View source

Returns

string

actions()

Returns the available 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 element actions.

addError()

Adds a new error to the specified attribute.

View source

Arguments

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

afterDelete()

Performs actions after an element is deleted.

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

attributeLabels()

Returns the attribute labels.

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

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

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

View source

Returns

array – Attribute labels (name => label)

attributes()

Returns the list of attribute names.

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

View source

Returns

string[] – List of attribute names.

beforeDelete()

Performs actions before an element is deleted.

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

behaviors()

Returns a list of behaviors that this component should behave as.

Child classes may override this method to specify the behaviors they want to behave as.

The return value of this method should be an array of behavior objects or configurations indexed by behavior names. A behavior configuration can be either a string specifying the behavior class or an array of the following structure:

php
'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

Note that a behavior class must extend from \craft\base\Behavior. Behaviors can be attached using a name or anonymously. When a name is used as the array key, using this name, the behavior can later be retrieved using getBehavior() or be detached using detachBehavior(). Anonymous behaviors can not be retrieved or detached.

Behaviors declared in this method will be attached to the component automatically (on demand).

View source

Returns

array – The behavior configurations.

datetimeAttributes()

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

View source

Returns

string[]

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

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

View source

Arguments

  • $sourceElements (craft\base\ElementInterface[]) – An array of the source elements
  • $handle (string) – The property handle used to identify which target elements should be included in the map

Returns

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

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 of 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) – The selected source’s key

Returns

craft\models\FieldLayout[]

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()
    {
        // use ProductQuery instead of the default ElementQuery
        return new ProductQuery(get_called_class());
    }
}

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

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

View source

Returns

craft\elements\db\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
3.8.0

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

View source

Arguments

Returns

array, null

getAncestors()

Returns the element’s ancestors.

View source

Arguments

Returns

craft\elements\db\ElementQueryInterface, static[]

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

Returns

array, null

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

static

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

getChildren()

Returns the element’s children.

View source

Returns

craft\elements\db\ElementQueryInterface, static[]

getContentTable()

Returns the name of the table this element’s content is stored in.

View source

Returns

string

getCpEditUrl()

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

View source

Returns

string, null

getCurrentRevision()

Since
3.2.0

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

View source

Returns

static, null

getDescendants()

Returns the element’s descendants.

View source

Arguments

Returns

craft\elements\db\ElementQueryInterface, static[]

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 – The eager-loaded element count

getEagerLoadedElements()

Returns the eager-loaded elements for a given handle.

View source

Arguments

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

Returns

craft\base\ElementInterface[], null – The eager-loaded elements, or null if they hadn't been eager-loaded

getEditorHtml()

Returns the HTML for the element’s editor slideout.

View source

Returns

string – The HTML for the editor slideout

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

getFieldColumnPrefix()

Returns the field column prefix this element’s content uses.

View source

Returns

string

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

getFieldStatus()

DEPRECATED

Deprecated in 3.7.0. Use craft\base\FieldInterface::getStatus() instead.

Since
3.4.0

Returns the status of a given field.

View source

Arguments

Returns

array, null

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

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

getHasCheckeredThumb()

Since
3.5.5

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

View source

Returns

boolean

getHasDescendants()

Returns whether the element has descendants.

View source

Returns

boolean

getHasFreshContent()

DEPRECATED

Deprecated in 3.7.14. getIsFresh() should be used instead.

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

View source

Returns

boolean

getHasRoundedThumb()

Since
3.5.5

Returns whether the element’s thumbnail should be rounded.

View source

Returns

boolean

getHtmlAttributes()

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

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', 'field', etc.)

Returns

array

getId()

View source

getIsCanonical()

Since
3.7.0

Returns whether this is the canonical element.

View source

Returns

boolean

getIsDeletable()

Since
3.5.12

Returns whether the current user can delete the 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

getIsEditable()

Returns whether the current user can edit the element.

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

getIsProvisionalDraft()

DEPRECATED

Deprecated in 3.7.0. Use isProvisionalDraft instead.

Since
3.7.0

Returns whether this is a provisional draft.

View source

Returns

boolean

getIsRevision()

Since
3.2.0

Returns whether this is a revision.

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

getIsUnsavedDraft()

DEPRECATED

Deprecated in 3.6.0. Use getIsUnpublishedDraft() instead.

Since
3.2.0

Returns whether the element is an unpublished draft.

View source

Returns

boolean

getLanguage()

Since
3.5.0

Returns the language of the element.

View source

Returns

string

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[], static[]

getMetadata()

Since
3.7.0

Returns element metadata that can be shown on its edit page or within element editor slideouts.

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

static, null

getNextSibling()

Returns the element’s next sibling.

View source

Returns

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

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

getPrev()

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

View source

Arguments

  • $criteria (mixed)

Returns

static, null

getPrevSibling()

Returns the element’s previous sibling.

View source

Returns

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

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

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, static[]

getSidebarHtml()

Since
3.7.0

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

View source

Returns

string

getSite()

Returns the site the element is associated with.

View source

Returns

craft\models\Site

Throws

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

Returns the element’s status.

View source

Returns

string, null

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

integer[], array

getTableAttributeHtml()

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

TIP

Element types that extend craft\base\Element should override craft\base\Element::tableAttributeHtml() 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 View.

getThumbUrl()

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

View source

Arguments

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

Returns

string, null

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

Since
3.2.0

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

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

gqlMutationNameByContext()

Since
3.5.0

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

View source

Arguments

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

Returns

string

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

gqlTypeNameByContext()

Since
3.3.0

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

View source

Arguments

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

Returns

string

hasContent()

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

View source

Returns

boolean – Whether elements of this type will be storing any data in the content table.

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

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.

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
3.8.0

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

View source

Arguments

Returns

integer

indexHtml()

Returns the element index HTML.

View source

Arguments

Returns

string – The element index HTML

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

Returns

boolean

isAttributeDirty()

Since
3.5.0

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

View source

Arguments

Returns

boolean

isAttributeModified()

Since
3.7.0

Returns whether an attribute value has changed for this element.

View source

Arguments

Returns

boolean

isAttributeOutdated()

Since
3.7.0

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

View source

Arguments

Returns

boolean

isChildOf()

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

View source

Arguments

  • $element (static)

Returns

boolean

isDescendantOf()

Returns whether this element is a descendant of another one.

View source

Arguments

  • $element (static)

Returns

boolean

isFieldDirty()

Since
3.4.0

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

View source

Arguments

Returns

boolean

isFieldEmpty()

Returns whether a field is empty.

View source

Arguments

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

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

Returns

boolean

isParentOf()

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

View source

Arguments

  • $element (static)

Returns

boolean

isPrevSiblingOf()

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

View source

Arguments

  • $element (static)

Returns

boolean

isSiblingOf()

Returns whether this element is a sibling of another one.

View source

Arguments

  • $element (static)

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

Returns

void

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

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

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

setCanonical()

Since
3.7.0

Sets the canonical version of the element.

View source

Arguments

  • $element (static)

Returns

void

setCanonicalId()

Since
3.7.0

Sets the element’s canonical ID.

View source

Arguments

Returns

void

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

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

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

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

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

setNext()

Sets the default next element.

View source

Arguments

setParent()

Sets the element’s parent.

View source

Arguments

  • $parent (static, null)

setPrev()

Sets the default previous element.

View source

Arguments

Returns

void

setRevisionCreatorId()

Since
3.2.0

Sets the revision creator ID to be saved.

View source

Arguments

setRevisionNotes()

Since
3.2.0

Sets the revision notes to be saved.

View source

Arguments

setUiLabel()

Since
3.6.3

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

View source

Arguments

Returns

void

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 a single argument, $dir, set to either SORT_ASC or SORT_DESC, 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
3.8.12

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

View source

Arguments

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)
  • sites – An array of site IDs 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)
  • hasThumbs – A bool that defines whether this source supports Thumbs View. (Use your element’s 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, null) – The context ('index' or 'modal').

Returns

array – The sources.

statuses()

Returns all of the possible statuses that elements of this type may have.

This method will be called when populating the Status menu on element indexes, for element types whose hasStatuses() method returns true. It will also be called when craft\elements\db\ElementQuery is querying for elements, to ensure that its “status” parameter is set to a valid status. It should return an array whose keys are the status values, and values are the human-facing status labels, or an array with the following keys:

  • label – The human-facing status label.
  • color – The status color. Possible values include green, orange, red, yellow, pink, purple, blue, turquoise, light, grey, black, and white. You can customize the database query condition that should be applied for your custom statuses from craft\elements\db\ElementQuery::statusCondition().

View source

Returns

array

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.

The first item in the array will determine the first table column’s header (and which sort option it should be mapped to, if any), however it doesn’t have any effect on the table body, because the first column is reserved for displaying whatever the elements’ getUiLabel() methods return.

View source

Returns

array – The table attributes.

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.

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

validateCustomFieldContentSize()

Validates that the content size is going to fit within the field’s database column.

View source

Arguments

Protected Methods

MethodDescription
cpEditUrl()Returns the element’s edit URL in the control panel.
defineActions()Defines the available element actions for a given source.
defineDefaultTableAttributes()Returns the list of table attribute keys that should be shown by default.
defineExporters()Defines the available element exporters for a given source.
defineFieldLayouts()Defines the field layouts associated with elements for a given source.
defineRules()Returns the validation rules for attributes.
defineSearchableAttributes()Defines which element attributes should be searchable.
defineSortOptions()Returns the sort options for the element type.
defineSources()Defines the sources that elements of this type may belong to.
defineTableAttributes()Defines all of the available columns that can be shown in table views.
extractFieldsFor()Extract nested fields from a fields collection for a given root field Nested fields are separated with dots (.). e.g: "item.id" The previous example would extract "id".
extractRootFields()Extracts the root field names from nested fields.
fieldByHandle()Returns the field with a given handle.
fieldLayoutFields()Returns each of this element’s fields.
findByCondition()Finds Element instance(s) by the given condition.
hasFieldLayout()Returns whether the element has a field layout with at least one tab.
htmlAttributes()Returns any attributes that should be included in the element’s DOM representation in the control panel.
indexElements()Returns the resulting elements for an element index.
isDeletable()Returns whether the current user can delete the element.
isEditable()Returns whether the current user can edit the element.
metaFieldsHtml()Returns the HTML for any meta fields that should be shown within the sidebar of element editor slideouts. Or if the element doesn’t have a field layout, they’ll be shown in the main body of the slideout.
metadata()Returns element metadata that can be shown on its edit page or within element editor slideouts.
normalizeFieldValue()Normalizes a field’s value.
prepElementQueryForTableAttribute()Prepares an element query for an element index that includes a given table attribute.
previewTargets()Returns the additional locations that should be available for previewing the element, besides its primary URL.
resolveFields()Determines which fields can be returned by toArray().
route()Returns the route that should be used when the element’s URI is requested.
searchKeywords()Returns the search keywords for a given search attribute.
slugFieldHtml()Returns the HTML for the element’s Slug field.
tableAttributeHtml()Returns the HTML that should be shown for a given attribute in Table View.
uiLabel()Returns what the element should be called within the control panel.

cpEditUrl()

Since
3.7.0

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

View source

Returns

string, null

defineActions()

Defines the available element actions for a given source.

See also actions()View source

Arguments

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

Returns

array – The available element actions.

defineDefaultTableAttributes()

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

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.

See also exporters()View 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.

See also fieldLayouts()View source

Arguments

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

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.

See also searchableAttributes()View source

Returns

string[] – The element attributes that should be searchable

defineSortOptions()

Returns the sort options for the element type.

See also sortOptions()View source

Returns

array – The attributes that elements can be sorted by

defineSources()

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

See also sources()View source

Arguments

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

Returns

array – The sources.

defineTableAttributes()

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

See also tableAttributes()View source

Returns

array – The table attributes.

fieldByHandle()

Returns the field with a given handle.

View source

Arguments

Returns

craft\base\FieldInterface, null

fieldLayoutFields()

Returns each of this element’s fields.

View source

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

Returns

static, static[], null

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.

htmlAttributes()

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

See also getHtmlAttributes()View source

Arguments

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

Returns

array

indexElements()

Since
3.8.0

Returns the resulting elements for an element index.

View source

Arguments

Returns

craft\base\ElementInterface[]

isDeletable()

Since
3.5.12

Returns whether the current user can delete the element.

View source

Returns

boolean

isEditable()

Since
3.7.0

Returns whether the current user can edit the element.

View source

Returns

boolean

metaFieldsHtml()

Since
3.7.0

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

View source

Returns

string

metadata()

Since
3.7.0

Returns element metadata that can be shown on its edit page or within element editor slideouts.

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

prepElementQueryForTableAttribute()

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

View source

Arguments

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.

See also getPreviewTargets()View source

Returns

array

route()

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

See also getRoute()View source

Returns

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

searchKeywords()

Since
3.5.0

Returns the search keywords for a given search attribute.

View source

Arguments

Returns

string

slugFieldHtml()

Since
3.7.0

Returns the HTML for the element’s Slug field.

View source

Returns

string

tableAttributeHtml()

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

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

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

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

WARNING

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

By default the following will be returned:

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

See also getTableAttributeHtml()View source

Arguments

  • $attribute (string) – The attribute name.

Returns

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

Throws

uiLabel()

Since
3.6.4

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

View source

Returns

string, null

Constants

ConstantDescription
ATTR_STATUS_CONFLICTED
ATTR_STATUS_MODIFIED
ATTR_STATUS_OUTDATED
HOMEPAGE_URI
SCENARIO_DEFAULTThe name of the default scenario.
SCENARIO_ESSENTIALS
SCENARIO_LIVE
STATUS_ARCHIVED
STATUS_DISABLED
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

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

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

    // ...
});

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\db\Query;
use craft\elements\Entry;
use craft\events\DefineEagerLoadingMapEvent;
use craft\helpers\ArrayHelper;
use yii\base\Event;

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

EVENT_DEFINE_IS_DELETABLE

Type
craft\events\DefineValueEvent
Since
3.7.0

The event that is triggered when determining whether the element should be deletable by the current user.

See also getIsDeletable()


EVENT_DEFINE_IS_EDITABLE

Type
craft\events\DefineValueEvent
Since
3.7.0

The event that is triggered when determining whether the element should be editable by the current user.

See also getIsEditable()


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.

See also getMetadata()


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 element’s editor slideout sidebar.

See also metaFieldsHtml()


EVENT_DEFINE_SIDEBAR_HTML

Type
craft\events\DefineHtmlEvent
Since
3.7.0

The event that is triggered when defining the HTML for the element’s editor slideout sidebar.

See also getSidebarHtml()


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 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\PrepareElementQueryForTableAttributeEvent;
use craft\events\RegisterElementTableAttributesEvent;
use craft\events\SetElementTableAttributeHtmlEvent;
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(SetElementTableAttributeHtmlEvent $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 actions 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.

See also fieldLayouts()


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

EVENT_SET_TABLE_ATTRIBUTE_HTML

Type
craft\events\SetElementTableAttributeHtmlEvent

The event that is triggered when defining the HTML to represent a table attribute.