Craft 4 Class Reference

Appearance

ElementInterface ​

Type
Interface
Namespace
craft\base
Extends
craft\base\ComponentInterface
Implemented by
craft\base\Element, 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

ElementInterface defines the common interface to be implemented by element classes.

A class implementing this interface should also use craft\base\ElementTrait.

View source

Public Methods ​

MethodDescription
__toString()Returns the string representation of the element.
actions()Returns the available element actions for a given source.
afterDelete()Performs actions after an element is deleted.
afterDeleteForSite()Performs actions after an element is deleted for a site.
afterMoveInStructure()Performs actions after an element is moved within a structure.
afterPropagate()Performs actions after an element is fully saved and propagated to other sites.
afterRestore()Performs actions after an element is restored.
afterSave()Performs actions after an element is saved.
beforeDelete()Performs actions before an element is deleted.
beforeDeleteForSite()Performs actions before an element is deleted for a site.
beforeMoveInStructure()Performs actions before an element is moved within a structure.
beforeRestore()Performs actions before an element is restored.
beforeSave()Performs actions before an element is saved.
canCreateDrafts()Returns whether the given user is authorized to create drafts for this element.
canDelete()Returns whether the given user is authorized to delete this element.
canDeleteForSite()Returns whether the given user is authorized to delete this element for its current site.
canDuplicate()Returns whether the given user is authorized to duplicate this element.
canSave()Returns whether the given user is authorized to save this element in its current form.
canView()Returns whether the given user is authorized to view this element’s edit page.
createAnother()Creates a new element (without saving it) based on this one.
createCondition()Returns an element condition for the element type.
defaultTableAttributes()Returns the list of table attribute keys that should be shown by default.
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.
exporters()Returns the available export options for a given source.
extraFields()Returns the list of additional fields that can be returned by toArray() in addition to those listed in fields().
fieldLayouts()Returns all of the field layouts associated with elements from the given source.
fields()Returns the list of fields that should be returned by default by toArray() when no specific fields are specified.
find()Creates an craft\elements\db\ElementQueryInterface instance for query purpose.
findAll()Returns a list of elements that match the specified ID(s) or a set of element criteria parameters.
findOne()Returns a single element instance by a primary key or a set of element criteria parameters.
findSource()Returns a source definition by a given source key/path and context.
getAdditionalButtons()Returns additional buttons that should be shown at the top of the element’s edit page.
getAncestors()Returns the element’s ancestors.
getAttributeStatus()Returns the status of a given attribute.
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.
getCpRevisionsUrl()Returns the element’s revisions index URL in the control panel.
getCurrentRevision()Returns the element’s current revision, if one exists.
getDescendants()Returns the element’s descendants.
getDirtyAttributes()Returns a list of attribute names that have changed since the element was first loaded.
getDirtyFields()Returns a list of custom field handles that have changed since the element was first loaded.
getEagerLoadedElementCount()Returns the count of eager-loaded elements for a given handle.
getEagerLoadedElements()Returns the eager-loaded elements for a given handle.
getEnabledForSite()Returns whether the element is enabled for the current site.
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.
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.
getIsCanonical()Returns whether this is the canonical element.
getIsDerivative()Returns whether this is a derivative element, such as a draft or revision.
getIsDraft()Returns whether this is a draft.
getIsFresh()Returns whether the element is "fresh" (not yet explicitly saved, and without validation errors).
getIsHomepage()Returns whether this element represents the site homepage.
getIsRevision()Returns whether this is a revision.
getIsSlugTranslatable()Returns whether the Slug field should be shown as translatable in the UI.
getIsTitleTranslatable()Returns whether the Title field should be shown as translatable in the UI.
getIsUnpublishedDraft()Returns whether the element is an unpublished draft.
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.
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.
getSearchKeywords()Returns the search keywords for a given search attribute.
getSerializedFieldValues()Returns an array of the element’s serialized custom field values, indexed by their handles.
getSiblings()Returns all of the element’s siblings.
getSidebarHtml()Returns the HTML for any fields/info that should be shown within the editor sidebar.
getSite()Returns the site the element is associated with.
getSlugTranslationDescription()Returns the description of the Slug field’s translation support.
getSlugTranslationKey()Returns the Slug’s translation key.
getStatus()Returns the element’s status.
getSupportedSites()Returns the sites this element is associated with.
getTableAttributeHtml()Returns the HTML that should be shown for a given attribute in Table View.
getThumbAlt()Returns alt text for the element’s thumbnail.
getThumbHtml()Returns the HTML for the element’s thumbnail, if it has one.
getThumbUrl()Returns the URL to the element’s thumbnail, if it has one.
getTitleTranslationDescription()Returns the description of the Title field’s translation support.
getTitleTranslationKey()Returns the Title’s translation key.
getTotalDescendants()Returns the total number of descendants that the element has.
getUiLabel()Returns what the element should be called within the control panel.
getUiLabelPath()Returns any path segment labels that should be prepended to the element’s UI label.
getUriFormat()Returns the URI format used to generate this element’s URI.
getUrl()Returns the element’s full URL.
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.
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.
indexElementCount()Returns the total number of elements that will be shown on an element index, for the given element query.
indexHtml()Returns the element index HTML.
instance()Returns static class instance, which can be used to obtain meta information.
isAncestorOf()Returns whether this element is an ancestor of another one.
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.
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.
lowerDisplayName()Returns the lowercase version of displayName().
markAsClean()Resets the record of dirty attributes and fields.
markAsDirty()Marks all fields and attributes as dirty.
mergeCanonicalChanges()Merges changes from the canonical element into this one.
modifyCustomSource()Modifies a custom source’s config, before it’s returned by craft\services\ElementSources::getSources()
offsetExists()Treats custom fields as array offsets.
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.
searchableAttributes()Defines which element attributes should be searchable.
setCanonical()Sets the canonical version of the element.
setCanonicalId()Sets the element’s canonical ID.
setDirtyAttributes()Sets the list of dirty attribute names.
setDirtyFields()Sets the list of dirty field handles.
setEagerLoadedElementCount()Sets the count of eager-loaded elements for a given handle.
setEagerLoadedElements()Sets some eager-loaded elements on a given handle.
setEnabledForSite()Sets whether the element is enabled for the current site.
setFieldParamNamespace()Sets the namespace used by custom field params on the request.
setFieldValue()Sets the value for a given field.
setFieldValueFromRequest()Sets the value for a given field. The value should have originated from post data.
setFieldValues()Sets the element’s custom field values.
setFieldValuesFromRequest()Sets the element’s custom field values, when the values have come from post data.
setIsFresh()Sets whether the element is "fresh" (not yet explicitly saved, and without validation errors).
setNext()Sets the default next element.
setParent()Sets the element’s parent.
setPrev()Sets the default previous element.
setRevisionCreatorId()Sets the revision creator ID to be saved.
setRevisionNotes()Sets the revision notes to be saved.
setUiLabel()Defines what the element should be called within the control panel.
setUiLabelPath()Defines any path segment labels that should be prepended to the element’s UI label.
sortOptions()Returns the sort options for the element type.
sourcePath()Returns the source path for a given source key, step key, and context.
sources()Returns the source definitions that elements of this type may belong to.
statuses()Returns all of the possible statuses that elements of this type may have.
tableAttributes()Defines all of the available columns that can be shown in table views.
toArray()Converts the object 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.

