Skip to content

Entry

Type
Class
Namespace
craft\elements
Inherits
craft\elements\Entry » craft\base\Element » craft\base\Component » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject
Implements
ArrayAccess, IteratorAggregate, craft\base\Colorable, craft\base\ComponentInterface, craft\base\ElementInterface, craft\base\ExpirableElementInterface, craft\base\Iconic, craft\base\ModelInterface, craft\base\NestedElementInterface, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface
Uses traits
craft\base\ClonefixTrait, craft\base\ElementTrait, craft\base\NestedElementTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait
Since
3.0.0

Entry represents an entry element.

View source

Public Properties

PropertyDescription
actionMenuItems
activeValidatorsyii\validators\Validator – The validators applicable to the current scenario.
additionalButtonsstring
ancestorscraft\elements\db\ElementQueryInterface – The element’s ancestors
archivedboolean – Whether the element is archived
attributesarray – Attribute values (name => value).
attributesFromRequestarray – The attribute values
authorcraft\elements\User, null – the primary entry author
authorIdinteger, null – The primary entry author’s ID
authorIdsinteger[] – the entry authors’ IDs
authorscraft\elements\User[] – the entry authors
availableEntryTypescraft\models\EntryType[]
awaitingFieldValuesboolean – Whether the element is still awaiting its custom field values
behaviorsyii\base\Behavior – List of behaviors attached to this component.
cacheTagsstring[]
canonicalcraft\base\ElementInterface, null – The canonical element, if one exists for the current site
canonicalIdinteger, null – The element’s canonical ID
canonicalUidstring – The element’s canonical UID
cardBodyHtmlstring, null
childrencraft\elements\db\ElementQueryInterface – The element’s children
chipLabelHtmlstring
collapsedboolean – Collapsed
color\craft\enums\Color, null
cpEditUrlstring, null – The element’s edit URL in the control panel
cpRevisionsUrlstring, null
crumbsarray
currentRevisionself, null
dateCreatedDateTime, null – The date that the element was created
dateDeletedDateTime, null – The date that the element was trashed
dateLastMergedDateTime, null – The date that the canonical element was last merged into this one
dateUpdatedDateTime, null – The date that the element was last updated
deletedWithOwnerboolean, null – Whether the element was deleted along with its owner
descendantscraft\elements\db\ElementQueryInterface – The element’s descendants
dirtyAttributesstring[]
dirtyFieldsstring[]
draftIdinteger, null – The ID of the draft’s row in the drafts table
duplicateOfcraft\base\ElementInterface, null – The element that this element is being duplicated by.
eagerLoadInfocraft\elements\db\EagerLoadInfo, null – Info about the eager loading setup used to query this element.
editorHtmlstring – The HTML for the element’s editor HUD
elementQueryResultcraft\base\ElementInterface[], null – All elements that the element was queried with.
enabledboolean – Whether the element is enabled
enabledForSiteboolean – Whether the element is enabled for this site
errorsarray – Errors for all attributes or the specified attribute.
expiryDateDateTime, null – Expiry date
fieldcraft\base\ElementContainerFieldInterface, null – the element’s field
fieldContextstring – The field context this element’s content uses
fieldIdinteger, null – Field ID
fieldLayoutcraft\models\FieldLayout, null – The field layout used by this element
fieldLayoutIdinteger, null – The element’s field layout ID
fieldParamNamespacearray – The namespace used by custom field params on the request
fieldValuesarray – The element’s normalized custom field values, indexed by their handles
firstErrorsarray – The first errors.
firstSaveboolean – Whether the element is being saved for the first time in a normal state (not as a draft or revision).
forceSaveboolean – Whether the element should definitely be saved, if it’s a nested element being considered for saving by \craft\base\NestedElementManager.
gqlTypeNamestring
hardDeleteboolean – Whether the element is being hard-deleted.
hasDescendantsboolean – Whether the element has descendants
htmlAttributesarray – Any attributes that should be included in the element’s DOM representation in the control panel
iconstring, null
idinteger, null – The element’s ID
isCanonicalboolean – Whether this is the canonical element
isDerivativeboolean – Whether this is a derivative element, such as a draft or revision
isDraftboolean
isFreshboolean
isHomepageboolean
isNewForSiteboolean – Whether the element is being saved to the current site for the first time.
isProvisionalDraftboolean – Whether this is a provisional draft.
isRevisionboolean
isSlugTranslatableboolean
isTitleTranslatableboolean
isUnpublishedDraftboolean
iteratorArrayIterator – An iterator for traversing the items in the list.
languagestring
lazyEagerLoadedElementsstring – The handle that was used to eager-load the elements
levelinteger, null – The element’s level within its structure
lftinteger, null – The element’s left position within its structure
link\Twig\Markup, null – An anchor pre-filled with this element’s URL and title
localizedcraft\elements\db\ElementQueryInterface, craft\elements\ElementCollection
mergingCanonicalChangesboolean – Whether recent changes to the canonical element are being merged into this element.
metadataarray – The data, with keys representing the labels.
modifiedAttributesstring[]
modifiedFieldsstring[]
newSiteIdsinteger[] – The site IDs that the element was just propagated to for the first time.
nextcraft\base\ElementInterface, null – The next element relative to this one, from a given set of criteria
nextSiblingcraft\base\ElementInterface, null – The element’s next sibling
outdatedAttributesstring[]
outdatedFieldsstring[]
ownercraft\base\ElementInterface, null – the owner element
ownerIdinteger, null – the owner element’s ID
parentcraft\base\ElementInterface, null – The element’s parent
parentIdinteger, null – The element’s parent’s ID
parentUristring, null
postDateDateTime, null – Post date
postEditUrlstring, null
prevcraft\base\ElementInterface, null – The previous element relative to this one, from a given set of criteria
prevSiblingcraft\base\ElementInterface, null – The element’s previous sibling
previewTargetsarray
previewingboolean – Whether the element is currently being previewed.
primaryOwnercraft\base\ElementInterface, null – the primary owner element
primaryOwnerIdinteger, null – the primary owner element’s ID
propagateAllboolean – Whether all element attributes should be propagated across all its supported sites, even if that means overwriting existing site-specific values.
propagatingboolean – Whether the element is being saved in the context of propagating another site's version of the element.
propagatingFromcraft\base\ElementInterface, null – The element that this element is being propagated from.
refstring, null – The reference string to this element
resavingboolean – Whether the element is being resaved by a ResaveElement job or a resave console command.
revisionIdinteger, null – The ID of the revision’s row in the revisions table
rgtinteger, null – The element’s right position within its structure
rootinteger, null – The element’s structure’s root ID
routemixed – The route that should be used when the element’s URI is requested
saveOwnershipboolean – Whether to save the element’s row in the elements_owners table from afterSave().
scenariostring – The scenario that this model is in.
searchScoreinteger, null – The element’s search score, if the craft\elements\db\ElementQuery::search() parameter was used when querying for the element
sectioncraft\models\Section, null – the entry’s section
sectionIdinteger, null – Section ID
serializedFieldValuesarray – Array of the element’s serialized custom field values, indexed by their handles
siblingscraft\elements\db\ElementQueryInterface – All of the element’s siblings
sitecraft\models\Site – Site the element is associated with
siteIdinteger, null – The site ID the element is associated with
siteSettingsIdinteger, null – The ID of the element’s record in the elements_sites table
slugstring, null – The element’s slug
slugTranslationDescriptionstring, null
slugTranslationKeystring – The translation key
sortOrderinteger, null – Sort order
sourceIdinteger, null
sourceUidstring
statusstring, null – The element’s status
structureIdinteger, null – The element’s structure ID
supportedSitesinteger[], array – The sites this element is associated with
tempIdstring, null – The element’s temporary ID (only used if the element’s URI format contains {id})
titlestring, null – The element’s title
titleTranslationDescriptionstring, null
titleTranslationKeystring – The translation key
totalDescendantsinteger – The total number of descendants that the element has
trashedboolean – Whether the element has been soft-deleted.
typecraft\models\EntryType – the entry type
typeIdinteger – the entry type’s ID
uiLabel
uiLabelPathstring[]
uidstring, null – The element’s UID
updatingFromDerivativeboolean – Whether the element is being updated from a derivative element, such as a draft or revision.
uristring, null – The element’s URI
uriFormatstring, null – The URI format used to generate this element’s URL
urlstring, null – The element’s full URL
validatorsArrayObject, yii\validators\Validator – All the validators declared in the model.

