ElementInterface

Type
Interface
Namespace
craft\base
Extends
craft\base\ComponentInterface
Implemented by
craft\base\Element, craft\elements\Asset, craft\elements\Category, craft\elements\Entry, craft\elements\GlobalSet, craft\elements\MatrixBlock, craft\elements\Tag, craft\elements\User, craft\models\BaseEntryRevisionModel, craft\models\EntryDraft, craft\models\EntryVersion
Since
3.0

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

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

View source

Public Methods

MethodDescription
actions()Returns the available element actions for a given source (if one is provided).
afterDelete()Performs actions after an element is deleted.
afterMoveInStructure()Performs actions after an element is moved within a structure.
afterRestore()Performs actions after an element is restored.
afterSave()Performs actions after an element is saved.
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.
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.
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.
getAncestors()Returns the element’s ancestors.
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 CP edit URL.
getDescendants()Returns the element’s descendants.
getEditorHtml()Returns the HTML for the element’s editor HUD.
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.
getHasDescendants()Returns whether the element has descendants.
getHasFreshContent()Returns whether the element’s content is "fresh" (unsaved and without validation errors).
getHtmlAttributes()Returns any attributes that should be included in the element’s DOM representation in the Control Panel.
getIsEditable()Returns whether the current user can edit the element.
getLink()Returns an anchor pre-filled with this element’s URL and title.
getNext()Returns the next element relative to this one, from a given set of criteria.
getNextSibling()Returns the element’s next sibling.
getParent()Returns the element’s parent.
getPrev()Returns the previous element relative to this one, from a given set of criteria.
getPrevSibling()Returns the element’s previous sibling.
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.
getStatus()Returns the element’s status.
getSupportedSites()Returns the sites this element is associated with.
getTableAttributeHtml()Returns the HTML that should be shown for a given attribute in Table View.
getThumbUrl()Returns the URL to the element’s thumbnail, if there is one.
getTotalDescendants()Returns the total number of descendants that the element has.
getUriFormat()Returns the URI format used to generate this element’s URI.
getUrl()Returns the element’s full URL.
hasContent()Returns whether elements of this type will be storing any data in the content table (tiles or custom fields).
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.
isAncestorOf()Returns whether this element is an ancestor of another one.
isChildOf()Returns whether this element is a direct child of another one.
isDescendantOf()Returns whether this element is a descendant of another one.
isLocalized()Returns whether elements of this type store content on a per-site basis.
isNextSiblingOf()Returns whether this element is the direct next sibling of another one.
isParentOf()Returns whether this element is a direct parent of another one.
isPrevSiblingOf()Returns whether this element is the direct previous sibling of another one.
isSiblingOf()Returns whether this element is a sibling of another one.
offsetExists()Treats custom fields as array offsets.
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.
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.
setNext()Sets the default next element.
setParent()Sets the element’s parent.
setPrev()Sets the default previous element.
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.

actions()

Returns the available element actions for a given source (if one is provided). The actions can either be represented by their class handle (e.g. 'SetStatus'), or by an craft\base\ElementActionInterface instance.

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

afterMoveInStructure()

Performs actions after an element is moved within a structure.

View source

Arguments

  • $structureId (integer) – The structure ID

afterRestore()

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

beforeMoveInStructure()

Performs actions before an element is moved within a structure.

View source

Arguments

  • $structureId (integer) – The structure ID

Returns

boolean – Whether the element should be moved within the structure

beforeRestore()

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

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.

View source

Arguments

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

Returns

array, false – The eager-loading element ID mappings, or false if no mappings exist

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

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

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

View source

Returns

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

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

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.

getAncestors()

Returns the element’s ancestors.

View source

Arguments

Returns

craft\elements\db\ElementQueryInterface, craft\base\ElementInterface[]

getChildren()

Returns the element’s children.

View source

Returns

craft\elements\db\ElementQueryInterface, craft\base\ElementInterface[]

getContentTable()

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

View source

Returns

string

getCpEditUrl()

Returns the element’s CP edit URL.

View source

Returns

string, null

getDescendants()

Returns the element’s descendants.

View source

Arguments

Returns

craft\elements\db\ElementQueryInterface, craft\base\ElementInterface[]