__toString() ​

Returns the string representation of the element.

View source

actions() ​

Returns the available element actions for a given source.

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

TIP

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

View source

Arguments ​

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

Returns ​

array – The available element actions.

afterDelete() ​

Performs actions after an element is deleted.

View source

afterDeleteForSite() ​

Since
4.7.0

Performs actions after an element is deleted for a site.

View source

afterMoveInStructure() ​

DEPRECATED

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

Performs actions after an element is moved within a structure.

View source

Arguments ​

  • $structureId (integer) – The structure ID

afterPropagate() ​

Since
3.2.0

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

TIP

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

View source

Arguments ​

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

afterRestore() ​

Since
3.1.0

Performs actions after an element is restored.

View source

afterSave() ​

Performs actions after an element is saved.

View source

Arguments ​

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

beforeDelete() ​

Performs actions before an element is deleted.

View source

Returns ​

boolean – Whether the element should be deleted

beforeDeleteForSite() ​

Since
4.7.0

Performs actions before an element is deleted for a site.

View source

Returns ​

boolean – Whether the element should be deleted

beforeMoveInStructure() ​

DEPRECATED

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

Performs actions before an element is moved within a structure.

View source

Arguments ​

  • $structureId (integer) – The structure ID

Returns ​

boolean – Whether the element should be moved within the structure

beforeRestore() ​

Since
3.1.0