author

Type
craft\elements\User, null
Default value
null

the primary entry author

View source

authorId

Type
integer, null
Default value
null

The primary entry author’s ID

View source

authorIds

Type
integer[]
Default value
null

the entry authors’ IDs

View source

authors

Type
craft\elements\User[]
Default value
null

the entry authors

View source

availableEntryTypes

Type
craft\models\EntryType[]
Default value
null
Access
Read-only
Since
3.6.0

View source

cardBodyHtml

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

View source

chipLabelHtml

Type
string
Default value
null
Access
Read-only
Since
5.0.0

View source

collapsed

Type
boolean
Default value
false
Since
5.0.0

Collapsed

View source

color

Type
\craft\enums\Color, null
Default value
null
Access
Read-only

View source

expiryDate

Type
DateTime, null
Default value
null

Expiry date

View source


Example

php
if ($entry->expiryDate) {
echo Craft::$app->formatter->asDate($entry->expiryDate, 'short');
}
twig
{% if entry.expiryDate %}
{{ entry.expiryDate|date('short') }}
{% endif %}

gqlTypeName

Type
string
Default value
null
Access
Read-only
Since
3.3.0

View source

icon

Type
string, null
Default value
null
Access
Read-only

View source

isSlugTranslatable

Type
boolean
Default value
null
Access
Read-only
Since
4.5.0

