Element

Type
Abstract Class
Namespace
craft\base
Inherits
craft\base\Element » craft\base\Component » craft\base\Model » yii\base\Model (opens new window) » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
Implements
ArrayAccess (opens new window), IteratorAggregate (opens new window), craft\base\ComponentInterface, craft\base\ElementInterface, craft\base\ModelInterface, yii\base\Arrayable (opens new window), yii\base\Configurable (opens new window), yii\base\StaticInstanceInterface (opens new window)
Uses traits
craft\base\ClonefixTrait, craft\base\ElementTrait, yii\base\ArrayableTrait (opens new window), yii\base\StaticInstanceTrait (opens new window)
Extended by
craft\elements\Address, craft\elements\Asset, craft\elements\Category, craft\elements\Entry, craft\elements\GlobalSet, craft\elements\MatrixBlock, craft\elements\Tag, craft\elements\User, craft\test\mockclasses\elements\ExampleElement
Since
3.0.0

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

View source (opens new window)

# Public Properties

Property Description
activeValidators (opens new window) yii\validators\Validator (opens new window) – The validators applicable to the current scenario (opens new window).
additionalButtons string (opens new window)
ancestors craft\elements\db\ElementQueryInterface – The element’s ancestors
archived boolean (opens new window) – Whether the element is archived
attributes (opens new window) array (opens new window) – Attribute values (name => value).
awaitingFieldValues boolean (opens new window) – Whether the element is still awaiting its custom field values
behaviors (opens new window) yii\base\Behavior (opens new window) – List of behaviors attached to this component.
cacheTags string (opens new window)[]
canonical craft\base\ElementInterface, null (opens new window) – The canonical element, if one exists for the current site
canonicalId integer (opens new window), null (opens new window) – The element’s canonical ID
canonicalUid string (opens new window) – The element’s canonical UID
children craft\elements\db\ElementQueryInterface – The element’s children
contentId integer (opens new window), null (opens new window) – The element’s content row ID
contentTable string (opens new window) – The name of the table this element’s content is stored in
cpEditUrl string (opens new window), null (opens new window) – The element’s edit URL in the control panel
currentRevision self, null (opens new window)
dateCreated DateTime (opens new window), null (opens new window) – The date that the element was created
dateDeleted DateTime (opens new window), null (opens new window) – The date that the element was trashed
dateLastMerged DateTime (opens new window), null (opens new window) – The date that the canonical element was last merged into this one
dateUpdated DateTime (opens new window), null (opens new window) – The date that the element was last updated
descendants craft\elements\db\ElementQueryInterface – The element’s descendants
dirtyAttributes string (opens new window)[]
dirtyFields string (opens new window)[]
draftId integer (opens new window), null (opens new window) – The ID of the draft’s row in the drafts table
duplicateOf craft\base\ElementInterface, null (opens new window) – The element that this element is being duplicated by.
editorHtml string (opens new window) – The HTML for the element’s editor HUD
enabled boolean (opens new window) – Whether the element is enabled
enabledForSite boolean (opens new window) – Whether the element is enabled for this site
errors (opens new window) array (opens new window) – Errors for all attributes or the specified attribute.
fieldColumnPrefix string (opens new window) – The field column prefix this element’s content uses
fieldContext string (opens new window) – The field context this element’s content uses
fieldLayout craft\models\FieldLayout, null (opens new window) – The field layout used by this element
fieldLayoutId integer (opens new window), null (opens new window) – The element’s field layout ID
fieldParamNamespace array (opens new window) – The namespace used by custom field params on the request
fieldValues array (opens new window) – The element’s normalized custom field values, indexed by their handles
firstErrors (opens new window) array (opens new window) – The first errors.
firstSave boolean (opens new window) – Whether the element is being saved for the first time in a normal state (not as a draft or revision).
gqlTypeName string (opens new window)
hardDelete boolean (opens new window) – Whether the element is being hard-deleted.
hasCheckeredThumb boolean (opens new window)
hasDescendants boolean (opens new window) – Whether the element has descendants
hasRoundedThumb boolean (opens new window)
htmlAttributes array (opens new window) – Any attributes that should be included in the element’s DOM representation in the control panel
id integer (opens new window), null (opens new window) – The element’s ID
isCanonical boolean (opens new window) – Whether this is the canonical element
isDerivative boolean (opens new window) – Whether this is a derivative element, such as a draft or revision
isDraft boolean (opens new window)
isFresh boolean (opens new window)
isHomepage boolean (opens new window)
isNewForSite boolean (opens new window) – Whether the element is being saved to the current site for the first time.
isProvisionalDraft boolean (opens new window) – Whether this is a provisional draft.
isRevision boolean (opens new window)
isTitleTranslatable boolean (opens new window)
isUnpublishedDraft boolean (opens new window)
iterator (opens new window) ArrayIterator (opens new window) – An iterator for traversing the items in the list.
language string (opens new window)
level integer (opens new window), null (opens new window) – The element’s level within its structure
lft integer (opens new window), null (opens new window) – The element’s left position within its structure
link \Twig\Markup, null (opens new window) – An anchor pre-filled with this element’s URL and title
localized craft\elements\db\ElementQueryInterface, \Illuminate\Support\Collection
mergingCanonicalChanges boolean (opens new window) – Whether recent changes to the canonical element are being merged into this element.
metadata array (opens new window) – The data, with keys representing the labels.
modifiedAttributes string (opens new window)[]
modifiedFields string (opens new window)[]
newSiteIds integer (opens new window)[] – The site IDs that the element was just propagated to for the first time.
next craft\base\ElementInterface, null (opens new window) – The next element relative to this one, from a given set of criteria
nextSibling craft\base\ElementInterface, null (opens new window) – The element’s next sibling
outdatedAttributes string (opens new window)[]
outdatedFields string (opens new window)[]
parent craft\base\ElementInterface, null (opens new window) – The element’s parent
parentId integer (opens new window), null (opens new window) – The element’s parent’s ID
parentUri string (opens new window), null (opens new window)
postEditUrl string (opens new window), null (opens new window)
prev craft\base\ElementInterface, null (opens new window) – The previous element relative to this one, from a given set of criteria
prevSibling craft\base\ElementInterface, null (opens new window) – The element’s previous sibling
previewTargets array (opens new window)
previewing boolean (opens new window) – Whether the element is currently being previewed.
propagateAll boolean (opens new window) – Whether all element attributes should be propagated across all its supported sites, even if that means overwriting existing site-specific values.
propagating boolean (opens new window) – Whether the element is being saved in the context of propagating another site's version of the element.
ref string (opens new window), null (opens new window) – The reference string to this element
resaving boolean (opens new window) – Whether the element is being resaved by a ResaveElement job or a resave console command.
revisionId integer (opens new window), null (opens new window) – The ID of the revision’s row in the revisions table
rgt integer (opens new window), null (opens new window) – The element’s right position within its structure
root integer (opens new window), null (opens new window) – The element’s structure’s root ID
route mixed – The route that should be used when the element’s URI is requested
scenario (opens new window) string (opens new window) – The scenario that this model is in.
searchScore integer (opens new window), null (opens new window) – The element’s search score, if the craft\elements\db\ElementQuery::search() parameter was used when querying for the element
serializedFieldValues array (opens new window) – Array of the element’s serialized custom field values, indexed by their handles
siblings craft\elements\db\ElementQueryInterface – All of the element’s siblings
site craft\models\Site – Site the element is associated with
siteId integer (opens new window), null (opens new window) – The site ID the element is associated with
siteSettingsId integer (opens new window), null (opens new window) – The ID of the element’s record in the elements_sites table
slug string (opens new window), null (opens new window) – The element’s slug
sourceId integer (opens new window), null (opens new window)
sourceUid string (opens new window)
status string (opens new window), null (opens new window) – The element’s status
structureId integer (opens new window), null (opens new window) – The element’s structure ID
supportedSites integer (opens new window)[], array (opens new window) – The sites this element is associated with
tempId string (opens new window), null (opens new window) – The element’s temporary ID (only used if the element’s URI format contains {id})
thumbAlt string (opens new window), null (opens new window)
title string (opens new window), null (opens new window) – The element’s title
titleTranslationDescription string (opens new window), null (opens new window)
titleTranslationKey string (opens new window) – The translation key
totalDescendants integer (opens new window) – The total number of descendants that the element has
trashed boolean (opens new window) – Whether the element has been soft-deleted.
uiLabel string (opens new window)
uid string (opens new window), null (opens new window) – The element’s UID
updatingFromDerivative boolean (opens new window) – Whether the element is being updated from a derivative element, such as a draft or revision.
uri string (opens new window), null (opens new window) – The element’s URI
uriFormat string (opens new window), null (opens new window) – The URI format used to generate this element’s URL
url string (opens new window), null (opens new window) – The element’s full URL
validators (opens new window) ArrayObject (opens new window), yii\validators\Validator (opens new window) – All the validators declared in the model.