Performs actions before an element is restored.

View source

Returns ​

boolean – Whether the element should be restored

beforeSave() ​

Performs actions before an element is saved.

View source

Arguments ​

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

Returns ​

boolean – Whether the element should be saved

canCreateDrafts() ​

Since
4.0.0

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

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

TIP

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

View source

Arguments ​

Returns ​

boolean

canDelete() ​

Since
4.0.0

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

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

View source

Arguments ​

Returns ​

boolean

canDeleteForSite() ​

Since
4.0.0

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

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

View source

Arguments ​

Returns ​

boolean

canDuplicate() ​

Since
4.0.0

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

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

View source

Arguments ​

Returns ​

boolean

canSave() ​

Since
4.0.0

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

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

View source

Arguments ​

Returns ​

boolean

canView() ​

Since
4.0.0

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

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

View source

Arguments ​

Returns ​

boolean

createAnother() ​

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

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

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

View source

Returns ​

self, null

createCondition() ​

Since
4.0.0

Returns an element condition for the element type.

View source

Returns ​

craft\elements\conditions\ElementConditionInterface

defaultTableAttributes() ​

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

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

View source

Arguments ​

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

Returns ​

string[] – The table attribute keys

eagerLoadingMap() ​

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

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

  • elementType – the fully qualified class name of the element type that should be eager-loaded
  • map – an array of element ID mappings, where each element is a sub-array with source and target keys
  • criteria (optional) – any criteria parameters that should be applied to the element query when fetching the eager-loaded elements
  • createElement (optional) - an element factory function, which will be passed the element query, the current query result data, and the first source element that the result was eager-loaded for
php
use craft\base\ElementInterface;
use craft\db\Query;

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

View source

Arguments ​

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

Returns ​

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

exporters() ​

Since
3.4.0

Returns the available export options for a given source.

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

TIP

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

View source

Arguments ​

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

Returns ​

array – The available element exporters.

fieldLayouts() ​

Since
3.5.0

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

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

View source

Arguments ​

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

Returns ​

craft\models\FieldLayout[]

find() ​

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

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

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

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

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

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

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

View source

Returns ​

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

findAll() ​

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

The method accepts:

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

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

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

View source

Arguments ​

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

Returns ​

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

findOne() ​

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

The method accepts:

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

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

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

View source

Arguments ​

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

Returns ​

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

findSource() ​

Since
4.4.0

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

View source

Arguments ​

Returns ​

array, null

getAdditionalButtons() ​

Since
4.0.0

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

View source

Returns ​

string

getAncestors() ​

Returns the element’s ancestors.

View source

Arguments ​

Returns ​

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

getAttributeStatus() ​

Since
3.4.0

Returns the status of a given attribute.

View source

Arguments ​

Returns ​

array, null

getCacheTags() ​

Since
3.5.0

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

View source

Returns ​

string[]

getCanonical() ​

Since
3.7.0

Returns the canonical version of the element.

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

View source

Arguments ​

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

Returns ​

self

getCanonicalId() ​

Since
3.7.0

Returns the element’s canonical ID.

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

View source

Returns ​

integer, null

getCanonicalUid() ​

Since
3.7.11

Returns the element’s canonical UUID.

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

View source

Returns ​

string, null

getChildren() ​

Returns the element’s children.

View source

Returns ​

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

getContentTable() ​

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

View source

Returns ​

string

getCpEditUrl() ​

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

View source

Returns ​

string, null

getCpRevisionsUrl() ​

Since
4.4.0

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

View source

Returns ​

string, null

getCurrentRevision() ​

Since
3.2.0

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

View source

Returns ​

self, null

getDescendants() ​

Returns the element’s descendants.

View source

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

Returns ​

string[]

getDirtyFields() ​

Since
3.4.0

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

View source

Returns ​

string[]

getEagerLoadedElementCount() ​

Since
3.4.0

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

View source

Arguments ​

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

Returns ​

integer – The eager-loaded element count

getEagerLoadedElements() ​

Returns the eager-loaded elements for a given handle.

View source

Arguments ​

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

Returns ​

\Illuminate\Support\Collection, null – The eager-loaded elements, or null if they hadn't been eager-loaded

getEnabledForSite() ​

Since
3.4.0

Returns whether the element is enabled for the current site.

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

View source

Arguments ​

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

Returns ​

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

getFieldColumnPrefix() ​

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

View source

Returns ​

string

getFieldContext() ​