getEditorHtml()

Returns the HTML for the element’s editor HUD.

View source

Returns

string – The HTML for the editor HUD

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

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)

getHasDescendants()

Returns whether the element has descendants.

View source

Returns

boolean

getHasFreshContent()

Returns whether the element’s content is "fresh" (unsaved and without validation errors).

View source

Returns

boolean – Whether the element’s content is fresh

getHtmlAttributes()

Returns any attributes that should be included in the element’s DOM representation in the Control Panel.

View source

Arguments

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

Returns

array

getIsEditable()

Returns whether the current user can edit the element.

View source

Returns

boolean

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

View source

Returns

\Twig\Markup, null

getNext()

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

View source

Arguments

  • $criteria (mixed)

Returns

craft\base\ElementInterface, null

getNextSibling()

Returns the element’s next sibling.

View source

Returns

craft\base\ElementInterface, null

getParent()

Returns the element’s parent.

View source

Returns

craft\base\ElementInterface, null

getPrev()

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

View source

Arguments

  • $criteria (mixed)

Returns

craft\base\ElementInterface, null

getPrevSibling()

Returns the element’s previous sibling.

View source

Returns

craft\base\ElementInterface, null

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.

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, craft\base\ElementInterface[]

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 keys siteId (int) and enabledByDefault (boolean).

View source

Returns

integer[], array

getTableAttributeHtml()

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 ? '<a href="mailto:'.$this->email.'">'.$this->email.'</a>' : '';
    // ...
}
return parent::getTableAttributeHtml($attribute);

craft\base\Element::getTableAttributeHtml() provides a couple handy attribute checks by default, so it is a good idea to let the parent method get called (as shown above). They are:

  • 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 class.
  • If the attribute value is a DateTime object, the date will be formatted with a localized date format.
  • For anything else, it will output the attribute value as a string.

View source

Arguments

  • $attribute (string) – The attribute name.

Returns

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

getThumbUrl()

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

View source

Arguments

Returns

string, null

getTotalDescendants()

Returns the total number of descendants that the element has.

View source

Returns

integer

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

hasContent()

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

View source

Returns

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

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.

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

Returns

boolean

isChildOf()

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

View source

Arguments

Returns

boolean

isDescendantOf()

Returns whether this element is a descendant of another one.

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

Returns

boolean

isParentOf()

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

View source

Arguments

Returns

boolean

isPrevSiblingOf()

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

View source

Arguments

Returns

boolean

isSiblingOf()

Returns whether this element is a sibling of another one.

View source

Arguments

Returns

boolean

offsetExists()

Treats custom fields as array offsets.

View source

Arguments

Returns

boolean

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

View source

Returns

string[] – The element attributes that should be searchable

setFieldParamNamespace()

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

View source

Arguments

  • $namespace (string) – The field param namespace

setFieldValue()

Sets the value for a given field.

View source

Arguments

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

setFieldValues()

Sets the element’s custom field values.

View source

Arguments

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

setFieldValuesFromRequest()

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

View source

Arguments

  • $paramNamespace (string) – The field param namespace

setNext()

Sets the default next element.

View source

Arguments

setParent()

Sets the element’s parent.

View source

Arguments

setPrev()

Sets the default previous element.

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 – A comma-delimited string of columns to order the query by
  • attribute(optional) – The table attribute name that this option is associated with
return [
    [
        'label' => Craft::t('app', 'Attribute Label'),
        'orderBy' => 'columnName',
        'attribute' => 'attributeName'
    ],
];

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

Returns

array – 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.
  • 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 usel select’s 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.

View source

Arguments

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

Returns

array – The sources.

statuses()

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

Returns

array

tableAttributes()

Defines all of the available columns that can be shown in table views. This method should return an array whose keys map to attribute names and database columns that can be sorted against when querying for elements, and whose values make up the table’s column headers. The first item that this array returns will just identify the database column name, and the table column’s header, but will not have any effect on what shows up in the table’s body. That’s because the first column is reserved for displaying whatever your element’s __toString() method returns. All other items besides the first one will also define which element attribute should be shown within the data cells. (The actual HTML to be shown can be customized with getTableAttributeHtml().)

View source

Returns

array – The table attributes.