# additionalButtons

Type
string (opens new window)
Default value
null
Access
Read-only
Since
4.0.0

View source (opens new window)

# ancestors

Type
craft\elements\db\ElementQueryInterface
Default value
null

The element’s ancestors

View source (opens new window)

# cacheTags

Type
string (opens new window)[]
Default value
null
Access
Read-only
Since
3.5.0

View source (opens new window)

# canonical

Type
craft\base\ElementInterface, null (opens new window)
Default value
null

The canonical element, if one exists for the current site

View source (opens new window)

# canonicalId

Type
integer (opens new window), null (opens new window)
Default value
null

The element’s canonical ID

View source (opens new window)

# canonicalUid

Type
string (opens new window)
Default value
null

The element’s canonical UID

View source (opens new window)

# children

Type
craft\elements\db\ElementQueryInterface
Default value
null

The element’s children

View source (opens new window)

# contentTable

Type
string (opens new window)
Default value
null

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

View source (opens new window)

# cpEditUrl

Type
string (opens new window), null (opens new window)
Default value
null

The element’s edit URL in the control panel

View source (opens new window)

# currentRevision

Type
self, null (opens new window)
Default value
null
Access
Read-only
Since
3.2.0

View source (opens new window)

# descendants

Type
craft\elements\db\ElementQueryInterface
Default value
null

The element’s descendants

View source (opens new window)

# dirtyAttributes

Type
string (opens new window)[]
Default value
null
Since
3.4.0

View source (opens new window)

# dirtyFields

Type
string (opens new window)[]
Default value
null
Access
Read-only
Since
3.4.0

View source (opens new window)

# editorHtml

Type
string (opens new window)
Default value
null

The HTML for the element’s editor HUD

View source (opens new window)

# enabledForSite

Type
boolean (opens new window)
Default value
null

Whether the element is enabled for this site

View source (opens new window)

# fieldColumnPrefix

Type
string (opens new window)
Default value
null

The field column prefix this element’s content uses

View source (opens new window)

# fieldContext

Type
string (opens new window)
Default value
null

The field context this element’s content uses

View source (opens new window)

# fieldLayout

Type
craft\models\FieldLayout, null (opens new window)
Default value
null

The field layout used by this element

View source (opens new window)

# fieldParamNamespace

Type
array (opens new window)
Default value
null

The namespace used by custom field params on the request

View source (opens new window)

# fieldValues

Type
array (opens new window)
Default value
null

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

View source (opens new window)

# gqlTypeName

Type
string (opens new window)
Default value
null
Access
Read-only
Since
3.3.0

View source (opens new window)

# hasCheckeredThumb

Type
boolean (opens new window)
Default value
null
Access
Read-only
Since
3.5.5

View source (opens new window)

# hasDescendants

Type
boolean (opens new window)
Default value
null

Whether the element has descendants

View source (opens new window)

# hasRoundedThumb

Type
boolean (opens new window)
Default value
null
Access
Read-only
Since
3.5.5

View source (opens new window)

# htmlAttributes

Type
array (opens new window)
Default value
null

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

View source (opens new window)

# isCanonical

Type
boolean (opens new window)
Default value
null

Whether this is the canonical element

View source (opens new window)

# isDerivative

Type
boolean (opens new window)
Default value
null

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

View source (opens new window)

# isDraft

Type
boolean (opens new window)
Default value
null
Access
Read-only
Since
3.2.0

View source (opens new window)

# isFresh

Type
boolean (opens new window)
Default value
null
Access
Read-only
Since
3.7.14

View source (opens new window)

# isHomepage

Type
boolean (opens new window)
Default value
null
Access
Read-only
Since
3.3.6

View source (opens new window)

# isRevision

Type
boolean (opens new window)
Default value
null
Access
Read-only
Since
3.2.0

View source (opens new window)

# isTitleTranslatable

Type
boolean (opens new window)
Default value
null
Access
Read-only
Since
3.5.0

View source (opens new window)

# isUnpublishedDraft

Type
boolean (opens new window)
Default value
null
Access
Read-only
Since
3.6.0

View source (opens new window)

# language

Type
string (opens new window)
Default value
null
Access
Read-only
Since
3.5.0

View source (opens new window)

Type
\Twig\Markup, null (opens new window)
Default value
null

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

View source (opens new window)

# localized

Type
craft\elements\db\ElementQueryInterface, \Illuminate\Support\Collection
Default value
null
Access
Read-only
Since
3.5.0

View source (opens new window)

# metadata

Type
array (opens new window)
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 (opens new window)

# modifiedAttributes

Type
string (opens new window)[]
Default value
null
Access
Read-only
Since
3.7.0

View source (opens new window)

# modifiedFields

Type
string (opens new window)[]
Default value
null
Access
Read-only
Since
3.7.0

View source (opens new window)

# next

Type
craft\base\ElementInterface, null (opens new window)
Default value
null

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