Returns the field context this element’s content uses.

View source

Returns ​

string

getFieldLayout() ​

Returns the field layout used by this element.

View source

Returns ​

craft\models\FieldLayout, null

getFieldParamNamespace() ​

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

View source

Returns ​

string, null – The field param namespace

getFieldValue() ​

Returns the value for a given field.

View source

Arguments ​

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

Returns ​

mixed – The field value

Throws ​

getFieldValues() ​

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

View source

Arguments ​

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

Returns ​

array – The field values (handle => value)

getGqlTypeName() ​

Since
3.3.0

Returns the GraphQL type name for this element type.

View source

Returns ​

string

getHasCheckeredThumb() ​

Since
3.5.5

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

View source

Returns ​

boolean

getHasDescendants() ​

Returns whether the element has descendants.

View source

Returns ​

boolean

getHasRoundedThumb() ​

Since
3.5.5

Returns whether the element’s thumbnail should be rounded.

View source

Returns ​

boolean

getHtmlAttributes() ​

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

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

TIP

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

View source

Arguments ​

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

Returns ​

array

getIsCanonical() ​

Since
3.7.0

Returns whether this is the canonical element.

View source

Returns ​

boolean

getIsDerivative() ​

Since
3.7.0

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

View source

Returns ​

boolean

getIsDraft() ​

Since
3.2.0

Returns whether this is a draft.

View source

Returns ​

boolean

getIsFresh() ​

Since
3.7.14

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

View source

Returns ​

boolean

getIsHomepage() ​

Since
3.3.6

Returns whether this element represents the site homepage.

View source

Returns ​

boolean

getIsRevision() ​

Since
3.2.0

Returns whether this is a revision.

View source

Returns ​

boolean

getIsSlugTranslatable() ​

Since
4.5.0

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

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

View source

Returns ​

boolean

getIsTitleTranslatable() ​

Since
3.5.0

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

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

View source

Returns ​

boolean

getIsUnpublishedDraft() ​

Since
3.6.0

Returns whether the element is an unpublished draft.

View source

Returns ​

boolean

getLanguage() ​

Since
3.5.0

Returns the language of the element.

View source

Returns ​

string

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

View source

Returns ​

\Twig\Markup, null

getLocalized() ​

Returns the same element in other locales.

View source

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

Returns ​

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

getModifiedAttributes() ​

Since
3.7.0

Returns the attribute names that have changed for this element.

View source

Returns ​

string[]

getModifiedFields() ​

Since
3.7.0

Returns the field handles that have changed for this element.

View source

Arguments ​

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

Returns ​

string[]

getNext() ​

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

View source

Arguments ​

  • $criteria (mixed)

Returns ​

self, null

getNextSibling() ​

Returns the element’s next sibling.

View source

Returns ​

self, null

getOutdatedAttributes() ​

Since
3.7.0

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

View source

Returns ​

string[]

getOutdatedFields() ​

Since
3.7.0

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

View source

Returns ​

string[]

getParent() ​

Returns the element’s parent.

View source

Returns ​

self, null

getParentUri() ​

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

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

View source

Returns ​

string, null

getPostEditUrl() ​

Since
4.0.0

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

View source

Returns ​

string, null

getPrev() ​

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

View source

Arguments ​

  • $criteria (mixed)

Returns ​

self, null

getPrevSibling() ​

Returns the element’s previous sibling.

View source

Returns ​

self, null

getPreviewTargets() ​

Since
3.2.0

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

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

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

TIP

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

View source

Returns ​

array

getRef() ​

Returns the reference string to this element.

View source

Returns ​

string, null

getRoute() ​

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

TIP

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

View source

Returns ​

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

getSearchKeywords() ​

Returns the search keywords for a given search attribute.

View source

Arguments ​

Returns ​

string

getSerializedFieldValues() ​

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

View source

Arguments ​

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

Returns ​

array

getSiblings() ​

Returns all of the element’s siblings.

View source

Returns ​

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

Arguments ​

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

Returns ​

string

getSite() ​

Returns the site the element is associated with.

View source

Returns ​

craft\models\Site

getSlugTranslationDescription() ​

Since
4.5.0

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

View source

Returns ​

string, null

getSlugTranslationKey() ​

Since
4.5.0

Returns the Slug’s translation key.

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

View source

Returns ​

string – The translation key

getStatus() ​

Returns the element’s status.

View source

Returns ​

string, null

