ElementTrait

Type: Trait
Namespace: craft\base
Implemented by: craft\base\Element, craft\elements\Address, craft\elements\Asset, craft\elements\Category, craft\elements\Entry, craft\elements\GlobalSet, craft\elements\MatrixBlock, craft\elements\Tag, craft\elements\User, craft\test\mockclasses\elements\ExampleElement
Since: 3.0.0

ElementTrait implements the common methods and properties for element classes.

# Public Properties

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