View source

isTitleTranslatable

Type
boolean
Default value
null
Access
Read-only
Since
3.5.0

View source

postDate

Type
DateTime, null
Default value
null

Post date

View source


Example

php
echo Craft::$app->formatter->asDate($entry->postDate, 'short');
twig
{{ entry.postDate|date('short') }}

postEditUrl

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

View source

section

Type
craft\models\Section, null
Default value
null

the entry’s section

View source

sectionId

Type
integer, null
Default value
null

Section ID

View source


Example

php
echo $entry->sectionId;
twig
{{ entry.sectionId }}

slugTranslationDescription

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

View source

slugTranslationKey

Type
string
Default value
null
Access
Read-only
Since
4.5.0

The translation key

View source

titleTranslationDescription

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

View source

titleTranslationKey

Type
string
Default value
null
Access
Read-only
Since
3.5.0

The translation key

View source

type

Type
craft\models\EntryType
Default value
null

the entry type

View source

typeId

Type
integer
Default value
null

the entry type’s ID

View source

uiLabel

Default value
null

View source

Protected Properties

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

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__clone()
__construct()
__get()Returns the value of a component property.
__isset()Checks if a property is set.
__set()Sets the value of a component property.
__toString()Returns the string representation of the element.
__unset()Sets a component property to be null.
actions()Returns the available bulk element actions for a given source.
activeAttributes()Returns the attribute names that are subject to validation in the current scenario.
addError()Adds a new error to the specified attribute.
addErrors()Adds a list of errors.
addModelErrors()Adds errors from another model, with a given attribute name prefix.
afterDelete()Performs actions after an element is deleted.
afterDeleteForSite()Performs actions after an element is deleted for a site.
afterMoveInStructure()Performs actions after an element is moved within a structure.
afterPropagate()Performs actions after an element is fully saved and propagated to other sites.
afterRestore()Performs actions after an element is restored.
afterSave()Performs actions after an element is saved.
afterValidate()This method is invoked after validation ends.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
attributeHints()Returns the attribute hints.
attributeLabels()Returns the attribute labels.
attributes()Returns the list of attribute names.
beforeDelete()Performs actions before an element is deleted.
beforeDeleteForSite()Performs actions before an element is deleted for a site.
beforeMoveInStructure()Performs actions before an element is moved within a structure.
beforeRestore()Performs actions before an element is restored.
beforeSave()Performs actions before an element is saved.
beforeValidate()This method is invoked before validation starts.
behaviors()Returns a list of behaviors that this component should behave as.
canCreateDrafts()Returns whether the given user is authorized to create drafts for this element.
canDelete()Returns whether the given user is authorized to delete this element.
canDeleteForSite()Returns whether the given user is authorized to delete this element for its current site.
canDuplicate()Returns whether the given user is authorized to duplicate this element.
canDuplicateAsDraft()Returns whether the given user is authorized to duplicate this element as an unpublished draft.
canGetProperty()Returns a value indicating whether a property can be read.
canSave()Returns whether the given user is authorized to save this element in its current form.
canSetProperty()Returns a value indicating whether a property can be set.
canView()Returns whether the given user is authorized to view this element’s edit page.
className()Returns the fully qualified name of this class.
clearErrors()Removes errors for all attributes or a single attribute.
createAnother()Creates a new element (without saving it) based on this one.
createCondition()Returns an element condition for the element type.
createValidators()Creates validator objects based on the validation rules specified in rules().
datetimeAttributes()Returns the names of any attributes that should hold DateTime values.
defaultTableAttributes()Returns the list of table attribute keys that should be shown by default.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
displayName()Returns the display name of this class.
eagerLoadingMap()Returns an array that maps source-to-target element IDs based on the given sub-property handle.
ensureBehaviors()Makes sure that the behaviors declared in behaviors() are attached to this component.
exporters()Returns the available export options for a given source.
extraFields()Returns the list of fields that can be expanded further and returned by toArray().
fieldLayouts()Returns all the field layouts associated with elements from the given source.
fields()Returns the list of fields that should be returned by default by toArray() when no specific fields are specified.
find()Creates an craft\elements\db\ElementQueryInterface instance for query purpose.
findAll()Returns a list of elements that match the specified ID(s) or a set of element criteria parameters.
findOne()Returns a single element instance by a primary key or a set of element criteria parameters.
findSource()Returns a source definition by a given source key/path and context.
formName()Returns the form name that this model class should use.
generateAttributeLabel()Generates a user friendly attribute label based on the give attribute name.
get()
getActionMenuItems()
getActiveValidators()Returns the validators applicable to the current scenario.
getAdditionalButtons()Returns additional buttons that should be shown at the top of the element’s edit page.
getAncestors()Returns the element’s ancestors.
getAttributeHint()Returns the text hint for the specified attribute.
getAttributeHtml()Returns the HTML that should be shown for a given attribute in table and card views.
getAttributeLabel()Returns the text label for the specified attribute.
getAttributeStatus()Returns the status of a given attribute.
getAttributes()Returns attribute values.
getAuthor()Returns the entry author.
getAuthorId()Returns the entry author’s ID.
getAuthorIds()Returns the primary entry authors’ IDs.
getAuthors()Returns the entry authors.
getAvailableEntryTypes()Returns the available entry types for the entry.
getBehavior()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
getCacheTags()Returns the cache tags that should be cleared when this element is saved.
getCanonical()Returns the canonical version of the element.
getCanonicalId()Returns the element’s canonical ID.
getCanonicalUid()Returns the element’s canonical UUID.
getCardBodyHtml()Returns the body HTML for element cards.
getChildren()Returns the element’s children.
getChipLabelHtml()Returns the label HTML for element chips.
getColor()Returns the HTML for the component’s thumbnail, if it has one.
getCpEditUrl()
getCpRevisionsUrl()Returns the element’s revisions index URL in the control panel.
getCrumbs()Returns the breadcrumbs that lead up to the element.
getCurrentRevision()Returns the element’s current revision, if one exists.
getDescendants()Returns the element’s descendants.
getDirtyAttributes()Returns a list of attribute names that have changed since the element was first loaded.
getDirtyFields()Returns a list of custom field handles that have changed since the element was first loaded.
getEagerLoadedElementCount()Returns the count of eager-loaded elements for a given handle.
getEagerLoadedElements()Returns the eager-loaded elements for a given handle.
getEnabledForSite()Returns whether the element is enabled for the current site.
getErrorSummary()Returns the errors for all attributes as a one-dimensional array.
getErrors()Returns the errors for all attributes or a single attribute.
getExpiryDate()Returns the element’s expiration date/time.
getField()Returns the field that contains the element.
getFieldContext()Returns the field context this element’s content uses.
getFieldLayout()Returns the field layout used by this element.
getFieldParamNamespace()Returns the namespace used by custom field params on the request.
getFieldValue()Returns the value for a given field.
getFieldValues()Returns the element’s normalized custom field values, indexed by their handles.
getFirstError()Returns the first error of the specified attribute.
getFirstErrors()Returns the first error of every attribute in the model.
getGqlTypeName()Returns the GraphQL type name for this element type.
getHasDescendants()Returns whether the element has descendants.
getHtmlAttributes()Returns any attributes that should be included in the element’s chips and cards.
getIcon()Returns the component’s icon, if it has one.
getId()
getInlineAttributeInputHtml()Returns the HTML that should be shown for a given attribute's inline editing input.
getIsCanonical()Returns whether this is the canonical element.
getIsDerivative()Returns whether this is a derivative element, such as a draft or revision.
getIsDraft()Returns whether this is a draft.
getIsFresh()Returns whether the element is "fresh" (not yet explicitly saved, and without validation errors).
getIsHomepage()Returns whether this element represents the site homepage.
getIsRevision()Returns whether this is a revision.
getIsSlugTranslatable()Returns whether the Slug field should be shown as translatable in the UI.
getIsTitleTranslatable()Returns whether the Title field should be shown as translatable in the UI.
getIsUnpublishedDraft()Returns whether the element is an unpublished draft.
getIterator()Returns an iterator for traversing the attributes in the model.
getLanguage()Returns the language of the element.
getLink()Returns an anchor pre-filled with this element’s URL and title.
getLocalized()Returns the same element in other locales.
getMetadata()Returns element metadata that should be shown within the editor sidebar.
getModifiedAttributes()Returns the attribute names that have changed for this element.
getModifiedFields()Returns the field handles that have changed for this element.
getNext()Returns the next element relative to this one, from a given set of criteria.
getNextSibling()Returns the element’s next sibling.
getOutdatedAttributes()Returns the attribute names that have been updated on the canonical element since the last time it was merged into this element.
getOutdatedFields()Returns the field handles that have been updated on the canonical element since the last time it was merged into this element.
getOwner()Returns the owner element, if the element has one.
getOwnerId()Returns the owner element’s ID, if the element has one.
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.
getPrimaryOwner()Returns the primary owner element, if the element has one.
getPrimaryOwnerId()Returns the primary owner element’s ID, if the element has one.
getRef()Returns the reference string to this element.
getRoute()Returns the route that should be used when the element’s URI is requested.
getScenario()Returns the scenario that this model is used in.
getSearchKeywords()Returns the search keywords for a given search attribute.
getSection()Returns the entry’s section.
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.
getSortOrder()Returns the element’s sort order, if it has one.
getSourceId()Returns the element’s canonical ID.
getSourceUid()Returns the element’s canonical UID.
getStatus()
getSupportedSites()Returns the sites this element is associated with.
getThumbHtml()
getTitleTranslationDescription()Returns the description of the Title field’s translation support.
getTitleTranslationKey()Returns the Title’s translation key.
getTotalDescendants()Returns the total number of descendants that the element has.
getType()Returns the entry type.
getTypeId()Returns the entry type ID.
getUiLabel()
getUiLabelPath()Returns any path segment labels that should be prepended to the element’s UI label.
getUriFormat()Returns the URI format used to generate this element’s URI.
getUrl()Returns the element’s full URL.
getValidators()Returns all the validators declared in rules().
gqlScopesByContext()Returns the GraphQL scopes required by element’s context.
gqlTypeName()Returns the GraphQL type name that entries should use, based on their entry type.
hasDrafts()Returns whether element indexes should show the “Drafts” status option.
hasEagerLoadedElements()Returns whether elements have been eager-loaded with a given handle.
hasErrors()Returns a value indicating whether there is any validation error.
hasEventHandlers()Returns a value indicating whether there is any handler attached to the named event.
hasMethod()Returns a value indicating whether a method is defined.
hasProperty()Returns a value indicating whether a property is defined for this component.
hasRevisions()Returns whether revisions should be created when this element is saved.
hasStatuses()Returns whether elements of this type have statuses.
hasThumbs()Returns whether element indexes should include a thumbnail view by default.
hasTitles()Returns whether elements of this type have traditional titles.
hasUris()Returns whether elements of this type can have their own slugs and URIs.
indexElementCount()Returns the total number of elements that will be shown on an element index, for the given element query.
indexHtml()Returns the element index HTML.
init()Initializes the object.
instance()Returns static class instance, which can be used to obtain meta information.
isAncestorOf()Returns whether this element is an ancestor of another one.
isAttributeActive()Returns a value indicating whether the attribute is active in the current scenario.
isAttributeDirty()Returns whether an attribute has changed since the element was first loaded.
isAttributeModified()Returns whether an attribute value has changed for this element.
isAttributeOutdated()Returns whether an attribute value has fallen behind the canonical element’s value.
isAttributeRequired()Returns a value indicating whether the attribute is required.
isAttributeSafe()Returns a value indicating whether the attribute is safe for massive assignments.
isChildOf()Returns whether this element is a direct child of another one.
isDescendantOf()Returns whether this element is a descendant of another one.
isFieldDirty()Returns whether a custom field value has changed since the element was first loaded.
isFieldEmpty()Returns whether a field is empty.
isFieldModified()Returns whether a field value has changed for this element.
isFieldOutdated()Returns whether a field value has fallen behind the canonical element’s value.
isLocalized()Returns whether elements of this type store content on a per-site basis.
isNextSiblingOf()Returns whether this element is the direct next sibling of another one.
isParentOf()Returns whether this element is a direct parent of another one.
isPrevSiblingOf()Returns whether this element is the direct previous sibling of another one.
isSelectable()Returns whether the component should be selectable in component Type selects.
isSiblingOf()Returns whether this element is a sibling of another one.
load()Populates the model with input data.
loadMultiple()Populates a set of models with the data from end user.
lowerDisplayName()Returns the lowercase version of displayName().
markAsClean()Resets the record of dirty attributes and fields.
markAsDirty()Marks all fields and attributes as dirty.
mergeCanonicalChanges()Merges changes from the canonical element into this one.
metaFieldsHtml()Returns the HTML for any meta fields that should be shown within the editor sidebar.
modifyCustomSource()Modifies a custom source’s config, before it’s returned by craft\services\ElementSources::getSources()
off()Detaches an existing event handler from this component.
offsetExists()Returns whether there is an element at the specified offset.
offsetGet()Returns the element at the specified offset.
offsetSet()Sets the element at the specified offset.
offsetUnset()Sets the element value at the specified offset to null.
on()Attaches an event handler to an event.
onUnsafeAttribute()This method is invoked when an unsafe attribute is being massively assigned.
pluralDisplayName()Returns the plural version of displayName().
pluralLowerDisplayName()Returns the plural, lowercase version of displayName().
prepareEditScreen()Prepares the response for the element’s Edit screen.
refHandle()Returns the handle that should be used to refer to this element type from reference tags.
render()Renders the element using its partial template.
rules()Returns the validation rules for attributes.
safeAttributes()Returns the attribute names that are safe to be massively assigned in the current scenario.
scenarios()Returns a list of scenarios and the corresponding active attributes.
searchableAttributes()Defines which element attributes should be searchable.
setAttributes()Sets the attribute values in a massive way.
setAttributesFromRequest()Sets the element’s attributes from an element editor submission.
setAuthor()Sets the entry author.
setAuthorId()Sets the entry author’s ID.
setAuthorIds()Sets the entry authors’ IDs.
setAuthors()Sets the entry authors.
setCanonical()Sets the canonical version of the element.
setCanonicalId()Sets the element’s canonical ID.
setDirtyAttributes()Sets the list of dirty attribute names.
setDirtyFields()Sets the list of dirty field handles.
setEagerLoadedElementCount()Sets the count of eager-loaded elements for a given handle.
setEagerLoadedElements()Sets some eager-loaded elements on a given handle.
setEnabledForSite()Sets whether the element is enabled for the current site.
setFieldParamNamespace()Sets the namespace used by custom field params on the request.
setFieldValue()Sets the value for a given field.
setFieldValueFromRequest()Sets the value for a given field. The value should have originated from post data.
setFieldValues()Sets the element’s custom field values.
setFieldValuesFromRequest()Sets the element’s custom field values, when the values have come from post data.
setIsFresh()Sets whether the element is "fresh" (not yet explicitly saved, and without validation errors).
setLazyEagerLoadedElements()Sets whether the given eager-loaded element handles were eager-loaded lazily.
setNext()Sets the default next element.
setOwner()Sets the owner element, if the element has one.
setOwnerId()Sets the owner element’s ID, if the element has one.
setParent()Sets the element’s parent.
setParentId()Sets the parent ID.
setPrev()Sets the default previous element.
setPrimaryOwner()Sets the primary owner element, if the element has one.
setPrimaryOwnerId()Sets the primary owner element’s ID, if the element has one.
setRevisionCreatorId()Sets the revision creator ID to be saved.
setRevisionNotes()Sets the revision notes to be saved.
setSaveOwnership()Sets whether the element’s ownership should be saved when the element is saved.
setScenario()Sets the scenario for the model.
setSortOrder()Sets the element’s sort order.
setTypeId()Sets the entry type ID.
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.
showStatusField()Returns whether the Status field should be shown for this element.
sortOptions()Returns the sort options for the element type.
sourcePath()Returns the source path for a given source key, step key, and context.
sources()Returns the source definitions that elements of this type may belong to.
statuses()
tableAttributes()Defines all of the available columns that can be shown in table views.
toArray()Converts the model into an array.
trackChanges()Returns whether Craft should keep track of attribute and custom field changes made to this element type, including when the last time they were changed, and who was logged-in at the time.
trigger()Triggers an event.
updateTitle()Updates the entry’s title, if its entry type has a dynamic title format.
validate()Performs the data validation.
validateCustomFieldAttribute()Calls a custom validation function on a custom field.
validateMultiple()Validates multiple models.

