Skip to content

Address

Type
Class
Namespace
craft\elements
Inherits
craft\elements\Address » craft\base\Element » craft\base\Component » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject
Implements
ArrayAccess, CommerceGuys\Addressing\AddressInterface, IteratorAggregate, craft\base\BlockElementInterface, craft\base\ComponentInterface, craft\base\ElementInterface, craft\base\ModelInterface, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface
Uses traits
craft\base\ClonefixTrait, craft\base\ElementTrait, craft\base\NameTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait
Since
4.0.0

Address element class

View source

Public Properties

PropertyDescription
activeValidatorsyii\validators\Validator – The validators applicable to the current scenario.
additionalButtonsstring
additionalName
addressLine1string, null – First line of the address
addressLine2string, null – Second line of the address
administrativeAreastring, null – Administrative area
ancestorscraft\elements\db\ElementQueryInterface – The element’s ancestors
archivedboolean – Whether the element is archived
attributesarray – Attribute values (name => value).
awaitingFieldValuesboolean – Whether the element is still awaiting its custom field values
behaviorsyii\base\Behavior – List of behaviors attached to this component.
belongsToCurrentUserboolean
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
childrencraft\elements\db\ElementQueryInterface – The element’s children
contentIdinteger, null – The element’s content row ID
contentTablestring – The name of the table this element’s content is stored in
countryCodestring – Two-letter country code
cpEditUrlstring, null – The element’s edit URL in the control panel
cpRevisionsUrlstring, null
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
dependentLocalitystring, null – Dependent locality
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.
editorHtmlstring – The HTML for the element’s editor HUD
enabledboolean – Whether the element is enabled
enabledForSiteboolean – Whether the element is enabled for this site
errorsarray – Errors for all attributes or the specified attribute.
familyName
fieldColumnPrefixstring – The field column prefix this element’s content uses
fieldContextstring – The field context this element’s content uses
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.
firstNamestring, null – First name
firstSaveboolean – Whether the element is being saved for the first time in a normal state (not as a draft or revision).
fullNamestring, null – Full name
givenName
gqlTypeNamestring
hardDeleteboolean – Whether the element is being hard-deleted.
hasCheckeredThumbboolean
hasDescendantsboolean – Whether the element has descendants
hasRoundedThumbboolean
htmlAttributesarray – Any attributes that should be included in the element’s DOM representation in the control panel
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
lastNamestring, null – Last name
latitudestring, null – Latitude
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
locale
localitystring, null – Locality
localizedcraft\elements\db\ElementQueryInterface, \Illuminate\Support\Collection
longitudestring, null – Longitude
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
organizationstring, null – Organization name
organizationTaxIdstring, null – Organization tax ID
outdatedAttributesstring[]
outdatedFieldsstring[]
ownercraft\base\ElementInterface, null
ownerIdinteger, null – Owner ID
parentcraft\base\ElementInterface, null – The element’s parent
parentIdinteger, null – The element’s parent’s ID
parentUristring, null
postEditUrlstring, null
postalCodestring, null – Postal code
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.
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.
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
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
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
sortingCodestring, null – Sorting code
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})
thumbAltstring, null
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.
uiLabelstring
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
validatingRelatedElementboolean – Whether the element is currently being validated via BaseRelationField::validateRelatedElements()
validatorsArrayObject, yii\validators\Validator – All the validators declared in the model.

additionalName

Default value
null
Access
Read-only

View source

addressLine1

Type
string, null
Default value
null

First line of the address

View source

addressLine2

Type
string, null
Default value
null

Second line of the address

View source

administrativeArea

Type
string, null
Default value
null

Administrative area

View source

belongsToCurrentUser

Type
boolean
Default value
null
Access
Read-only
Since
4.5.13

View source

countryCode

Type
string
Default value
null

Two-letter country code

See also https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2

View source

dependentLocality

Type
string, null
Default value
null

Dependent locality

View source

familyName

Default value
null
Access
Read-only

View source

givenName

Default value
null
Access
Read-only

View source

latitude

Type
string, null
Default value
null

Latitude

View source

locale