getSupportedSites() ​

Returns the sites this element is associated with.

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

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

View source

Returns ​

array

getTableAttributeHtml() ​

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

TIP

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

View source

Arguments ​

  • $attribute (string) – The attribute name.

Returns ​

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

getThumbAlt() ​

Since
4.0.0

Returns alt text for the element’s thumbnail.

View source

Returns ​

string, null

getThumbHtml() ​

Since
4.5.0

Returns the HTML for the element’s thumbnail, if it has one.

View source

Arguments ​

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

Returns ​

string, null

getThumbUrl() ​

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

View source

Arguments ​

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

Returns ​

string, null

getTitleTranslationDescription() ​

Since
3.5.0

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

View source

Returns ​

string, null

getTitleTranslationKey() ​

Since
3.5.0

Returns the Title’s translation key.

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

View source

Returns ​

string – The translation key

getTotalDescendants() ​

Returns the total number of descendants that the element has.

View source

Returns ​

integer

getUiLabel() ​

Since
3.2.0

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

View source

Returns ​

string

getUiLabelPath() ​

Since
4.4.0

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

View source

Returns ​

string[]

getUriFormat() ​

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

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

See also:

View source

Returns ​

string, null

getUrl() ​

Returns the element’s full URL.

View source

Returns ​

string, null

gqlMutationNameByContext() ​

Since
3.5.0

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

View source

Arguments ​

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

Returns ​

string

gqlScopesByContext() ​

Since
3.3.0

Returns the GraphQL scopes required by element’s context.

View source

Arguments ​

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

Returns ​

array

gqlTypeNameByContext() ​

Since
3.3.0

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

View source

Arguments ​

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

Returns ​

string

hasContent() ​

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

View source

Returns ​

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

hasEagerLoadedElements() ​

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

View source

Arguments ​

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

Returns ​

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

hasRevisions() ​

Since
4.0.0

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

View source

Returns ​

boolean

hasStatuses() ​

Returns whether elements of this type have statuses.

If this returns true, the element index template will show a Status menu by default, and your elements will get status indicator icons next to them. Use statuses() to customize which statuses the elements might have.

See also statuses()View source

Returns ​

boolean – Whether elements of this type have statuses.

hasTitles() ​

Returns whether elements of this type have traditional titles.

View source

Returns ​

boolean – Whether elements of this type have traditional titles.

hasUris() ​

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

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

See also getUriFormat()View source

Returns ​

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

indexElementCount() ​

Since
4.4.0

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

View source

Arguments ​

Returns ​

integer

indexHtml() ​

Returns the element index HTML.

View source

Arguments ​

Returns ​

string – The element index HTML

isAncestorOf() ​

Returns whether this element is an ancestor of another one.

View source

Arguments ​

  • $element (self)

Returns ​

boolean

isAttributeDirty() ​

Since
3.5.0

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

View source

Arguments ​

Returns ​

boolean

isAttributeModified() ​

Since
3.7.0

Returns whether an attribute value has changed for this element.

View source

Arguments ​

Returns ​

boolean

isAttributeOutdated() ​

Since
3.7.0

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

View source

Arguments ​

Returns ​

boolean

isChildOf() ​

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

View source

Arguments ​

  • $element (self)

Returns ​

boolean

isDescendantOf() ​

Returns whether this element is a descendant of another one.

View source

Arguments ​

  • $element (self)

Returns ​

boolean

isFieldDirty() ​

Since
3.4.0

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

View source

Arguments ​

Returns ​

boolean

isFieldEmpty() ​

Returns whether a field is empty.

View source

Arguments ​

Returns ​

boolean

isFieldModified() ​

Since
3.7.0

Returns whether a field value has changed for this element.

View source

Arguments ​

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

Returns ​

boolean

isFieldOutdated() ​

Since
3.7.0

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

View source

Arguments ​

Returns ​

boolean

isLocalized() ​

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

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

View source

Returns ​

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

isNextSiblingOf() ​

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

View source

Arguments ​

  • $element (self)

Returns ​

boolean

isParentOf() ​

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

View source

Arguments ​

  • $element (self)

Returns ​

boolean

isPrevSiblingOf() ​

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

View source

Arguments ​

  • $element (self)

Returns ​

boolean

isSiblingOf() ​

Returns whether this element is a sibling of another one.

View source

Arguments ​

  • $element (self)

Returns ​

boolean

lowerDisplayName() ​