afterMoveInStructure()

Performs actions after an element is moved within a structure.

View source

Arguments

  • $structureId (integer) – The structure ID

afterPropagate()

Since
3.2.0

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

TIP

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

View source

Arguments

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

afterRestore()

Since
3.1.0

Performs actions after an element is restored.

View source

afterSave()

Performs actions after an element is saved.

View source

Arguments

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

Throws

attributeLabels()

Returns the attribute labels.

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

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

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

View source

Returns

array – Attribute labels (name => label)

attributes()

Returns the list of attribute names.

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

View source

Returns

string[] – List of attribute names.

beforeDelete()

Performs actions before an element is deleted.

View source

Returns

boolean – Whether the element should be deleted

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

Throws

beforeValidate()

This method is invoked before validation starts.

The default implementation raises a beforeValidate event. You may override this method to do preliminary checks before validation. Make sure the parent implementation is invoked so that the event can be raised.

View source

Returns

boolean – Whether the validation should be executed. Defaults to true. If false is returned, the validation will stop and the model is considered invalid.

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

canDuplicateAsDraft()

Since
5.0.0

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

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\entries\EntryCondition

displayName()

Returns the display name of this class.

View source

Returns

string – The display name of this class.

eagerLoadingMap()

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

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

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

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

View source

Arguments

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