Default value
null
Access
Read-only

View source

locality

Type
string, null
Default value
null

Locality

View source

longitude

Type
string, null
Default value
null

Longitude

View source

organization

Type
string, null
Default value
null

Organization name

View source

organizationTaxId

Type
string, null
Default value
null

Organization tax ID

View source

owner

Type
craft\base\ElementInterface, null
Default value
null

View source

ownerId

Type
integer, null
Default value
null

Owner ID

View source

postalCode

Type
string, null
Default value
null

Postal code

View source

sortingCode

Type
string, null
Default value
null

Sorting code

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 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.
addressAttributeLabel()Returns an address attribute label.
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.
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.
defineRules()Returns the validation rules for attributes.
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 of 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\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.
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.
getAdditionalName()
getAddressLine1()
getAddressLine2()
getAdministrativeArea()
getAncestors()Returns the element’s ancestors.
getAttributeHint()Returns the text hint for the specified attribute.
getAttributeLabel()Returns the text label for the specified attribute.
getAttributeStatus()Returns the status of a given attribute.
getAttributes()Returns attribute values.
getBehavior()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
getBelongsToCurrentUser()Returns whether the address belongs to the currently logged-in user.
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.
getChildren()Returns the element’s children.
getContentTable()Returns the name of the table this element’s content is stored in.
getCountryCode()
getCpEditUrl()Returns the element’s edit URL in the control panel.
getCpRevisionsUrl()Returns the element’s revisions index URL in the control panel.
getCurrentRevision()Returns the element’s current revision, if one exists.
getDependentLocality()
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.
getFamilyName()
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.
getFirstError()Returns the first error of the specified attribute.
getFirstErrors()Returns the first error of every attribute in the model.
getGivenName()
getGqlTypeName()Returns the GraphQL type name for this element type.
getHasCheckeredThumb()Returns whether the element’s thumbnail should have a checkered background.
getHasDescendants()Returns whether the element has descendants.
getHasRoundedThumb()Returns whether the element’s thumbnail should be rounded.
getHtmlAttributes()Returns any attributes that should be included in the element’s DOM representation in the control panel.
getId()
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.
getLocale()
getLocality()
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.
getOrganization()
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.
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.
getPostalCode()
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.
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.
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.
getSortingCode()
getSourceId()Returns the element’s canonical ID.
getSourceUid()Returns the element’s canonical UID.
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.
getThumbAlt()Returns alt text for the element’s thumbnail.
getThumbHtml()Returns the HTML for the element’s thumbnail, if it has one.
getThumbUrl()Returns the URL to the element’s thumbnail, if it has one.
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.
getUiLabel()Returns what the element should be called within the control panel.
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().
gqlMutationNameByContext()Returns the GraphQL mutation name by an element’s context.
gqlScopesByContext()Returns the GraphQL scopes required by element’s context.
gqlTypeNameByContext()Returns the GraphQL type name by an element’s context.
hasContent()Returns whether elements of this type will be storing any data in the content table (titles or custom fields).
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.
hasTitles()
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.
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.
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.
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).
setNext()Sets the default next element.
setOwner()Sets the owner element.
setParent()Sets the element’s parent.
setParentId()Sets the parent ID.
setPrev()Sets the default previous element.
setRevisionCreatorId()Sets the revision creator ID to be saved.
setRevisionNotes()Sets the revision notes to be saved.
setScenario()Sets the scenario for the model.
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.
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()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.
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.
validate()Performs the data validation.
validateCustomFieldAttribute()Calls a custom validation function on a custom field.
validateMultiple()Validates multiple models.

addressAttributeLabel()

DEPRECATED

Deprecated in 4.3.0. craft\services\Addresses::getFieldLabel() should be used instead.

Returns an address attribute label.

View source

Arguments

Returns

string, null

afterSave()

Performs actions after an element is saved.

View source

Arguments

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

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

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

createCondition()

Since
4.0.0

Returns an element condition for the element type.

View source

Returns

craft\elements\conditions\ElementConditionInterface

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

displayName()

Returns the display name of this class.

View source

Returns

string – The display name of this class.

