ElementTrait

Type
Trait
Namespace
craft\base
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, craft\test\mockclasses\elements\ExampleElement
Since
3.0.0

ElementTrait implements the common methods and properties for element classes.

View source

# Public Properties

Property Description
archived boolean – Whether the element is archived
awaitingFieldValues boolean – Whether the element is still awaiting its custom field values
contentId integer, null – The element’s content row ID
dateCreated DateTime, null – The date that the element was created
dateDeleted DateTime, null – The date that the element was trashed
dateUpdated DateTime, null – The date that the element was last updated
draftId integer, null – The ID of the draft’s row in the drafts table
duplicateOf craft\base\ElementInterface, null – The element that this element is being duplicated by.
enabled boolean – Whether the element is enabled
fieldLayoutId integer, null – The element’s field layout ID
hardDelete boolean – Whether the element is being hard-deleted.
id integer, null – The element’s ID
level integer, null – The element’s level within its structure
lft integer, null – The element’s left position within its structure
newSiteIds integer[] – The site IDs that the element was just propagated to for the first time.
previewing boolean – Whether the element is currently being previewed.
propagateAll boolean – Whether all element attributes should be propagated across all its supported sites, even if that means overwriting existing site-specific values.
propagating boolean – Whether the element is being saved in the context of propagating another site's version of the element.
resaving boolean – Whether the element is being resaved by a ResaveElement job or a resave console command.
revisionId integer – The ID of the revision’s row in the revisions table
rgt integer, null – The element’s right position within its structure
root integer, null – The element’s structure’s root ID
searchScore integer, null – The element’s search score, if the craft\elements\db\ElementQuery::search() parameter was used when querying for the element
siteId integer, null – The site ID the element is associated with
siteSettingsId integer, null – The ID of the element’s record in the elements_sites table
slug string, null – The element’s slug
structureId integer, null – The element’s structure ID
tempId string, null – The element’s temporary ID (only used if the element's URI format contains {id})
title string, null – The element’s title
trashed boolean – Whether the element has been soft-deleted.
uid string, null – The element’s UID
uri string, null – The element’s URI

# archived

Type
boolean

Whether the element is archived

View source

# awaitingFieldValues

Type
boolean

Whether the element is still awaiting its custom field values

View source

# contentId

Type
integer, null

The element’s content row ID

View source

# dateCreated

Type
DateTime, null

The date that the element was created

View source

# dateDeleted

Type
DateTime, null
Since
3.2.0

The date that the element was trashed

View source

# dateUpdated

Type
DateTime, null

The date that the element was last updated

View source

# draftId

Type
integer, null
Since
3.2.0

The ID of the draft’s row in the drafts table

View source

# duplicateOf

Type
craft\base\ElementInterface, null

The element that this element is being duplicated by.

View source

# enabled

Type
boolean

Whether the element is enabled

View source

# fieldLayoutId

Type
integer, null

The element’s field layout ID

View source

# hardDelete

Type
boolean
Since
3.2.0

Whether the element is being hard-deleted.

View source

# id

Type
integer, null

The element’s ID

View source

# level

Type
integer, null

The element’s level within its structure

View source

# lft

Type
integer, null

The element’s left position within its structure

View source

# newSiteIds

Type
integer[]
Since
3.2.9

The site IDs that the element was just propagated to for the first time.

View source

# previewing

Type
boolean
Since
3.2.0

Whether the element is currently being previewed.

View source

# propagateAll

Type
boolean
Since
3.2.0

Whether all element attributes should be propagated across all its supported sites, even if that means overwriting existing site-specific values.

View source

# propagating

Type
boolean

Whether the element is being saved in the context of propagating another site's version of the element.

View source

# resaving

Type
boolean
Since
3.1.22

Whether the element is being resaved by a ResaveElement job or a resave console command.

View source

# revisionId

Type
integer
Since
3.2.0

The ID of the revision’s row in the revisions table

View source

# rgt

Type
integer, null

The element’s right position within its structure

View source

# root

Type
integer, null

The element’s structure’s root ID

View source

# searchScore

Type
integer, null

The element’s search score, if the craft\elements\db\ElementQuery::search() parameter was used when querying for the element

View source

# siteId

Type
integer, null

The site ID the element is associated with

View source

# siteSettingsId

Type
integer, null
Since
3.5.2

The ID of the element’s record in the elements_sites table

View source

# slug

Type
string, null

The element’s slug

View source

# structureId

Type
integer, null

The element’s structure ID

View source

# tempId

Type
string, null

The element’s temporary ID (only used if the element's URI format contains {id})

View source

# title

Type
string, null

The element’s title

View source

# trashed

Type
boolean

Whether the element has been soft-deleted.

View source

# uid

Type
string, null

The element’s UID

View source

# uri

Type
string, null

The element’s URI

View source