View source (opens new window)

# nextSibling

Type
craft\base\ElementInterface, null (opens new window)
Default value
null

The element’s next sibling

View source (opens new window)

# outdatedAttributes

Type
string (opens new window)[]
Default value
null
Access
Read-only
Since
3.7.0

View source (opens new window)

# outdatedFields

Type
string (opens new window)[]
Default value
null
Access
Read-only
Since
3.7.0

View source (opens new window)

# parent

Type
craft\base\ElementInterface, null (opens new window)
Default value
null

The element’s parent

View source (opens new window)

# parentId

Type
integer (opens new window), null (opens new window)
Default value
null

The element’s parent’s ID

View source (opens new window)

# parentUri

Type
string (opens new window), null (opens new window)
Default value
null
Access
Read-only

View source (opens new window)

# postEditUrl

Type
string (opens new window), null (opens new window)
Default value
null
Access
Read-only
Since
4.0.0

View source (opens new window)

# prev

Type
craft\base\ElementInterface, null (opens new window)
Default value
null

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

View source (opens new window)

# prevSibling

Type
craft\base\ElementInterface, null (opens new window)
Default value
null

The element’s previous sibling

View source (opens new window)

# previewTargets

Type
array (opens new window)
Default value
null
Access
Read-only
Since
3.2.0

View source (opens new window)

# ref

Type
string (opens new window), null (opens new window)
Default value
null

The reference string to this element

View source (opens new window)

# route

Type
mixed
Default value
null

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

View source (opens new window)

# serializedFieldValues

Type
array (opens new window)
Default value
null

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

View source (opens new window)

# siblings

Type
craft\elements\db\ElementQueryInterface
Default value
null

All of the element’s siblings

View source (opens new window)

# site

Type
craft\models\Site
Default value
null

Site the element is associated with

View source (opens new window)

# sourceId

Type
integer (opens new window), null (opens new window)
Default value
null
Access
Read-only
Since
3.2.0

View source (opens new window)

# sourceUid

Type
string (opens new window)
Default value
null
Access
Read-only
Since
3.2.0

View source (opens new window)

# status

Type
string (opens new window), null (opens new window)
Default value
null

The element’s status

View source (opens new window)

# supportedSites

Type
integer (opens new window)[], array (opens new window)
Default value
null

The sites this element is associated with

View source (opens new window)

# thumbAlt

Type
string (opens new window), null (opens new window)
Default value
null
Access
Read-only
Since
4.0.0

View source (opens new window)

# titleTranslationDescription

Type
string (opens new window), null (opens new window)
Default value
null
Access
Read-only
Since
3.5.0

View source (opens new window)

# titleTranslationKey

Type
string (opens new window)
Default value
null
Access
Read-only

The translation key

View source (opens new window)

# totalDescendants

Type
integer (opens new window)
Default value
null

The total number of descendants that the element has

View source (opens new window)

# uiLabel

Type
string (opens new window)
Default value
null
Since
3.2.0

View source (opens new window)

# uriFormat

Type
string (opens new window), null (opens new window)
Default value
null

The URI format used to generate this element’s URL

View source (opens new window)

# url

Type
string (opens new window), null (opens new window)
Default value
null

The element’s full URL

View source (opens new window)

# Protected Properties

Property Description
revisionCreatorId integer (opens new window), null (opens new window) – Revision creator ID to be saved
revisionNotes string (opens new window), null (opens new window) – Revision notes to be saved

# revisionCreatorId

Type
integer (opens new window), null (opens new window)
Default value
null

Revision creator ID to be saved

See also setRevisionCreatorId()

View source (opens new window)

# revisionNotes

Type
string (opens new window), null (opens new window)
Default value
null

Revision notes to be saved

See also setRevisionNotes()

View source (opens new window)

# Public Methods