find()

Creates an \craft\elements\ElementQueryInterface instance for query purpose.

The returned \craft\elements\ElementQueryInterface instance can be further customized by calling methods defined in \craft\elements\ElementQueryInterface before one() or all() is called to return populated craft\base\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\AddressQuery – The newly created craft\elements\db\AddressQuery instance.

getAdditionalName()

View source

getAddressLine1()

View source

getAddressLine2()

View source

getAdministrativeArea()

View source

getAttributeLabel()

Returns the text label for the specified attribute.

View source

Arguments

  • $attribute (string) – The attribute name

Returns

string – The attribute label

getBelongsToCurrentUser()

Since
4.5.13

Returns whether the address belongs to the currently logged-in user.

View source

Returns

boolean

getCountryCode()

View source

getDependentLocality()

View source

getFamilyName()

View source

getFieldLayout()

Returns the field layout used by this element.

View source

Returns

craft\models\FieldLayout, null

getGivenName()

View source

getLocale()

View source

getLocality()

View source

getOrganization()

View source

getOwner()

Returns the owner element, if the element has one.

View source

Returns

craft\base\ElementInterface, null

Throws

getPostalCode()

View source

getSortingCode()

View source

gqlTypeNameByContext()

Since
3.3.0

Returns the GraphQL type name by an element’s context.

View source

Arguments

  • $context (mixed) – The element’s context, such as a volume, entry type or Matrix block type.

Returns

string

hasContent()

Returns whether elements of this type will be storing any data in the content table (titles 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.

View source

Returns

boolean – Whether elements of this type have statuses.

hasTitles()

View source

init()

Initializes the object.

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

View source

lowerDisplayName()

Since
3.3.17

Returns the lowercase version of displayName().

View source

Returns

string

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

setAttributes()

Since
4.0.0

Sets the attribute values in a massive way.

View source

Arguments

  • $values (array) – Attribute values (name => value) to be assigned to the model.
  • $safeOnly (boolean) – Whether the assignments should only be done to the safe attributes. A safe attribute is one that is associated with a validation rule in the current scenario.

setOwner()

Since
4.4.16

Sets the owner element.

View source

Arguments

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.

Protected Methods

MethodDescription
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.
defineActions()Defines the available 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.
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.
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.
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.
htmlAttributes()Returns any attributes that should be included in the element’s DOM representation in the control panel.
includeSetStatusAction()Returns whether the Set Status action should be included in actions() automatically.
indexElements()Returns the resulting elements for an element index.
metaFieldsHtml()Returns the HTML for any meta fields that should be shown within the editor sidebar.
metadata()Returns element metadata that should be shown within the editor sidebar.
normalizeFieldValue()Normalizes a field’s value.
normalizeNames()Normalizes the name properties.
notesFieldHtml()Returns the notes field HTML for the sidebar.
prepElementQueryForTableAttribute()Prepares an element query for an element index that includes a given table attribute.
prepareNamesForSave()Parses fullName if set, or sets it based on firstName and lastName.
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.
searchKeywords()Returns the search keywords for a given search attribute.
showStatusField()Returns whether the Status field should be shown for this element.
slugFieldHtml()Returns the HTML for the element’s Slug field.
statusFieldHtml()Returns the status field HTML for the sidebar.
tableAttributeHtml()Returns the HTML that should be shown for a given attribute in Table View.
thumbSvg()Returns the element’s thumbnail SVG contents, which should be used as a fallback when getThumbUrl() returns null.
uiLabel()Returns what the element should be called within the control panel.

cacheTags()

Since
4.1.0

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

View source

Returns

string[]

defineSearchableAttributes()

Defines which element attributes should be searchable.

View source

Returns

string[] – The element attributes that should be searchable

Constants

ConstantDescription
ATTR_STATUS_MODIFIED
ATTR_STATUS_OUTDATED
HOMEPAGE_URI
SCENARIO_DEFAULTThe name of the default scenario.
SCENARIO_ESSENTIALS
SCENARIO_LIVE
STATUS_ARCHIVED
STATUS_DISABLED
STATUS_ENABLED