Returns

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

extraFields()

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

This method is similar to fields() except that the list of fields returned by this method are not returned by default by toArray(). Only when field names to be expanded are explicitly specified when calling toArray(), will their values be exported.

The default implementation returns an empty array.

You may override this method to return a list of expandable fields based on some context information (e.g. the current application user).

View source

Returns

array – The list of expandable field names or field definitions. Please refer to fields() on the format of the return value.

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\elements\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\EntryQuery – The newly created craft\elements\db\EntryQuery instance.

getAuthor()

Returns the entry author.

View source

Returns

craft\elements\User, null

Throws


Example

php
$author = $entry->author;
twig
<p>By {{ entry.author.name }}</p>

getAuthorId()

Since
4.0.0

Returns the entry author’s ID.

View source

Returns

integer, null

getAuthorIds()

Since
5.0.0

Returns the primary entry authors’ IDs.

View source

Returns

integer[]

getAuthors()

Since
5.0.0

Returns the entry authors.

View source

Returns

craft\elements\User[]


Example

php
$authors = $entry->authors;
twig
{% for author in entry.authors %}
    <p>By {{ author.name }}</p>
{% endfor %}

getAvailableEntryTypes()

Since
3.6.0

Returns the available entry types for the entry.

View source

Returns

craft\models\EntryType[]