Since
3.3.17

Returns the lowercase version of displayName().

View source

Returns ​

string

markAsClean() ​

Since
3.4.0

Resets the record of dirty attributes and fields.

View source

markAsDirty() ​

Since
3.4.10

Marks all fields and attributes as dirty.

View source

mergeCanonicalChanges() ​

Since
3.7.0

Merges changes from the canonical element into this one.

See also craft\services\Elements::mergeCanonicalChanges()View source

modifyCustomSource() ​

Since
4.5.0

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

View source

Arguments ​

Returns ​

array

offsetExists() ​

Treats custom fields as array offsets.

View source

Arguments ​

Returns ​

boolean

pluralDisplayName() ​

Since
3.2.0

Returns the plural version of displayName().

View source

Returns ​

string

pluralLowerDisplayName() ​

Since
3.3.17

Returns the plural, lowercase version of displayName().

View source

Returns ​

string

prepareEditScreen() ​

Since
4.0.0

Prepares the response for the element’s Edit screen.

View source

Arguments ​

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

refHandle() ​

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

View source

Returns ​

string, null – The reference handle, or null if the element type doesn’t support reference tags

searchableAttributes() ​

Defines which element attributes should be searchable.

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

php
return ['color'];

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

color:blue

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

TIP

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

View source

Returns ​

string[] – The element attributes that should be searchable

setCanonical() ​

Since
3.7.0

Sets the canonical version of the element.

View source

Arguments ​

  • $element (self)

setCanonicalId() ​

Since
3.7.0

Sets the element’s canonical ID.

View source

Arguments ​

setDirtyAttributes() ​

Since
3.5.0

Sets the list of dirty attribute names.

See also getDirtyAttributes()View source

Arguments ​

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

setDirtyFields() ​

Since
4.5.0

Sets the list of dirty field handles.

See also getDirtyFields()View source

Arguments ​

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

setEagerLoadedElementCount() ​

Since
3.4.0

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

View source

Arguments ​

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

setEagerLoadedElements() ​

Sets some eager-loaded elements on a given handle.

View source

Arguments ​

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

setEnabledForSite() ​

Since
3.4.0

Sets whether the element is enabled for the current site.

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

View source

Arguments ​

setFieldParamNamespace() ​

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

View source

Arguments ​

  • $namespace (string) – The field param namespace

setFieldValue() ​

Sets the value for a given field.

View source

Arguments ​

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

setFieldValueFromRequest() ​

Since
4.5.0

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

View source

Arguments ​

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

Throws ​

setFieldValues() ​

Sets the element’s custom field values.

View source

Arguments ​

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

setFieldValuesFromRequest() ​

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

View source

Arguments ​

  • $paramNamespace (string) – The field param namespace

setIsFresh() ​

Since
3.7.14

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

View source

Arguments ​

setNext() ​

Sets the default next element.

View source

Arguments ​

setParent() ​

Sets the element’s parent.

View source

Arguments ​

  • $parent (self, null)

setPrev() ​

Sets the default previous element.

View source

Arguments ​

setRevisionCreatorId() ​

Since
3.2.0

Sets the revision creator ID to be saved.

View source

Arguments ​

setRevisionNotes() ​

Since
3.2.0

Sets the revision notes to be saved.

View source

Arguments ​

setUiLabel() ​

Since
3.6.3

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

View source

Arguments ​

setUiLabelPath() ​

Since
4.4.0

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

View source

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 object.
  • attribute (optional) – The table attribute name that this option is associated with (required if orderBy is an array or more than one column name)
  • defaultDir (optional) – The default sort direction that should be used when sorting by this option (set to either asc or desc). Defaults to asc if not specified.
php
return [
    [
        'label' => Craft::t('app', 'Attribute Label'),
        'orderBy' => 'columnName',
        'attribute' => 'attributeName',
        'defaultDir' => 'asc',
    ],
];

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

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

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

View source

Returns ​

array – The attributes that elements can be sorted by

sourcePath() ​

Since
4.4.12

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

View source

Arguments ​

Returns ​

array[], null

sources() ​

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

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

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

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

TIP

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

View source

Arguments ​

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

Returns ​

array – The sources.

statuses() ​

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

See also hasStatuses()View source

Returns ​

array

tableAttributes() ​

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

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

View source

Returns ​

array – The table attributes.

trackChanges() ​

Since
3.4.0

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

See also:

View source

Returns ​

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