Method Description
__call() Calls the named method which is not a class method.
__clone()
__construct()
__get() Returns the value of a component property.
__isset() Checks if a property is set.
__set() Sets the value of a component property.
__toString() Returns the string representation of the element.
__unset() (opens new window) Sets a component property to be null.
actions() Returns the available element actions (opens new window) for a given source.
activeAttributes() (opens new window) Returns the attribute names that are subject to validation in the current scenario.
addError() Adds a new error to the specified attribute.
addErrors() (opens new window) 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() (opens new window) Attaches a behavior to this component.
attachBehaviors() (opens new window) Attaches a list of behaviors to the component.
attributeHints() (opens new window) 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() (opens new window) This method is invoked before validation starts.
behaviors() Returns a list of behaviors that this component should behave as.
canCreateDrafts() Returns whether the given user is authorized to create drafts for thisc element.
canDelete() Returns whether the given user is authorized to delete this element.
canDeleteForSite() Returns whether the given user is authorized to delete this element for its current site.
canDuplicate() Returns whether the given user is authorized to duplicate this element.
canGetProperty() (opens new window) Returns a value indicating whether a property can be read.
canSave() Returns whether the given user is authorized to save this element in its current form.
canSetProperty() (opens new window) Returns a value indicating whether a property can be set.
canView() Returns whether the given user is authorized to view this element’s edit page.
className() (opens new window) Returns the fully qualified name of this class.
clearErrors() (opens new window) Removes errors for all attributes or a single attribute.
createAnother() Creates a new element (without saving it) based on this one.
createCondition() Returns an element condition for the element type.
createValidators() (opens new window) Creates validator objects based on the validation rules specified in rules() (opens new window).
datetimeAttributes() Returns the names of any attributes that should hold DateTime (opens new window) values.
defaultTableAttributes() Returns the list of table attribute keys that should be shown by default.
detachBehavior() (opens new window) Detaches a behavior from the component.
detachBehaviors() (opens new window) 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() (opens new window) Makes sure that the behaviors declared in behaviors() (opens new window) 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() (opens new window).
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() (opens new window) 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.
formName() (opens new window) Returns the form name that this model class should use.
generateAttributeLabel() (opens new window) Generates a user friendly attribute label based on the give attribute name.
getActiveValidators() (opens new window) Returns the validators applicable to the current scenario (opens new window).
getAdditionalButtons() Returns additional buttons that should be shown at the top of the element’s edit page.
getAncestors() Returns the element’s ancestors.
getAttributeHint() (opens new window) 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() (opens new window) Returns attribute values.
getBehavior() (opens new window) Returns the named behavior object.
getBehaviors() (opens new window) 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.
getEnabledForSite() Returns whether the element is enabled for the current site.
getErrorSummary() (opens new window) Returns the errors for all attributes as a one-dimensional array.
getErrors() (opens new window) Returns the errors for all attributes or a single attribute.
getFieldColumnPrefix() Returns the field column prefix this element’s content uses.
getFieldContext() Returns the field context this element’s content uses.
getFieldLayout() Returns the field layout used by this element.
getFieldParamNamespace() Returns the namespace used by custom field params on the request.
getFieldValue() Returns the value for a given field.
getFieldValues() Returns the element’s normalized custom field values, indexed by their handles.
getFirstError() (opens new window) Returns the first error of the specified attribute.
getFirstErrors() (opens new window) 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.
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.
getIsDerivative() Returns whether this is a derivative element, such as a draft or revision.
getIsDraft() Returns whether this is a draft.
getIsFresh() Returns whether the element is "fresh" (not yet explicitly saved, and without validation errors).
getIsHomepage() Returns whether this element represents the site homepage.
getIsRevision() Returns whether this is a revision.
getIsTitleTranslatable() Returns whether the Title field should be shown as translatable in the UI.
getIsUnpublishedDraft() Returns whether the element is an unpublished draft.
getIterator() (opens new window) Returns an iterator for traversing the attributes in the model.
getLanguage() Returns the language of the element.
getLink() Returns an anchor pre-filled with this element’s URL and title.
getLocalized() Returns the same element in other locales.
getMetadata() Returns element metadata that should be shown within the editor sidebar.
getModifiedAttributes() Returns the attribute names that have changed for this element.
getModifiedFields() Returns the field handles that have changed for this element.
getNext() Returns the next element relative to this one, from a given set of criteria.
getNextSibling() Returns the element’s next sibling.
getOutdatedAttributes() Returns the attribute names that have been updated on the canonical element since the last time it was merged into this element.
getOutdatedFields() Returns the field handles that have been updated on the canonical element since the last time it was merged into this element.
getParent() Returns the element’s parent.
getParentId() Returns the parent ID.
getParentUri() Returns the parent element’s URI, if there is one.
getPostEditUrl() Returns the URL that users should be redirected to after editing the element.
getPrev() Returns the previous element relative to this one, from a given set of criteria.
getPrevSibling() Returns the element’s previous sibling.
getPreviewTargets() Returns the additional locations that should be available for previewing the element, besides its primary URL.
getRef() Returns the reference string to this element.
getRoute() Returns the route that should be used when the element’s URI is requested.
getScenario() (opens new window) Returns the scenario that this model is used in.
getSearchKeywords() Returns the search keywords for a given search attribute.
getSerializedFieldValues() Returns an array of the element’s serialized custom field values, indexed by their handles.
getSiblings() Returns all of the element’s siblings.
getSidebarHtml() Returns the HTML for any fields/info that should be shown within the editor sidebar.
getSite() Returns the site the element is associated with.
getSourceId() Returns the element’s canonical ID.
getSourceUid() Returns the element’s canonical UID.
getStatus() Returns the element’s status.
getSupportedSites() Returns the sites this element is associated with.
getTableAttributeHtml() Returns the HTML that should be shown for a given attribute in Table View.
getThumbAlt() Returns alt text for the element’s thumbnail.
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() (opens new window) Returns all the validators declared in rules() (opens new window).
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() (opens new window) Returns a value indicating whether there is any handler attached to the named event.
hasMethod() (opens new window) Returns a value indicating whether a method is defined.
hasProperty() (opens new window) Returns a value indicating whether a property is defined for this component.
hasRevisions() Returns whether revisions should be created when this element is saved.
hasStatuses() Returns whether elements of this type have statuses.
hasTitles() Returns whether elements of this type have traditional titles.
hasUris() Returns whether elements of this type can have their own slugs and URIs.
indexHtml() Returns the element index HTML.
init() Initializes the object.
instance() (opens new window) Returns static class instance, which can be used to obtain meta information.
isAncestorOf() Returns whether this element is an ancestor of another one.
isAttributeActive() (opens new window) 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() (opens new window) Returns a value indicating whether the attribute is required.
isAttributeSafe() (opens new window) 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() (opens new window) Populates the model with input data.
loadMultiple() (opens new window) 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() (opens new window) Detaches an existing event handler from this component.
offsetExists() Returns whether there is an element at the specified offset.
offsetGet() (opens new window) Returns the element at the specified offset.
offsetSet() (opens new window) Sets the element at the specified offset.
offsetUnset() (opens new window) Sets the element value at the specified offset to null.
on() (opens new window) Attaches an event handler to an event.
onUnsafeAttribute() (opens new window) This method is invoked when an unsafe attribute is being massively assigned.
pluralDisplayName() Returns the plural version of displayName().
pluralLowerDisplayName() Returns the plural, lowercase version of displayName().
prepareEditScreen() Prepares the response for the element’s Edit screen.
refHandle() Returns the handle that should be used to refer to this element type from reference tags.
rules() Returns the validation rules for attributes.
safeAttributes() (opens new window) Returns the attribute names that are safe to be massively assigned in the current scenario.
scenarios() (opens new window) 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.
setParentId() Sets the parent ID.
setPrev() Sets the default previous element.
setRevisionCreatorId() Sets the revision creator ID to be saved.
setRevisionNotes() Sets the revision notes to be saved.
setScenario() (opens new window) 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.
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() (opens new window) 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() (opens new window) Triggers an event.
validate() (opens new window) Performs the data validation.
validateCustomFieldAttribute() Calls a custom validation function on a custom field.
validateMultiple() (opens new window) 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 (opens new window)

Arguments

Returns

mixed – The method return value

Throws

# __clone()

View source (opens new window)

# __construct()

View source (opens new window)

Arguments

  • $config

# __get()

Returns the value of a component property.

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

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

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

View source (opens new window)

Arguments

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 (opens new window)

Arguments

Returns

boolean (opens new window) – 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 (opens new window)

Arguments

Throws

# __toString()

Returns the string representation of the element.

View source (opens new window)

Returns

string (opens new window)

# actions()

Returns the available element actions (opens new window) 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 (opens new window)

Arguments

Returns

array (opens new window) – The available element actions.

# addError()

Adds a new error to the specified attribute.

View source (opens new window)

Arguments

# afterDelete()

Performs actions after an element is deleted.

View source (opens new window)

# afterMoveInStructure()

Performs actions after an element is moved within a structure.

View source (opens new window)

Arguments

# 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 (opens new window)

Arguments

# afterRestore()

Since
3.1.0

Performs actions after an element is restored.

View source (opens new window)

# afterSave()

Performs actions after an element is saved.

View source (opens new window)

Arguments

# afterValidate()

This method is invoked after validation ends.

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

View source (opens new window)

# 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() (opens new window). 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 (opens new window)

Returns

array (opens new window) – 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 (opens new window)

Returns

array (opens new window) – List of attribute names.

# beforeDelete()

Performs actions before an element is deleted.

View source (opens new window)

Returns

boolean (opens new window) – Whether the element should be deleted

# beforeMoveInStructure()

Performs actions before an element is moved within a structure.

View source (opens new window)

Arguments

Returns

boolean (opens new window) – Whether the element should be moved within the structure

# beforeRestore()

Since
3.1.0

Performs actions before an element is restored.

View source (opens new window)

Returns

boolean (opens new window) – Whether the element should be restored

# beforeSave()