Throws

getCardBodyHtml()

Since
5.0.0

Returns the body HTML for element cards.

View source

Returns

string, null

getChipLabelHtml()

Since
5.0.0

Returns the label HTML for element chips.

View source

Returns

string

getColor()

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

View source

Returns

\craft\enums\Color, null

getExpiryDate()

Returns the element’s expiration date/time.

View source

Returns

DateTime, null

getFieldLayout()

Returns the field layout used by this element.

View source

Returns

craft\models\FieldLayout, null

getGqlTypeName()

Since
3.3.0

Returns the GraphQL type name for this element type.

View source

Returns

string

getIcon()

Returns the component’s icon, if it has one.

The returned icon can be a system icon’s name (e.g. 'whiskey-glass-ice'), the path to an SVG file, or raw SVG markup.

System icons can be found in src/icons/solid/.

View source

Returns

string, null

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

getPostEditUrl()

Since
4.0.0

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

View source

Returns

string, null

getRef()

Returns the reference string to this element.

View source

Returns

string, null

getSection()

Returns the entry’s section.

View source

Returns

craft\models\Section, null

Throws


Example

php
$section = $entry->section;
twig
{% set section = entry.section %}

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

View source

getSupportedSites()

Returns the sites this element is associated with.

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

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

View source

Returns

