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

PropertyDescription
archivedboolean – Whether the element is archived
awaitingFieldValuesboolean – Whether the element is still awaiting its custom field values
contentIdinteger, null – The element’s content row ID
dateCreatedDateTime, null – The date that the element was created
dateDeletedDateTime, null – The date that the element was trashed
dateUpdatedDateTime, null – The date that the element was last updated
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.
enabledboolean – Whether the element is enabled
enabledForSiteboolean – Whether the element is enabled for this site.
fieldLayoutIdinteger, null – The element’s field layout ID
hardDeleteboolean – Whether the element is being hard-deleted.
idinteger, null – The element’s ID
levelinteger, null – The element’s level within its structure
lftinteger, null – The element’s left position within its structure
newSiteIdsinteger[] – The site IDs that the element was just propagated to for the first time.
previewingboolean – Whether the element is currently being previewed.
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.
resavingboolean – Whether the element is being resaved by a ResaveElement job or a resave console command.
revisionIdinteger – 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
searchScoreinteger, null – The element’s search score, if the craft\elements\db\ElementQuery::search() parameter was used when querying for the element
siteIdinteger, null – The site ID the element is associated with
slugstring, null – The element’s slug
structureIdinteger, null – The element’s structure ID
tempIdstring, null – The element’s temporary ID (only used if the element's URI format contains {id})
titlestring, null – The element’s title
trashedboolean – Whether the element has been soft-deleted.
uidstring, null – The element’s UID
uristring, 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

enabledForSite

Type
boolean

Whether the element is enabled for this site.

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
Access
Read-only

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[]

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

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
Access
Read-only

The element’s URI

View source