Matrix

Type

Class

Namespace

craft\fields

Inherits

craft\fields\Matrix » craft\base\Field » craft\base\SavableComponent » craft\base\ConfigurableComponent » craft\base\Component » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject

Implements

ArrayAccess, IteratorAggregate, craft\base\ComponentInterface, craft\base\ConfigurableComponentInterface, craft\base\EagerLoadingFieldInterface, craft\base\ElementContainerFieldInterface, craft\base\FieldInterface, craft\base\GqlInlineFragmentFieldInterface, craft\base\ModelInterface, craft\base\SavableComponentInterface, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface

Uses traits

craft\base\ClonefixTrait, craft\base\FieldTrait, craft\base\SavableComponentTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait

Since

3.0.0

Matrix field type

View source

Public Properties

Property	Description
activeValidators	yii\validators\Validator – The validators applicable to the current scenario.
attributes	array – Attribute values (name => value).
behaviors	yii\base\Behavior – List of behaviors attached to this component.
columnSuffix	string, null – The field’s content column suffix
contentGqlMutationArgumentType	\GraphQL\Type\Definition\Type, array
contentGqlQueryArgumentType	\GraphQL\Type\Definition\Type, array
contentGqlType	\GraphQL\Type\Definition\Type, array
context	string, null – The field’s context
createButtonLabel	string, null – The “New entry” button label.
dateCreated	DateTime, null – The date that the component was created
dateUpdated	DateTime, null – The date that the component was last updated
defaultTableColumns	string[] – The default table columns to show in table view
describedBy	string, null – The aria-describedby attribute value that should be set on the focusable input(s).
eagerLoadingGqlConditions	array, null
elementConditionRuleType	string, array, null
elementValidationRules	array
entryTypes	craft\models\EntryType[]
errors	array – Errors for all attributes or the specified attribute.
fieldLayoutProviders	craft\base\FieldLayoutProviderInterface[]
firstErrors	array – The first errors.
handle	string, null – The field’s handle
id	integer, string, null – The component’s ID (could be a temporary one: "new:X")
includeTableView	boolean – Include table view in element indexes
inputId	string
instructions	string, null – The field’s instructions
isNew	boolean – Whether the component is new (unsaved)
iterator	ArrayIterator – An iterator for traversing the items in the list.
labelId	string
layoutElement	craft\fieldlayoutelements\CustomField, null – The field layout element
maxEntries	integer, null – Max entries
minEntries	integer, null – Min entries
name	string, null – The field’s name
oldHandle	string, null – The field’s previous handle
oldSettings	array, null – The field’s previous settings
pageSize	integer, null – The total entries to display per page within element indexes
propagationKeyFormat	string, null – The field’s propagation key format, if propagationMethod is custom
propagationMethod	\craft\enums\PropagationMethod – Propagation method
required	boolean, null – Whether the field is required in the field layout it was fetched from
scenario	string – The scenario that this model is in.
searchable	boolean – Whether the field's values should be registered as search keywords on the elements.
settings	array – The component’s settings
settingsHtml	string, null
showCardsInGrid	boolean – Whether cards should be shown in a multi-column grid
siteSettings	`array{uriFormat: string
sortOption	array
translationKeyFormat	string, null – The field’s translation key format, if translationMethod is "custom"
translationMethod	string – The field’s translation method
uiLabel
uid	string, null – The field's UID
validateHandleUniqueness	boolean – Whether the field handle’s uniqueness should be validated.
validators	ArrayObject, yii\validators\Validator – All the validators declared in the model.
valueSql	string, null
viewMode	string – The view mode

contentGqlMutationArgumentType

Type

\GraphQL\Type\Definition\Type, array

Default value

null

Access

Read-only

Since

3.5.0

View source

contentGqlType

Type

\GraphQL\Type\Definition\Type, array

Default value

null

Access

Read-only

Since

3.3.0

View source

createButtonLabel

Type

string, null

Default value

null

Since

5.0.0

The “New entry” button label.

View source

defaultTableColumns

Type

string[]

Default value

[]

Since

5.0.0

The default table columns to show in table view

View source

elementConditionRuleType

Type

string, array, null

Default value

null

Access

Read-only

View source

elementValidationRules

Type

array

Default value

null

Access

Read-only

View source

entryTypes

Type

craft\models\EntryType[]

Default value

null

View source

fieldLayoutProviders

Type

craft\base\FieldLayoutProviderInterface[]

Default value

null

Access

Read-only

View source

includeTableView

Type

boolean

Default value

false

Since

5.0.0

Include table view in element indexes

View source

maxEntries

Type

integer, null

Default value

null

Since

5.0.0

Max entries

View source

minEntries

Type

integer, null

Default value

null

Since

5.0.0

Min entries

View source

pageSize

Type

integer, null

Default value

null

Since

5.0.0

The total entries to display per page within element indexes

View source

propagationKeyFormat

Type

string, null

Default value

null

Since

3.7.0

The field’s propagation key format, if propagationMethod is custom

View source

propagationMethod

Type

\craft\enums\PropagationMethod

Default value

\craft\enums\PropagationMethod::All

Since

3.2.0

Propagation method

View source

settingsHtml

Type

string, null

Default value

null

Access

Read-only

View source

showCardsInGrid

Type

boolean

Default value

false

Since

5.0.0

Whether cards should be shown in a multi-column grid

View source

siteSettings

Type

array{uriFormat: string|null, template?: string|null, errors?: array}[]

Default value

[]

Since

5.0.0

Site settings

View source

viewMode

Type

string

Default value

self::VIEW_MODE_CARDS

Since

5.0.0

The view mode

View source

Public Methods

Method	Description
__call()	Calls the named method which is not a class method.
__clone()	This method is called after the object is created by cloning an existing one.
__construct()	Constructor
__get()	Returns the value of a component property.
__isset()	Checks if a property is set, i.e. defined and not null.
__set()	Sets the value of a component property.
__toString()	Use the translated field name as the string representation.
__unset()	Sets a component property to be null.
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 a component is deleted.
afterElementDelete()	Performs actions after the element has been deleted.
afterElementDeleteForSite()	Performs actions after the element has been deleted.
afterElementPropagate()	Performs actions after the element has been fully saved and propagated to other sites.
afterElementRestore()	Performs actions after the element has been restored.
afterElementSave()	Performs actions after the element has been saved.
afterSave()	Performs actions after a component is saved.
afterSaveEntries()	Handles nested entry saves.
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.
beforeApplyDelete()	Performs actions before a component delete is applied to the database.
beforeDelete()	Performs actions before a component is deleted.
beforeElementDelete()	Performs actions before an element is deleted.
beforeElementDeleteForSite()	Performs actions before an element is deleted for a site.
beforeElementRestore()	Performs actions before an element is restored.
beforeElementSave()	Performs actions before an element is saved.
beforeSave()	Performs actions before a component is saved.
beforeValidate()	This method is invoked before validation starts.
behaviors()	Returns a list of behaviors that this component should behave as.
canDeleteElement()	Returns whether the given user is authorized to delete an element.
canDeleteElementForSite()	Returns whether the given user is authorized to delete an element for its current site.
canDuplicateElement()	Returns whether the given user is authorized to duplicate an element.
canGetProperty()	Returns a value indicating whether a property can be read.
canSaveElement()	Returns whether the given user is authorized to save an element in its current form.
canSetProperty()	Returns a value indicating whether a property can be set.
canViewElement()	Returns whether the given user is authorized to view an element’s edit page.
className()	Returns the fully qualified name of this class.
clearErrors()	Removes errors for all attributes or a single attribute.
copyValue()	Copies the field’s value from one element to another.
createValidators()	Creates validator objects based on the validation rules specified in rules().
datetimeAttributes()	Returns the names of any attributes that should hold DateTime values.
dbType()	Returns the DB data type(s) that this field will store within the elements_sites.content column.
defaultTableColumnOptions()	Returns the “Default Table Columns” options for the given entry types.
detachBehavior()	Detaches a behavior from the component.
detachBehaviors()	Detaches all behaviors from the component.
displayName()	Returns the display name of this class.
ensureBehaviors()	Makes sure that the behaviors declared in behaviors() are attached to this component.
extraFields()	Returns the list of fields that can be expanded further and returned by toArray().
fields()	Returns the list of fields that should be returned by default by toArray() when no specific fields are specified.
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()
getActiveValidators()	Returns the validators applicable to the current scenario.
getAttributeHint()	Returns the text hint for the specified attribute.
getAttributeLabel()	Returns the text label for the specified attribute.
getAttributes()	Returns attribute values.
getBehavior()	Returns the named behavior object.
getBehaviors()	Returns all behaviors attached to this component.
getContentGqlMutationArgumentType()	Returns the GraphQL type to be used as an argument in mutations for this field type.
getContentGqlQueryArgumentType()	Returns the GraphQL type to be used as an argument in queries for this field type.
getContentGqlType()	Returns the GraphQL type to be used for this field type.
getEagerLoadingGqlConditions()	Returns an array that lists the scopes this custom field allows when eager-loading or false if eager-loading should not be allowed in the GraphQL context.
getEagerLoadingMap()	Returns an array that maps source-to-target element IDs based on this custom field.
getElementConditionRuleType()	Returns the element condition rule class that should be used for this field.
getElementValidationRules()	Returns the validation rules for an element with this field.
getEntryTypes()	Returns the available entry types.
getEntryTypesForField()	Returns the available entry types for the given owner element.
getErrorSummary()	Returns the errors for all attributes as a one-dimensional array.
getErrors()	Returns the errors for all attributes or a single attribute.
getFieldLayoutProviders()	Returns the field layout providers that could be involved in nested elements.
getFirstError()	Returns the first error of the specified attribute.
getFirstErrors()	Returns the first error of every attribute in the model.
getGqlFragmentEntityByName()	Returns a GraphQL fragment by its GraphQL fragment name.
getId()
getInlineInputHtml()	Returns the HTML that should be shown for this field’s inline inputs.
getInputHtml()	Returns the field’s input HTML.
getInputId()	Returns the input’s ID, which the <label>’s for attribute should reference.
getIsNew()	Returns whether the component is new (unsaved).
getIsTranslatable()	Returns whether the field should be shown as translatable in the UI.
getIterator()	Returns an iterator for traversing the attributes in the model.
getLabelId()	Returns the input’s label ID.
getOrientation()	Returns the orientation the field should use (ltr or rtl).
getPreviewHtml()	Returns the HTML that should be shown for this field in table and card views.
getRouteForElement()	Returns the route that should be used when a nested element’s URI is requested.
getScenario()	Returns the scenario that this model is used in.
getSearchKeywords()	Returns the search keywords that should be associated with this field.
getSettings()	Returns an array of the component’s settings.
getSettingsHtml()	Returns the component’s settings HTML.
getSortOption()	Returns the sort option array that should be included in the element’s sortOptions() response.
getStaticHtml()	Returns a static (non-editable) version of the field’s input HTML.
getStatus()	Returns the status of the field for a given element.
getSupportedSitesForElement()	Returns the sites a nested element is associated with.
getTranslationDescription()	Returns the description of this field’s translation support.
getTranslationKey()	Returns the field’s translation key, based on a given element.
getUiLabel()
getUriFormatForElement()	Returns the URI format for a nested element.
getValidators()	Returns all the validators declared in rules().
getValueSql()	Returns a SQL expression which extracts the field’s value from the elements_sites.content column.
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.
icon()	Returns the field type’s SVG icon.
includeInGqlSchema()	Returns whether the field should be included in the given GraphQL schema.
init()	Initializes the object.
instance()	Returns static class instance, which can be used to obtain meta information.
isAttributeActive()	Returns a value indicating whether the attribute is active in the current scenario.
isAttributeRequired()	Returns a value indicating whether the attribute is required.
isAttributeSafe()	Returns a value indicating whether the attribute is safe for massive assignments.
isMultiInstance()	Returns whether the field can be included multiple times within a field layout.
isRequirable()	Returns whether the field can be marked as required.
isSelectable()	Returns whether the component should be selectable in component Type selects.
isValueEmpty()	Returns whether the given value should be considered “empty” to a validator.
load()	Populates the model with input data.
loadMultiple()	Populates a set of models with the data from end user.
modifyElementIndexQuery()	Modifies an element index query.
normalizeValue()	Normalizes the field’s value for use.
normalizeValueFromRequest()	Normalizes a posted field value for use.
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.
phpType()	Returns the PHPDoc type this field’s values will have.
queryCondition()	Returns a query builder-compatible condition for the given field instances, for a user-provided param value.
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.
serializeValue()	Prepares the field’s value to be stored somewhere, like the content table.
setAttributes()	Sets the attribute values in a massive way.
setEntryTypes()	Sets the available entry types.
setIsFresh()	Sets whether the field is fresh.
setScenario()	Sets the scenario for the model.
settingsAttributes()	Returns the list of settings attribute names.
supportedTranslationMethods()	Returns which translation methods the field supports.
toArray()	Converts the model into an array.
trigger()	Triggers an event.
useFieldset()	Returns whether the field should use a <fieldset> + <legend> instead of a <div> + <label>.
validate()	Performs the data validation.
validateMultiple()	Validates multiple models.

__construct()

Constructor

View source

Arguments

• $config

afterElementPropagate()

Since

3.2.0

Performs actions after the element has been fully saved and propagated to other sites.

View source

Arguments

• $element (craft\base\ElementInterface) – The element that was just saved and propagated
• $isNew (boolean) – Whether the element is brand new

afterElementRestore()

Since

3.1.0

Performs actions after the element has been restored.

View source

Arguments

• $element (craft\base\ElementInterface) – The element that was just restored

afterSave()

Performs actions after a component is saved.

View source

Arguments

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

afterSaveEntries()

Since

5.0.0

Handles nested entry saves.

View source

Arguments

• $event (craft\events\BulkElementsEvent)

beforeElementDelete()

Performs actions before an element is deleted.

View source

Arguments

• $element (craft\base\ElementInterface) – The element that is about to be deleted

Returns

boolean – Whether the element should be deleted

beforeElementDeleteForSite()

Since

4.7.0

Performs actions before an element is deleted for a site.

View source

Arguments

• $element (craft\base\ElementInterface) – The element that is about to be deleted

Returns

boolean – Whether the element should be deleted for a site

canDeleteElement()

Returns whether the given user is authorized to delete an element.

This will only be called if the element can be \craft\fields\canView() and/or \craft\fields\canSave().

View source

Arguments

• $element (craft\base\NestedElementInterface)
• $user (craft\elements\User)

Returns

boolean, null

canDeleteElementForSite()

Returns whether the given user is authorized to delete an element for its current site.

This will only be called if the element can be \craft\fields\canView() and/or \craft\fields\canSave().

View source

Arguments

• $element (craft\base\NestedElementInterface)
• $user (craft\elements\User)

Returns

boolean, null

canDuplicateElement()

Returns whether the given user is authorized to duplicate an element.

This will only be called if the element can be \craft\fields\canView() and/or \craft\fields\canSave().

View source

Arguments

• $element (craft\base\NestedElementInterface)
• $user (craft\elements\User)

Returns

boolean, null

canSaveElement()

Returns whether the given user is authorized to save an element in its current form.

This will only be called if the element can be \craft\fields\canView().

View source

Arguments

• $element (craft\base\NestedElementInterface)
• $user (craft\elements\User)

Returns

boolean, null

canViewElement()

Returns whether the given user is authorized to view an element’s edit page.

If they can view but not \craft\fields\canSave(), the edit form will either render statically, or be restricted to only saving changes as a draft, depending on \craft\fields\canCreateDrafts().

View source

Arguments

• $element (craft\base\NestedElementInterface)
• $user (craft\elements\User)

Returns

boolean, null

copyValue()

Since

3.7.0

Copies the field’s value from one element to another.

View source

Arguments

• $from (craft\base\ElementInterface)
• $to (craft\base\ElementInterface)

dbType()

Returns the DB data type(s) that this field will store within the elements_sites.content column.

return \yii\db\Schema::TYPE_STRING;

Specifying the DB type isn’t strictly necessary, but it enables individual field values to be targeted by functional indexes.

If field values will consist of an associative array, each of the array keys can be specified here, so the nested values can receive their own functional indexes.

return [
    'date' => \yii\db\Schema::TYPE_DATETIME,
    'tz' => \yii\db\Schema::TYPE_STRING,
];

If null is returned, the field’s values won’t be stored in the elements_sites.content column at all. In that case, the field will be solely responsible for storing and retrieving its own values from normalizeValue() and afterElementSave()/afterElementPropagate().

View source

Returns

string, string[], null – The column type(s).

defaultTableColumnOptions()

Since

5.0.0

Returns the “Default Table Columns” options for the given entry types.

View source

Arguments

• $entryTypes (craft\models\EntryType[])

Returns

array

displayName()

Returns the display name of this class.

View source

Returns

string – The display name of this class.

getContentGqlMutationArgumentType()

Since

3.5.0

Returns the GraphQL type to be used as an argument in mutations for this field type.

View source

Returns

\GraphQL\Type\Definition\Type, array

getContentGqlType()

Since

3.3.0

Returns the GraphQL type to be used for this field type.

View source

Returns

\GraphQL\Type\Definition\Type, array

getEagerLoadingMap()

Returns an array that maps source-to-target element IDs based on this custom field.

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.

View source

Arguments

• $sourceElements (craft\base\ElementInterface[]) – An array of the source elements

Returns

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

getElementConditionRuleType()

Returns the element condition rule class that should be used for this field.

The rule class must be an instance of craft\fields\conditions\FieldConditionRuleInterface.

View source

Returns

string, array, null

getElementValidationRules()

Returns the validation rules for an element with this field.

Rules should be defined in the array syntax required by yii\base\Model::rules(), with one difference: you can skip the first argument (the attribute list).

[
    // explicitly specify the field attribute
    [$this->handle, 'string', 'min' => 3, 'max' => 12],
    // skip the field attribute
    ['string', 'min' => 3, 'max' => 12],
    // you can only pass the validator class name/handle if not setting any params
    'bool',
]

To register validation rules that should only be enforced for live elements, set the rule scenario to live:

[
    ['string', 'min' => 3, 'max' => 12, 'on' => \craft\base\Element::SCENARIO_LIVE],
]

View source

Returns

array

getEntryTypes()

Returns the available entry types.

View source

Returns

craft\models\EntryType[]

getEntryTypesForField()

Since

5.0.0

Returns the available entry types for the given owner element.

View source

Arguments

• $value (craft\elements\Entry[])
• $element (craft\base\ElementInterface, null)

Returns

craft\models\EntryType[]

getFieldLayoutProviders()

Returns the field layout providers that could be involved in nested elements.

View source

Returns

craft\base\FieldLayoutProviderInterface[]

getGqlFragmentEntityByName()

Since

3.3.0

Returns a GraphQL fragment by its GraphQL fragment name.

View source

Arguments

• $fragmentName (string)

Returns

craft\base\GqlInlineFragmentInterface

Throws

• yii\base\InvalidArgumentException

getIsTranslatable()

Returns whether the field should be shown as translatable in the UI.

Note this method has no effect on whether the field’s value will get copied over to other sites when the element is actually getting saved. That is determined by getTranslationKey().

View source

Arguments

• $element (craft\base\ElementInterface, null) – The element being edited

Returns

boolean

getRouteForElement()

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

View source

Arguments

• $element (craft\base\NestedElementInterface)

Returns

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

getSettings()

Returns an array of the component’s settings.

View source

Returns

array – The component’s settings.

getSettingsHtml()

Returns the component’s settings HTML.

An extremely simple implementation would be to directly return some HTML:

return '<textarea name="foo">'.$this->foo.'</textarea>';

For more complex settings, you might prefer to create a template, and render it via craft\web\View::renderTemplate(). For example, the following code would render a template located at src/templates/_settings.html, passing the settings to it:

return Craft::$app->view->renderTemplate('plugin-handle/_widget-settings', [
    'widget' => $this
]);

If you need to tie any JavaScript code to your settings, it’s important to know that any name and id attributes within the returned HTML will probably get namespaced, however your JavaScript code will be left untouched. For example, if getSettingsHtml() returns the following HTML:

<textarea id="foo" name="foo"></textarea>
<script type="text/javascript">
  var textarea = document.getElementById('foo');
</script>

…then it might actually look like this before getting output to the browser:

<textarea id="namespace-foo" name="namespace[foo]"></textarea>
<script type="text/javascript">
  var textarea = document.getElementById('foo');
</script>

As you can see, that JavaScript code will not be able to find the textarea, because the textarea’s id attribute was changed from foo to namespace-foo. Before you start adding namespace- to the beginning of your element ID selectors, keep in mind that the actual namespace is going to change depending on the context. Often they are randomly generated. So it’s not quite that simple.

Thankfully, Craft provides a couple handy methods that can help you deal with this:

• craft\web\View::namespaceInputId() will give you the namespaced version of a given ID.
• craft\web\View::namespaceInputName() will give you the namespaced version of a given input name.

So here’s what a getSettingsHtml() method that includes field-targeting JavaScript code might look like:

public function getSettingsHtml(): ?string
{
    // Figure out what the ID is going to be namespaced into
    $id = 'foo';
    $namespacedId = Craft::$app->view->namespaceInputId($id);
    // Render and return the input template
    return Craft::$app->view->renderTemplate('plugin-handle/_widget-settings', [
        'id' => $id,
        'namespacedId' => $namespacedId,
        'widget' => $this,
    ]);
}

And the _widget-settings.twig template might look like this:

<textarea id="{{ id }}" name="foo">{{ widget.foo }}</textarea>
<script type="text/javascript">
  var textarea = document.getElementById('{{ namespacedId }}');
</script>

The same principles also apply if you’re including your JavaScript code with craft\web\View::registerJs().

View source

Returns

string, null

getStaticHtml()

Returns a static (non-editable) version of the field’s input HTML.

This function is called to output field values when viewing element drafts.

View source

Arguments

• $value (mixed) – The field’s value
• $element (craft\base\ElementInterface) – The element the field is associated with

Returns

string – The static version of the field’s input HTML

getSupportedSitesForElement()

Returns the sites a nested 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

Arguments

• $element

Returns

array

getTranslationDescription()

Since

3.4.0

Returns the description of this field’s translation support.

View source

Arguments

• $element (craft\base\ElementInterface, null) – The element being edited

Returns

string, null

getUriFormatForElement()

Returns the URI format for a nested element.

View source

Arguments

• $element (craft\base\NestedElementInterface)

Returns

string, null

icon()

Since

5.0.0

Returns the field type’s SVG icon.

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

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

isValueEmpty()

Returns whether the given value should be considered “empty” to a validator.

View source

Arguments

• $value (mixed) – The field’s value
• $element (craft\base\ElementInterface) – The element the field is associated with, if there is one

Returns

boolean – Whether the value should be considered “empty”

normalizeValue()

Normalizes the field’s value for use.

This method is called when the field’s value is first accessed from the element. For example, the first time element.myFieldHandle is called from a template, or right before getInputHtml() is called. Whatever this method returns is what element.myFieldHandle will likewise return, and what getInputHtml()’s and serializeValue()’s $value arguments will be set to.

The value passed into this method will vary depending on the context.

• If a new, unsaved element is being edited for the first time (such as an entry within a Quick Post widget on the Dashboard), the value will be null.
• If an element is currently being saved, the value will be the field’s POST data.
• If an existing element was retrieved from the database, the value will be whatever is stored in the field’s content table column. (Or if the field doesn’t have a content table column per \craft\fields\hasContentColumn(), the value will be null.)
• If the field is being cleared out (e.g. via the resave/entries command with --to :empty:), the value will be an empty string ('').

There are cases where a pre-normalized value could be passed in as well, so be sure to account for that.

View source

Arguments

• $value (mixed) – The raw field value
• $element (craft\base\ElementInterface, null) – The element the field is associated with, if there is one

Returns

mixed – The prepared field value

normalizeValueFromRequest()

Since

4.5.0

Normalizes a posted field value for use.

This should call normalizeValue() by default, unless there are any special considerations that need to be made for posted values.

View source

Arguments

• $value (mixed) – The serialized value
• $element (craft\base\ElementInterface, null) – The element the field is associated with, if there is one

Returns

mixed – The prepared field value

phpType()

Since

5.0.0

Returns the PHPDoc type this field’s values will have.

It will be used by the generated CustomFieldBehavior class.

If the values can be of more than one type, return multiple types separated by |s.

public static function valueType(): string
{
     return 'int|string';
}

View source

Returns

string

queryCondition()

Since

5.0.0

Returns a query builder-compatible condition for the given field instances, for a user-provided param value.

If false is returned, an always-false condition will be used.

View source

Arguments

• $instances (static[]) – The field instances to search
• $value (mixed) – The user-supplied param value
• $params (array) – Additional parameters that should be bound to the query via yii\db\Query::addParams()

Returns

array, string, yii\db\ExpressionInterface, false, null

serializeValue()

Prepares the field’s value to be stored somewhere, like the content table.

Data types that are JSON-encodable are safe (arrays, integers, strings, booleans, etc). Whatever this returns should be something normalizeValue() can handle.

View source

Arguments

• $value (mixed) – The raw field value
• $element (craft\base\ElementInterface, null) – The element the field is associated with, if there is one

Returns

mixed – The serialized field value

setEntryTypes()

Sets the available entry types.

View source

Arguments

• $entryTypes ((int|string|\craft\models\EntryType)[]) – The entry types, or their IDs or UUIDs

settingsAttributes()

Returns the list of settings attribute names.

By default, this method returns all public non-static properties that were defined on the called class. You may override this method to change the default behavior.

View source

Returns

string[] – The list of settings attribute names

supportedTranslationMethods()

Returns which translation methods the field supports.

This method should return an array with at least one of the following values:

• 'none' (values will always be copied to other sites)
• 'language' (values will be copied to other sites with the same language)
• 'site' (values will never be copied to other sites)
• 'custom' (values will be copied/not copied depending on a custom translation key)

View source

Returns

string[]

Protected Methods

Method	Description
defineBehaviors()	Returns the behaviors to attach to this class.
defineRules()	Returns the validation rules for attributes.
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.
inputHtml()	Returns the field’s input HTML.
isFresh()	Returns whether this is the first time the element’s content has been edited.
requestParamName()	Returns the field’s param name on the request.
resolveFields()	Determines which fields can be returned by toArray().
searchKeywords()	Returns the search keywords that should be associated with this field.
valueSql()	Returns a coalescing value SQL expression for the given field instances.

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

inputHtml()

Since

3.5.0

Returns the field’s input HTML.

View source

Arguments

• $value (mixed) – The field’s value. This will either be the normalized value, raw POST data (i.e. if there was a validation error), or null
• $element (craft\base\ElementInterface, null) – The element the field is associated with, if there is one
• $inline (boolean) – Whether this is for an inline edit form.

Returns

string – The input HTML.

Throws

• yii\base\InvalidConfigException

searchKeywords()

Since

3.5.0

Returns the search keywords that should be associated with this field.

The keywords can be separated by commas and/or whitespace; it doesn’t really matter. craft\services\Search will be able to find the individual keywords in whatever string is returned, and normalize them for you.

View source

Arguments

• $value (mixed) – The field’s value
• $element (craft\base\ElementInterface) – The element the field is associated with, if there is one

Returns

string – A string of search keywords.

Constants

Constant	Description
SCENARIO_DEFAULT	The name of the default scenario.
TRANSLATION_METHOD_CUSTOM
TRANSLATION_METHOD_LANGUAGE
TRANSLATION_METHOD_NONE
TRANSLATION_METHOD_SITE
TRANSLATION_METHOD_SITE_GROUP
VIEW_MODE_BLOCKS
VIEW_MODE_CARDS
VIEW_MODE_INDEX

Events

EVENT_DEFINE_ENTRY_TYPES

Type

craft\events\DefineEntryTypesForFieldEvent

Since

5.0.0

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

---