array

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

getType()

Returns the entry type.

View source

Returns

craft\models\EntryType

Throws


Example

php
$entryType = $entry->type;
twig
{% switch entry.type.handle %}
  {% case 'article' %}
    {% include "news/_article" %}
  {% case 'link' %}
    {% include "news/_link" %}
{% endswitch %}

getTypeId()

Since
4.0.0

Returns the entry type ID.

View source

Returns

integer

getUiLabel()

View source

getUriFormat()

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

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

View source

Returns

string, null

Throws

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

gqlTypeName()

Since
5.0.0

Returns the GraphQL type name that entries should use, based on their entry type.

View source

Arguments

  • $entryType

hasDrafts()

Since
5.0.0

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

View source

Returns

boolean

hasRevisions()

Since
4.0.0

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

View source

Returns

boolean

hasStatuses()

Returns whether elements of this type have statuses.

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

View source

Returns

boolean – Whether elements of this type have statuses.

hasTitles()

Returns whether elements of this type have traditional titles.

View source

Returns

boolean – Whether elements of this type have traditional titles.

hasUris()

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

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

View source

Returns

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

init()

Since
3.5.0

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

View source

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.

lowerDisplayName()

Since
3.3.17

Returns the lowercase version of displayName().

View source

Returns

string

metaFieldsHtml()

Since
3.7.0

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

View source

Arguments

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

Returns

string

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

pluralDisplayName()

Since
3.2.0

Returns the plural version of displayName().

View source

Returns

string

pluralLowerDisplayName()

Since
3.3.17

Returns the plural, lowercase version of displayName().

View source

Returns

string

refHandle()

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

View source

Returns

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

setAuthor()

Sets the entry author.

View source

Arguments

setAuthorId()

Since
4.0.0

Sets the entry author’s ID.

View source

Arguments

setAuthorIds()

Since
5.0.0

Sets the entry authors’ IDs.

View source

Arguments

setAuthors()

Since
5.0.0

Sets the entry authors.

View source

Arguments

setEagerLoadedElements()

Sets some eager-loaded elements on a given handle.

View source

Arguments

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

setTypeId()

Since
4.0.0

Sets the entry type ID.

View source

Arguments

showStatusField()

Since
4.5.0

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

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

View source

Returns

boolean

statuses()

View source

trackChanges()

Since
3.4.0

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

View source

Returns

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

updateTitle()

Since
3.0.3

Updates the entry’s title, if its entry type has a dynamic title format.

View source

Protected Methods