Performs actions before an element is saved.

View source (opens new window)

Arguments

Returns

boolean (opens new window) – Whether the element should be saved

# canCreateDrafts()

Since
4.0.0

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

This will only be called if the element can be viewed.

View source (opens new window)

Arguments

Returns

boolean (opens new window)

# canDelete()

Since
4.0.0

Returns whether the given user is authorized to delete this element.

This will only be called if the element can be viewed.

View source (opens new window)

Arguments

Returns

boolean (opens new window)

# canDeleteForSite()

Since
4.0.0

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

This will only be called if the element can be viewed and deleted.

View source (opens new window)

Arguments

Returns

boolean (opens new window)

# canDuplicate()

Since
4.0.0

Returns whether the given user is authorized to duplicate this element.

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

View source (opens new window)

Arguments

Returns

boolean (opens new window)

# canSave()

Since
4.0.0

Returns whether the given user is authorized to save this element in its current form.

This will only be called if the element can be viewed.

View source (opens new window)

Arguments

Returns

boolean (opens new window)

# canView()

Since
4.0.0

Returns whether the given user is authorized to view this element’s edit page.

If they can view but not save, the edit form will either render statically, or be restricted to only saving changes as a draft, depending on \craft\base\canCreateDraft().

View source (opens new window)

Arguments

Returns

boolean (opens new window)

# createAnother()

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

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

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

View source (opens new window)

Returns

self, null (opens new window)

# createCondition()

Since
4.0.0

Returns an element condition for the element type.

View source (opens new window)

Returns

craft\elements\conditions\ElementConditionInterface

# 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 (opens new window)

Arguments

Returns

string (opens new window)[] – The table attribute keys

# displayName()

Returns the display name of this class.

View source (opens new window)

Returns

string (opens new window) – The display name of this class.

# eagerLoadingMap()

Returns an array that maps source-to-target element IDs based on the given sub-property handle.

This method aids in the eager-loading of elements when performing an element query. The returned array should contain the following keys:

  • elementType – the fully qualified class name of the element type that should be eager-loaded
  • map – an array of element ID mappings, where each element is a sub-array with source and target keys.
  • criteria (optional) – Any criteria parameters that should be applied to the element query when fetching the eager-loaded elements.
use craft\db\Query;
use craft\helpers\ArrayHelper;

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

View source (opens new window)

Arguments

  • $sourceElements (self[]) – An array of the source elements
  • $handle (string (opens new window)) – The property handle used to identify which target elements should be included in the map

Returns

array (opens new window), null (opens new window), false (opens new window) – 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 (opens new window)

Arguments

Returns

array (opens new window) – The available element exporters.

# extraFields()

Returns the list of fields that can be expanded further and returned by toArray() (opens new window).

This method is similar to fields() except that the list of fields returned by this method are not returned by default by toArray() (opens new window). Only when field names to be expanded are explicitly specified when calling toArray() (opens new window), 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 (opens new window)

Returns

array (opens new window) – 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 (opens new window)

Arguments

Returns

craft\models\FieldLayout[]

# fields()

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

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

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

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

For example, the following code declares four fields:

  • email: the field name is the same as the property name email;
  • firstName and lastName: the field names are firstName and lastName, and their values are obtained from the first_name and last_name properties;
  • fullName: the field name is fullName. Its value is obtained by concatenating first_name and last_name.
return [
    'email',
    'firstName' => 'first_name',
    'lastName' => 'last_name',
    'fullName' => function () {
        return $this->first_name . ' ' . $this->last_name;
    },
];

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

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

View source (opens new window)

Returns

array (opens new window) – The list of field names or field definitions.

# find()

Creates an craft\elements\db\ElementQueryInterface instance for query purpose.

The returned craft\elements\db\ElementQueryInterface instance can be further customized by calling methods defined in craft\elements\db\ElementQueryInterface before one() or all() is called to return populated craft\base\ElementInterface instances. For example,

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

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

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

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

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

View source (opens new window)

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,

// 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 (opens new window)

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,

// 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 (opens new window)

Arguments

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

Returns

static, null (opens new window) – Element instance matching the condition, or null if nothing matches.

# getAdditionalButtons()

Since
4.0.0

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

View source (opens new window)

Returns

string (opens new window)

# getAncestors()

Returns the element’s ancestors.

View source (opens new window)

Arguments

Returns

craft\elements\db\ElementQueryInterface, \Illuminate\Support\Collection

# getAttributeLabel()

Returns the text label for the specified attribute.

View source (opens new window)

Arguments

Returns

string (opens new window) – The attribute label

# getAttributeStatus()

Since
3.4.0

Returns the status of a given attribute.

View source (opens new window)

Arguments

Returns

array (opens new window), null (opens new window)

# getCacheTags()

Since
3.5.0

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

View source (opens new window)

Returns

string (opens new window)[]

# 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 (opens new window)

Arguments

Returns

self

# getCanonicalId()

Since
3.7.0

Returns the element’s canonical ID.

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

View source (opens new window)

Returns

integer (opens new window), null (opens new window)

# 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 (opens new window)

Returns

string (opens new window), null (opens new window)

# getChildren()

Returns the element’s children.

View source (opens new window)

Returns

craft\elements\db\ElementQueryInterface, \Illuminate\Support\Collection

# getContentTable()

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

View source (opens new window)

Returns

string (opens new window)

# getCpEditUrl()

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

View source (opens new window)

Returns

string (opens new window), null (opens new window)

# getCurrentRevision()

Since
3.2.0

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

View source (opens new window)

Returns

self, null (opens new window)

# getDescendants()

Returns the element’s descendants.

View source (opens new window)

Arguments

Returns

craft\elements\db\ElementQueryInterface, \Illuminate\Support\Collection

# getDirtyAttributes()

Since
3.4.0

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

View source (opens new window)

Returns

string (opens new window)[]

# getDirtyFields()

Since
3.4.0

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

View source (opens new window)

Returns

string (opens new window)[]

# getEagerLoadedElementCount()

Since
3.4.0

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

View source (opens new window)

Arguments

Returns

integer (opens new window) – The eager-loaded element count

# getEagerLoadedElements()

Returns the eager-loaded elements for a given handle.

View source (opens new window)

Arguments

Returns

\Illuminate\Support\Collection, null (opens new window) – The eager-loaded elements, or null if they hadn't been eager-loaded

# getEnabledForSite()

Since
3.4.0

Returns whether the element is enabled for the current site.

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

View source (opens new window)

Arguments

Returns

boolean (opens new window), null (opens new window) – 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 (opens new window)

Returns

string (opens new window)

# getFieldContext()

Returns the field context this element’s content uses.

View source (opens new window)

Returns

string (opens new window)

# getFieldLayout()

Returns the field layout used by this element.

View source (opens new window)

Returns

craft\models\FieldLayout, null (opens new window)

# getFieldParamNamespace()

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

View source (opens new window)

Returns