MethodDescription
attributeHtml()Returns the HTML that should be shown for a given attribute in table and card views.
cacheTags()Returns the cache tags that should be cleared when this element is saved.
cpEditUrl()Returns the element’s edit URL in the control panel.
cpRevisionsUrl()Returns the element’s revisions index URL in the control panel.
crumbs()Returns the breadcrumbs that lead up to the element.
defineActions()Defines the available bulk element actions for a given source.
defineBehaviors()Returns the behaviors to attach to this class.
defineDefaultTableAttributes()Returns the list of table attribute keys that should be shown by default.
defineExporters()Defines the available element exporters for a given source.
defineFieldLayouts()Defines the field layouts associated with elements for a given source.
defineRules()Returns the validation rules for attributes.
defineSearchableAttributes()Defines which element attributes should be searchable.
defineSortOptions()Returns the sort options for the element type.
defineSources()Defines the sources that elements of this type may belong to.
defineTableAttributes()Defines all of the available columns that can be shown in table views.
destructiveActionMenuItems()Returns destructive action menu items for the element’s edit screens.
extractFieldsFor()Extract nested fields from a fields collection for a given root field Nested fields are separated with dots (.). e.g: "item.id" The previous example would extract "id".
extractRootFields()Extracts the root field names from nested fields.
fieldByHandle()Returns the field with a given handle.
fieldLayoutFields()Returns each of this element’s fields.
findByCondition()Finds Element instance(s) by the given condition.
hasCheckeredThumb()Returns whether the element’s thumbnail should have a checkered background.
hasFieldLayout()Returns whether the element has a field layout with at least one tab.
hasNewParent()Returns whether the element has been assigned a new parent.
hasRoundedThumb()Returns whether the element’s thumbnail should be rounded.
htmlAttributes()Returns any attributes that should be included in the element’s chips and cards.
includeSetStatusAction()Returns whether the Set Status action should be included in actions() automatically.
indexElements()Returns the resulting elements for an element index.
inlineAttributeInputHtml()Returns the HTML that should be shown for a given attribute’s inline input.
metadata()Returns element metadata that should be shown within the editor sidebar.
normalizeFieldValue()Normalizes a field’s value.
notesFieldHtml()Returns the notes field HTML for the sidebar.
prepElementQueryForTableAttribute()Prepares an element query for an element index that includes a given table attribute.
previewTargets()Returns the additional locations that should be available for previewing the element, besides its primary URL.
resolveFields()Determines which fields can be returned by toArray().
route()Returns the route that should be used when the element’s URI is requested.
safeActionMenuItems()Returns action menu items for the element’s edit screens.
searchKeywords()Returns the search keywords for a given search attribute.
shouldValidateTitle()Returns whether the element’s title attribute should be validated
slugFieldHtml()Returns the HTML for the element’s Slug field.
statusFieldHtml()Returns the status field HTML for the sidebar.
thumbAlt()Returns alt text for the element’s thumbnail.
thumbSvg()Returns the element’s thumbnail SVG contents, which should be used as a fallback when \craft\base\getThumbUrl() returns null.
thumbUrl()Returns the URL to the element’s thumbnail, if it has one.
uiLabel()Returns what the element should be called within the control panel.

attributeHtml()

Since
5.0.0

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

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

php
return match ($attribute) {
    'email' => $this->email ? Html::mailto(Html::encode($this->email)) : '',
    default => parent::attributeHtml($attribute),
};

WARNING

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

By default, the following will be returned:

  • If the attribute name is link or uri, it will be linked to the front-end URL.
  • If the attribute is a custom field handle, it will pass the responsibility off to the field type.
  • If the attribute value is a 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 and card views.

Throws

cacheTags()

Since
3.5.0

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

View source

Returns

string[]

cpEditUrl()

Since
3.7.0

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

View source

Returns

string, null

cpRevisionsUrl()

Since
4.4.0

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

View source

Returns

string, null

crumbs()

Since
5.0.0

Returns the breadcrumbs that lead up to the element.

View source

Returns

array

defineActions()

Defines the available bulk element actions for a given source.

View source

Arguments

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

Returns

array – The available bulk element actions.

defineDefaultTableAttributes()

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

View source

Arguments

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

Returns

string[] – The table attributes.

defineFieldLayouts()

Since
3.5.0

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

View source

Arguments

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

Returns

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

defineRules()

Since
3.4.0

Returns the validation rules for attributes.

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

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

View source

Returns

array

defineSortOptions()

Returns the sort options for the element type.

View source

Returns

array – The attributes that elements can be sorted by

defineSources()

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

View source

Arguments

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

Returns

array – The sources.

defineTableAttributes()

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

View source

Returns

array – The table attributes.

includeSetStatusAction()

Since
4.3.2

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

View source

Returns

boolean

prepElementQueryForTableAttribute()

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

View source

Arguments

previewTargets()

Since
3.2.0

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

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

View source

Returns

array

route()

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

View source

Returns

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

shouldValidateTitle()

Since
5.0.0

Returns whether the element’s title attribute should be validated

View source

Returns

boolean

uiLabel()

Since
3.6.4

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

View source

Returns

string, null

Constants

ConstantDescription
HOMEPAGE_URI
SCENARIO_DEFAULTThe name of the default scenario.
SCENARIO_ESSENTIALS
SCENARIO_LIVE
STATUS_ARCHIVED
STATUS_DISABLED
STATUS_DRAFT
STATUS_ENABLED
STATUS_EXPIRED
STATUS_LIVE
STATUS_PENDING

Events

EVENT_DEFINE_ENTRY_TYPES

Type
craft\events\DefineEntryTypesEvent
Since
3.6.0

The event that is triggered when defining the available entry types for the entry

See also getAvailableEntryTypes()


EVENT_DEFINE_PARENT_SELECTION_CRITERIA

Type
craft\events\ElementCriteriaEvent
Since
4.4.0

The event that is triggered when defining the parent selection criteria.

See also \craft\elements\_parentOptionCriteria()