string (opens new window), null (opens new window) – The field param namespace

# getFieldValue()

Returns the value for a given field.

View source (opens new window)

Arguments

Returns

mixed – The field value

Throws

# getFieldValues()

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

View source (opens new window)

Arguments

  • $fieldHandles (string (opens new window)[], null (opens new window)) – 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 (opens new window) – The field values (handle => value)

# getGqlTypeName()

Since
3.3.0

Returns the GraphQL type name for this element type.

View source (opens new window)

Returns

string (opens new window)

# getHasCheckeredThumb()

Since
3.5.5

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

View source (opens new window)

Returns

boolean (opens new window)

# getHasDescendants()

Returns whether the element has descendants.

View source (opens new window)

Returns

boolean (opens new window)

# getHasRoundedThumb()

Since
3.5.5

Returns whether the element’s thumbnail should be rounded.

View source (opens new window)

Returns

boolean (opens new window)

# getHtmlAttributes()

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

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

TIP

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

View source (opens new window)

Arguments

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

Returns

array (opens new window)

# getId()

View source (opens new window)

# getIsCanonical()

Since
3.7.0

Returns whether this is the canonical element.

View source (opens new window)

Returns

boolean (opens new window)

# getIsDerivative()

Since
3.7.0

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

View source (opens new window)

Returns

boolean (opens new window)

# getIsDraft()

Since
3.2.0

Returns whether this is a draft.

View source (opens new window)

Returns

boolean (opens new window)

# getIsFresh()

Since
3.7.14

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

View source (opens new window)

Returns

boolean (opens new window)

# getIsHomepage()

Since
3.3.6

Returns whether this element represents the site homepage.

View source (opens new window)

Returns

boolean (opens new window)

# getIsRevision()

Since
3.2.0

Returns whether this is a revision.

View source (opens new window)

Returns

boolean (opens new window)

# 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 (opens new window)

Returns

boolean (opens new window)

# getIsUnpublishedDraft()

Since
3.6.0

Returns whether the element is an unpublished draft.

View source (opens new window)

Returns

boolean (opens new window)

# getLanguage()

Since
3.5.0

Returns the language of the element.

View source (opens new window)

Returns

string (opens new window)

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

View source (opens new window)

Returns

\Twig\Markup, null (opens new window)

# getLocalized()

Since
3.5.0

Returns the same element in other locales.

View source (opens new window)

Returns

craft\elements\db\ElementQueryInterface, \Illuminate\Support\Collection

# getMetadata()

Since
3.7.0

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

View source (opens new window)

Returns

array (opens new window) – 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 (opens new window)

Returns

string (opens new window)[]

# getModifiedFields()

Since
3.7.0

Returns the field handles that have changed for this element.

View source (opens new window)

Arguments

Returns

string (opens new window)[]

# getNext()

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

View source (opens new window)

Arguments

  • $criteria (mixed)

Returns

self, null (opens new window)

# getNextSibling()

Returns the element’s next sibling.

View source (opens new window)

Returns

self, null (opens new window)

# 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 (opens new window)

Returns

string (opens new window)[]

# 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 (opens new window)

Returns

string (opens new window)[]

# getParent()

Returns the element’s parent.

View source (opens new window)

Returns

self, null (opens new window)

# getParentId()

Since
4.0.0

Returns the parent ID.

View source (opens new window)

Returns

integer (opens new window), null (opens new window)

# 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 (opens new window)

Returns

string (opens new window), null (opens new window)

# getPostEditUrl()

Since
4.0.0

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

View source (opens new window)

Returns

string (opens new window), null (opens new window)

# getPrev()

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

View source (opens new window)

Arguments

  • $criteria (mixed)

Returns

self, null (opens new window)

# getPrevSibling()

Returns the element’s previous sibling.

View source (opens new window)

Returns

self, null (opens new window)

# 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 (opens new window)

Returns

array (opens new window)

# getRef()

Returns the reference string to this element.

View source (opens new window)

Returns

string (opens new window), null (opens new window)

# 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 (opens new window)

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 (opens new window)

Arguments

Returns

string (opens new window)

# getSerializedFieldValues()

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

View source (opens new window)

Arguments

  • $fieldHandles (string (opens new window)[], null (opens new window)) – 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 (opens new window)

# getSiblings()

Returns all of the element’s siblings.

View source (opens new window)

Returns

craft\elements\db\ElementQueryInterface, \Illuminate\Support\Collection

# getSidebarHtml()

Since
3.7.0

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

View source (opens new window)

Arguments

Returns

string (opens new window)

# getSite()

Returns the site the element is associated with.

View source (opens new window)

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 (opens new window)

Returns

integer (opens new window), null (opens new window)

# getSourceUid()

DEPRECATED

Deprecated in 3.7.0. Use getCanonicalUid() instead.

Since
3.2.0

Returns the element’s canonical UID.

View source (opens new window)

Returns

string (opens new window)

# getStatus()

Returns the element’s status.

View source (opens new window)

Returns

string (opens new window), null (opens new window)

# 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 (opens new window)

Returns

array (opens new window)

# 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 (opens new window)

Arguments

Returns

string (opens new window) – The HTML that should be shown for a given attribute in Table View.

# getThumbAlt()

Since
4.0.0

Returns alt text for the element’s thumbnail.

View source (opens new window)

Returns

string (opens new window), null (opens new window)

# getThumbUrl()

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

View source (opens new window)

Arguments

Returns

string (opens new window), null (opens new window)

# getTitleTranslationDescription()

Since
3.5.0

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

View source (opens new window)

Returns

string (opens new window), null (opens new window)

# getTitleTranslationKey()

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 (opens new window)

Returns

string (opens new window) – The translation key

# getTotalDescendants()

Returns the total number of descendants that the element has.

View source (opens new window)

Returns

integer (opens new window)

# getUiLabel()

Since
3.2.0

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

View source (opens new window)

Returns

string (opens new window)

# 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 (opens new window)

Returns

string (opens new window), null (opens new window)

# getUrl()

Returns the element’s full URL.

View source (opens new window)

Returns

string (opens new window), null (opens new window)

# gqlMutationNameByContext()

Since
3.5.0

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

View source (opens new window)

Arguments

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

Returns

string (opens new window)

# gqlScopesByContext()

Since
3.3.0

Returns the GraphQL scopes required by element’s context.

View source (opens new window)

Arguments

  • $context (mixed) – The element’s context, such as a Volume, Entry Type or Matrix Block Type.

Returns

array (opens new window)

# gqlTypeNameByContext()

Since
3.3.0

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

View source (opens new window)

Arguments

  • $context (mixed) – The element’s context, such as a Volume, Entry Type or Matrix Block Type.

Returns

string (opens new window)

# hasContent()

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

View source (opens new window)

Returns

boolean (opens new window) – 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 (opens new window)

Arguments

Returns

boolean (opens new window) – Whether elements have been eager-loaded with the given handle

# hasRevisions()

Since
4.0.0

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

View source (opens new window)

Returns

boolean (opens new window)

# 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 (opens new window)

Returns

boolean (opens new window) – Whether elements of this type have statuses.

# hasTitles()

Returns whether elements of this type have traditional titles.

View source (opens new window)

Returns

boolean (opens new window) – 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 (opens new window)

Returns

boolean (opens new window) – Whether elements of this type can have their own slugs and URIs.

# indexHtml()

Returns the element index HTML.

View source (opens new window)

Arguments

Returns

string (opens new window) – 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 (opens new window)

# isAncestorOf()

Returns whether this element is an ancestor of another one.

View source (opens new window)

Arguments

  • $element (self)

Returns

boolean (opens new window)

# isAttributeDirty()

Since
3.5.0

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

View source (opens new window)

Arguments

Returns

boolean (opens new window)

# isAttributeModified()

Since
3.7.0

Returns whether an attribute value has changed for this element.

View source (opens new window)

Arguments

Returns

boolean (opens new window)

# isAttributeOutdated()

Since
3.7.0

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

View source (opens new window)

Arguments

Returns

boolean (opens new window)

# isChildOf()

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

View source (opens new window)

Arguments

  • $element (self)

Returns

boolean (opens new window)

# isDescendantOf()

Returns whether this element is a descendant of another one.

View source (opens new window)

Arguments

  • $element (self)

Returns

boolean (opens new window)

# isFieldDirty()

Since
3.4.0

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

View source (opens new window)

Arguments

Returns

boolean (opens new window)

# isFieldEmpty()

Returns whether a field is empty.

View source (opens new window)

Arguments

Returns

boolean (opens new window)

# isFieldModified()

Since
3.7.0

Returns whether a field value has changed for this element.

View source (opens new window)

Arguments

Returns

boolean (opens new window)

# isFieldOutdated()

Since
3.7.0

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

View source (opens new window)

Arguments

Returns

boolean (opens new window)

# 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 (opens new window)

Returns

boolean (opens new window) – 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 (opens new window)

Arguments

  • $element (self)

Returns

boolean (opens new window)

# isParentOf()

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

View source (opens new window)

Arguments

  • $element (self)

Returns

boolean (opens new window)

# isPrevSiblingOf()

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

View source (opens new window)

Arguments

  • $element (self)

Returns

boolean (opens new window)

# isSiblingOf()

Returns whether this element is a sibling of another one.

View source (opens new window)

Arguments

  • $element (self)

Returns

boolean (opens new window)

# lowerDisplayName()

Since
3.3.17

Returns the lowercase version of displayName().

View source (opens new window)

Returns

string (opens new window)

# markAsClean()

Since
3.4.0

Resets the record of dirty attributes and fields.

View source (opens new window)

# markAsDirty()

Since
3.4.10

Marks all fields and attributes as dirty.

View source (opens new window)

# mergeCanonicalChanges()

Since
3.7.0

Merges changes from the canonical element into this one.

View source (opens new window)

# offsetExists()

Returns whether there is an element at the specified offset.

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

View source (opens new window)

Arguments

Returns

boolean (opens new window) – Whether or not an offset exists.

# pluralDisplayName()

Since
3.2.0

Returns the plural version of displayName().

View source (opens new window)

Returns

string (opens new window)

# pluralLowerDisplayName()

Since
3.3.17

Returns the plural, lowercase version of displayName().

View source (opens new window)

Returns

string (opens new window)

# prepareEditScreen()

Since
4.0.0

Prepares the response for the element’s Edit screen.

View source (opens new window)

Arguments

# refHandle()

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

View source (opens new window)

Returns

string (opens new window), null (opens new window) – 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:

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 (opens new window)

Returns

string (opens new window)[] – The element attributes that should be searchable

# setCanonical()

Since
3.7.0

Sets the canonical version of the element.

View source (opens new window)

Arguments

  • $element (self)

# setCanonicalId()

Since
3.7.0

Sets the element’s canonical ID.

View source (opens new window)

Arguments

# setDirtyAttributes()

Since
3.5.0

Sets the list of dirty attribute names.

View source (opens new window)

Arguments

# setEagerLoadedElementCount()

Since
3.4.0

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

View source (opens new window)

Arguments

# setEagerLoadedElements()

Sets some eager-loaded elements on a given handle.

View source (opens new window)

Arguments

  • $handle (string (opens new window)) – The handle that was used to eager-load the elements
  • $elements (self[]) – The eager-loaded elements

# 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 (opens new window)

Arguments

# setFieldParamNamespace()

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

View source (opens new window)

Arguments

# setFieldValue()

Sets the value for a given field.

View source (opens new window)

Arguments

  • $fieldHandle (string (opens new window)) – 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 (opens new window)

Arguments

# setFieldValuesFromRequest()

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

View source (opens new window)

Arguments

# setIsFresh()

Since
3.7.14

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

View source (opens new window)

Arguments

# setNext()

Sets the default next element.

View source (opens new window)

Arguments

# setParent()

Sets the element’s parent.

View source (opens new window)

Arguments

# setParentId()

Since
4.0.0

Sets the parent ID.

View source (opens new window)

Arguments

# setPrev()

Sets the default previous element.

View source (opens new window)

Arguments

# setRevisionCreatorId()

Since
3.2.0

Sets the revision creator ID to be saved.

View source (opens new window)

Arguments

# setRevisionNotes()

Since
3.2.0

Sets the revision notes to be saved.

View source (opens new window)

Arguments

# setUiLabel()

Since
3.6.3

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

View source (opens new window)

Arguments

# sortOptions()

Returns the sort options for the element type.

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

  • label – The sort option label
  • orderBy – An array, comma-delimited string, or a callback function that defines the columns to order the query by. If set to a callback function, the function will be passed two arguments: $dir (either SORT_ASC or SORT_DESC) and $db (a craft\db\Connection object), and it should return an array of column names or an yii\db\ExpressionInterface (opens new window) 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.
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.

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 (opens new window)

Returns

array (opens new window) – The attributes that elements can be sorted by

# 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 (opens new window)

Arguments

Returns

array (opens new window) – 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 (opens new window)

Returns

array (opens new window)

# tableAttributes()

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

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

View source (opens new window)

Returns

array (opens new window) – 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 (opens new window)

Returns

boolean (opens new window) – 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 (opens new window) if a custom field specified a closure or the name of a class-level method as the validation type.

View source (opens new window)

Arguments

# Protected Methods

Method Description
cacheTags() Returns the cache tags that should be cleared when this element is saved.
cpEditUrl() Returns the element’s edit URL in the control panel.
defineActions() Defines the available element actions for a given source.
defineBehaviors() Returns the behaviors to attach to this class.
defineDefaultTableAttributes() Returns the list of table attribute keys that should be shown by default.
defineExporters() Defines the available element exporters for a given source.
defineFieldLayouts() Defines the field layouts associated with elements for a given source.
defineRules() Returns the validation rules for attributes.
defineSearchableAttributes() Defines which element attributes should be searchable.
defineSortOptions() Returns the sort options for the element type.
defineSources() Defines the sources that elements of this type may belong to.
defineTableAttributes() Defines all of the available columns that can be shown in table views.
extractFieldsFor() (opens new window) 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() (opens new window) Extracts the root field names from nested fields.
fieldByHandle() Returns the field with a given handle.
fieldLayoutFields() Returns each of this element’s fields.
findByCondition() Finds Element instance(s) by the given condition.
hasFieldLayout() Returns whether the element has a field layout with at least one tab.
hasNewParent() Returns whether the element has been assigned a new parent.
htmlAttributes() Returns any attributes that should be included in the element’s DOM representation in the control panel.
metaFieldsHtml() Returns the HTML for any meta fields that should be shown within the editor sidebar.
metadata() Returns element metadata that should be shown within the editor sidebar.
normalizeFieldValue() Normalizes a field’s value.
notesFieldHtml() Returns the notes field HTML for the sidebar.
prepElementQueryForTableAttribute() Preps the element criteria for a given table attribute
previewTargets() Returns the additional locations that should be available for previewing the element, besides its primary URL.
resolveFields() (opens new window) Determines which fields can be returned by toArray() (opens new window).
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.
statusFieldHtml() Returns the status field HTML for the sidebar.
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.

# cacheTags()

Since
4.1.0

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

View source (opens new window)

Returns

string (opens new window)[]

# cpEditUrl()

Since
3.7.0

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

View source (opens new window)

Returns

string (opens new window), null (opens new window)

# defineActions()

Defines the available element actions for a given source.

See also actions() View source (opens new window)

Arguments

Returns

array (opens new window) – The available element actions.

# defineBehaviors()

Since
4.0.0

Returns the behaviors to attach to this class.

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

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

View source (opens new window)

Returns

array (opens new window)

# defineDefaultTableAttributes()

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

See also:

View source (opens new window)

Arguments

Returns

string (opens new window)[] – The table attributes.

# defineExporters()

Since
3.4.0

Defines the available element exporters for a given source.

See also exporters() View source (opens new window)

Arguments

Returns

array (opens new window) – 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 (opens new window)

Arguments

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 (opens new window)

Returns

array (opens new window)

# defineSearchableAttributes()

Defines which element attributes should be searchable.

See also searchableAttributes() View source (opens new window)

Returns

string (opens new window)[] – The element attributes that should be searchable

# defineSortOptions()

Returns the sort options for the element type.

See also sortOptions() View source (opens new window)

Returns

array (opens new window) – 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 (opens new window)

Arguments

Returns

array (opens new window) – The sources.

# defineTableAttributes()

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

See also tableAttributes() View source (opens new window)

Returns

array (opens new window) – The table attributes.

# fieldByHandle()

Returns the field with a given handle.

View source (opens new window)

Arguments

Returns

craft\base\FieldInterface, null (opens new window)

# fieldLayoutFields()

Returns each of this element’s fields.

View source (opens new window)

Arguments

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 (opens new window)

Arguments

Returns

static, static[], null (opens new window)

# hasFieldLayout()

Since
3.7.0

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

View source (opens new window)

Returns

boolean (opens new window) – Returns whether the element has a field layout with at least one tab.

# hasNewParent()

Returns whether the element has been assigned a new parent.

View source (opens new window)

Returns

boolean (opens new window)

# htmlAttributes()

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

See also getHtmlAttributes() View source (opens new window)

Arguments

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

Returns

array (opens new window)

# metaFieldsHtml()

Since
3.7.0

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

View source (opens new window)

Arguments

Returns

string (opens new window)

# metadata()

Since
3.7.0

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

View source (opens new window)

Returns

array (opens new window) – 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 (opens new window)

Arguments

Throws

# notesFieldHtml()

Since
4.0.0

Returns the notes field HTML for the sidebar.

View source (opens new window)

Returns

string (opens new window)

# prepElementQueryForTableAttribute()

Preps the element criteria for a given table attribute

View source (opens new window)

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 (opens new window)

Returns

array (opens new window)

# route()

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

See also getRoute() View source (opens new window)

Returns

string (opens new window), array (opens new window), null (opens new window) – 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 (opens new window)

Arguments

Returns

string (opens new window)

# slugFieldHtml()

Since
3.7.0

Returns the HTML for the element’s Slug field.

View source (opens new window)

Arguments

Returns

string (opens new window)

# statusFieldHtml()

Since
4.0.0

Returns the status field HTML for the sidebar.

View source (opens new window)

Returns

string (opens new window)

# tableAttributeHtml()

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

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

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

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

WARNING

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

Arguments

Returns

string (opens new window) – 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 (opens new window)

Returns

string (opens new window), null (opens new window)

# Constants

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

# Events

# EVENT_AFTER_DELETE

Type
yii\base\Event (opens new window)

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:

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 (opens new window)
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:

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

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

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

    // ...
});

# EVENT_AUTHORIZE_CREATE_DRAFTS

Type
craft\events\AuthorizationCheckEvent
Since
4.0.0

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

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

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

See also canCreateDrafts()

# EVENT_AUTHORIZE_DELETE

Type
craft\events\AuthorizationCheckEvent
Since
4.0.0

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

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

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

See also canDelete()

# EVENT_AUTHORIZE_DELETE_FOR_SITE

Type
craft\events\AuthorizationCheckEvent
Since
4.0.0

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

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

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

See also canDeleteForSite()

# EVENT_AUTHORIZE_DUPLICATE

Type
craft\events\AuthorizationCheckEvent
Since
4.0.0

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

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

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

See also canDuplicate()

# EVENT_AUTHORIZE_SAVE

Type
craft\events\AuthorizationCheckEvent
Since
4.0.0

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

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

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

See also canSave()

# EVENT_AUTHORIZE_VIEW

Type
craft\events\AuthorizationCheckEvent
Since
4.0.0

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

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

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

See also canView()

# EVENT_BEFORE_DELETE

Type
craft\events\ModelEvent

The event that is triggered before the element is deleted.

You may set yii\base\ModelEvent::$isValid (opens new window) 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 (opens new window) 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 (opens new window) 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 (opens new window) 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:

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_ADDITIONAL_BUTTONS

Type
craft\events\DefineHtmlEvent
Since
4.0.0

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

See also getAdditionalButtons()

# EVENT_DEFINE_CACHE_TAGS

Type
craft\events\DefineValueEvent
Since
4.1.0

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

See also getCacheTags()

# EVENT_DEFINE_EAGER_LOADING_MAP

Type
craft\events\DefineEagerLoadingMapEvent
Since
3.1.0

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

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_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 (opens new window) to true if you want the element to accept your custom $keywords value.

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

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 (opens new window) 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 (opens new window) to true to explicitly tell the element that a route has been set (even if you’re setting it to null).

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.