BaseRelationField

Type

Abstract Class

Namespace

craft\fields

Inherits

craft\fields\BaseRelationField » 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\Actionable, craft\base\ComponentInterface, craft\base\ConfigurableComponentInterface, craft\base\EagerLoadingFieldInterface, craft\base\FieldInterface, craft\base\Iconic, craft\base\InlineEditableFieldInterface, craft\base\MergeableFieldInterface, craft\base\ModelInterface, craft\base\RelationalFieldInterface, craft\base\SavableComponentInterface, craft\base\ThumbableFieldInterface, 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

Extended by

craft\fields\Assets, craft\fields\Categories, craft\fields\Entries, craft\fields\Tags, craft\fields\Users

Since

3.0.0

BaseRelationField is the base class for classes representing a relational field.

View source

Public Properties

Property	Description
actionMenuItems	array
activeValidators	yii\validators\Validator – The validators applicable to the current scenario.
allowLimit	boolean – Whether to show the Min Relations and Max Relations settings.
allowMultipleSources	boolean – Whether to allow multiple source selection in the settings
allowSelfRelations	boolean – Whether elements should be allowed to relate themselves.
attributes	array – Attribute values (name => value).
behaviors	yii\base\Behavior – List of behaviors attached to this component.
branchLimit	integer, null – Branch limit
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
cpEditUrl
dateCreated	DateTime, null – The date that the component was created
dateDeleted	DateTime, null – The date that the field was trashed
dateUpdated	DateTime, null – The date that the component was last updated
describedBy	string, null – The aria-describedby attribute value that should be set on the focusable input(s).
eagerLoadingGqlConditions
elementConditionRuleType	string, array, null
elementValidationRules	array
errors	array – Errors for all attributes or the specified attribute.
firstErrors	array – The first errors.
handle	string, null – The field’s handle
icon	string, null
id	integer, string, null – The component’s ID (could be a temporary one: "new:X")
inputId	string
inputSelectionCriteria	array
inputSources	array, string, null
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
localizeRelations	boolean – Whether each site should get its own unique set of relations
maintainHierarchy	boolean – Whether to automatically relate structural ancestors.
maxRelations	integer, null – The maximum number of relations this field can have (used if allowLimit is set to true).
minRelations	integer, null – The maximum number of relations this field can have (used if allowLimit is set to true).
name	string, null – The field’s name
oldHandle	string, null – The field’s previous handle
oldSettings	array, null – The field’s previous settings
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.
selectionCondition	craft\elements\conditions\ElementConditionInterface, null
selectionLabel	string, null – The label that should be used on the selection input
settings	array – The component’s settings
settingsHtml	string, null
showCardsInGrid	boolean – Whether cards should be shown in a multi-column grid
showSiteMenu	boolean – Whether the site menu should be shown in element selector modals.
sortOption
source	string, null – The source key that this field can relate elements from (used if allowMultipleSources is set to false)
sourceOptions	array
sources	string, string[], null – The source keys that this field can relate elements from (used if allowMultipleSources is set to true)
targetSiteFieldHtml	string, null
targetSiteId	string, null – The UID of the site that this field should relate elements from
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.
validateRelatedElements	boolean – Whether related elements should be validated when the source element is saved.
validators	ArrayObject, yii\validators\Validator – All the validators declared in the model.
valueSql	string, null
viewMode	string, null – The view mode
viewModeFieldHtml	string, null

allowLimit

Type

boolean

Default value

true

Whether to show the Min Relations and Max Relations settings.

View source

allowMultipleSources

Type

boolean

Default value

true

Whether to allow multiple source selection in the settings

View source

allowSelfRelations

Type

boolean

Default value

false

Since

3.4.21

Whether elements should be allowed to relate themselves.

View source

branchLimit

Type

integer, null

Default value

null

Since

4.4.0

Branch limit

View source

contentGqlMutationArgumentType

Type

\GraphQL\Type\Definition\Type, array

Default value

null

Access

Read-only

Since

3.5.0

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

inputSelectionCriteria

Type

array

Default value

null

Access

Read-only

View source

inputSources

Type

array, string, null

Default value

null

Access

Read-only

View source

localizeRelations

DEPRECATED

Deprecated in 5.3.0

Type

boolean

Default value

false

Whether each site should get its own unique set of relations

View source

maintainHierarchy

Type

boolean

Default value

false

Since

4.4.0

Whether to automatically relate structural ancestors.

View source

maxRelations

Type

integer, null

Default value

null

Since

4.0.0

The maximum number of relations this field can have (used if allowLimit is set to true).

View source

minRelations

Type

integer, null

Default value

null

Since

4.0.0

The maximum number of relations this field can have (used if allowLimit is set to true).

View source

selectionCondition

Type

craft\elements\conditions\ElementConditionInterface, null

Default value

null

Since

4.0.0

View source

selectionLabel

Type

string, null

Default value

null

The label that should be used on the selection input

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

showSiteMenu

Type

boolean

Default value

false

Since

3.5.0

Whether the site menu should be shown in element selector modals.

View source

source

Type

string, null

Default value

null

The source key that this field can relate elements from (used if allowMultipleSources is set to false)

View source

sourceOptions

Type

array

Default value

null

Access

Read-only

View source

sources

Type

string, string[], null

Default value

'*'

The source keys that this field can relate elements from (used if allowMultipleSources is set to true)

View source

targetSiteFieldHtml

Type

string, null

Default value

null

Access

Read-only

View source

targetSiteId

Type

string, null

Default value

null

The UID of the site that this field should relate elements from

View source

validateRelatedElements

Type

boolean

Default value

false

Whether related elements should be validated when the source element is saved.

View source

viewMode

Type

string, null

Default value

null

The view mode

View source

viewModeFieldHtml

Type

string, null

Default value

null

Access

Read-only

View source

Protected Properties

Property	Description
allowLargeThumbsView	boolean – Whether to allow the “Large Thumbnails” view mode
inputJsClass	string, null – The JS class that should be initialized for the input
inputTemplate	string – Template to use for field rendering
settingsTemplate	string – Template to use for settings rendering
sortable	boolean – Whether the elements have a custom sort order

allowLargeThumbsView

Type

boolean

Default value

false

Whether to allow the “Large Thumbnails” view mode

View source

inputJsClass

Type

string, null

Default value

null

The JS class that should be initialized for the input

View source

inputTemplate

Type

string

Default value

'_includes/forms/elementSelect.twig'

Template to use for field rendering

View source

settingsTemplate

Type

string

Default value

'_components/fieldtypes/elementfieldsettings.twig'

Template to use for settings rendering

View source

sortable

Type

boolean

Default value

true

Whether the elements have a custom sort order

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.
afterMergeFrom()
afterMergeInto()
afterSave()	Performs actions after a component 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.
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.
canGetProperty()	Returns a value indicating whether a property can be read.
canMergeFrom()
canMergeInto()
canSetProperty()	Returns a value indicating whether a property can be set.
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.
defaultSelectionLabel()	Returns the default selectionLabel value.
detachBehavior()	Detaches a behavior from the component.
detachBehaviors()	Detaches all behaviors from the component.
displayName()	Returns the display name of this class.
elementType()	Returns the element class associated with this field type.
ensureBehaviors()	Makes sure that the behaviors declared in behaviors() are attached to this component.
existsQueryCondition()	Returns a query builder-compatible condition for an element query, limiting the results to only elements where the given relation field has a value.
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.
forceUpdateRelations()	Returns whether relations should be updated for the field.
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()
getActionMenuItems()	Returns action menu items for the component.
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.
getCpEditUrl()
getEagerLoadingGqlConditions()
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.
getErrorSummary()	Returns the errors for all attributes as a one-dimensional array.
getErrors()	Returns the errors for all attributes or a single attribute.
getFirstError()	Returns the first error of the specified attribute.
getFirstErrors()	Returns the first error of every attribute in the model.
getHandle()
getIcon()	Returns the component’s icon, if it has one.
getId()
getInlineInputHtml()
getInputHtml()	Returns the field’s input HTML.
getInputId()	Returns the input’s ID, which the <label>’s for attribute should reference.
getInputSelectionCriteria()	Returns any additional criteria parameters limiting which elements the field should be able to select.
getInputSources()	Returns an array of the source keys the field should be able to select elements from.
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()
getRelationTargetIds()	Returns the related element IDs for this field.
getScenario()	Returns the scenario that this model is used in.
getSearchKeywords()	Returns the search keywords that should be associated with this field.
getSelectionCondition()	Returns the element condition that should be used to determine which elements are selectable by the field.
getSettings()	Returns an array of the component’s settings.
getSettingsHtml()	Returns the component’s settings HTML.
getSortOption()
getSourceOptions()	Normalizes the available sources into select input options.
getStaticHtml()	Returns a static (non-editable) version of the field’s input HTML.
getStatus()	Returns the status of the field for a given element.
getTargetSiteFieldHtml()	Returns the HTML for the Target Site setting.
getThumbHtml()	Returns the HTML for an element’s thumbnail.
getTranslationDescription()	Returns the description of this field’s translation support.
getTranslationKey()	Returns the field’s translation key, based on a given element.
getUiLabel()
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.
getViewModeFieldHtml()	Returns the HTML for the View Mode setting.
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.
localizeRelations()	Returns whether relations stored for the field should include the source element’s site ID.
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.
previewPlaceholderHtml()
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.
setIsFresh()	Sets whether the field is fresh.
setScenario()	Sets the scenario for the model.
setSelectionCondition()	Sets the element condition that should be used to determine which elements are selectable by the field.
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.
validateRelatedElements()	Validates the related elements.
validateRelationCount()	Validates that the number of related elements are within the min/max relation bounds.
validateSources()	Ensure only one structured source is selected when maintainHierarchy is true.

__construct()

Constructor

View source

Arguments

• $config

afterElementSave()

Performs actions after the element has been saved.

View source

Arguments

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

afterSave()

Performs actions after a component is saved.

View source

Arguments

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

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).

defaultSelectionLabel()

Returns the default selectionLabel value.

View source

Returns

string – The default selection label

elementType()

Returns the element class associated with this field type.

View source

Returns

class-string<\craft\base\ElementInterface> – The Element class name

existsQueryCondition()

Since

5.2.0

Returns a query builder-compatible condition for an element query, limiting the results to only elements where the given relation field has a value.

View source

Arguments

• $field (self) – The relation field
• $enabledOnly (boolean) – Whether to only
• $inTargetSiteOnly (boolean)

Returns

array

forceUpdateRelations()

Returns whether relations should be updated for the field.

View source

Arguments

• $element (craft\base\ElementInterface)

Returns

boolean

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

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

getInputSelectionCriteria()

Returns any additional criteria parameters limiting which elements the field should be able to select.

View source

Returns

array

getInputSources()

Returns an array of the source keys the field should be able to select elements from.

View source

Arguments

• $element (craft\base\ElementInterface, null)

Returns

array, string, null

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

getPreviewHtml()

Since

5.0.0

View source

Arguments

• $value
• $element

getRelationTargetIds()

Returns the related element IDs for this field.

View source

Arguments

• $element (craft\base\ElementInterface)

Returns

integer[]

getSelectionCondition()

Since

4.0.0

Returns the element condition that should be used to determine which elements are selectable by the field.

View source

Returns

craft\elements\conditions\ElementConditionInterface, null

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

getSourceOptions()

Normalizes the available sources into select input options.

View source

Returns

array

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

getTargetSiteFieldHtml()

Returns the HTML for the Target Site setting.

View source

Returns

string, null

getThumbHtml()

Returns the HTML for an element’s thumbnail.

View source

Arguments

• $value (mixed) – The field’s value
• $element (craft\base\ElementInterface) – The element the field is associated with
• $size (integer) – The maximum width and height the thumbnail should have.

Returns

string, null

getViewModeFieldHtml()

Returns the HTML for the View Mode setting.

View source

Returns

string, null

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”

localizeRelations()

Returns whether relations stored for the field should include the source element’s site ID.

Note that this must be consistent across all instances of the same field.

View source

Returns

boolean

modifyElementIndexQuery()

Since

3.0.9

Modifies an element index query.

This method will be called whenever an element index is being loaded, which contains a column for this field.

View source

Arguments

• $query (craft\elements\db\ElementQueryInterface) – The element query

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

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

previewPlaceholderHtml()

Since

5.5.0

View source

Arguments

• $value
• $element

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

setSelectionCondition()

Since

4.0.0

Sets the element condition that should be used to determine which elements are selectable by the field.

View source

Arguments

• $condition (craft\elements\conditions\ElementConditionInterface, string, array, null)

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

useFieldset()

Since

3.6.0

Returns whether the field should use a <fieldset> + <legend> instead of a <div> + <label>.

View source

Returns

boolean

validateRelatedElements()

Validates the related elements.

View source

Arguments

• $element (craft\base\ElementInterface)

validateRelationCount()

Validates that the number of related elements are within the min/max relation bounds.

View source

Arguments

• $element (craft\base\ElementInterface)

validateSources()

Since

4.4.0

Ensure only one structured source is selected when maintainHierarchy is true.

View source

Arguments

• $attribute (string)

Protected Methods

Method	Description
availableSources()	Returns the sources that should be available to choose from within the field's settings
createSelectionCondition()	Creates an element condition that should be used to determine which elements are selectable by the field.
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.
inputTemplateVariables()	Returns an array of variables that should be passed to the input template.
isFresh()	Returns whether this is the first time the element’s content has been edited.
previewHtml()	Returns the HTML that should be shown for this field in table and card views.
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.
settingsTemplateVariables()	Returns an array of variables that should be passed to the settings template.
supportedViewModes()	Returns the field’s supported view modes.
targetSiteId()	Returns the site ID that target elements should have.
valueSql()	Returns a coalescing value SQL expression for the given field instances.
viewMode()	Returns the field’s current view mode.

availableSources()

Returns the sources that should be available to choose from within the field's settings

View source

Returns

array

createSelectionCondition()

Since

4.0.0

Creates an element condition that should be used to determine which elements are selectable by the field.

The condition’s queryParams property should be set to any element query params that are already covered by other field settings.

View source

Returns

craft\elements\conditions\ElementConditionInterface, null

defineRules()

Since

3.4.9

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.

inputTemplateVariables()

Returns an array of variables that should be passed to the input template.

View source

Arguments

• $value (array, craft\elements\db\ElementQueryInterface, null)
• $element (craft\base\ElementInterface, null)

Returns

array

previewHtml()

Since

5.0.0

Returns the HTML that should be shown for this field in table and card views.

View source

Arguments

• $elements (craft\elements\ElementCollection)

Returns

string

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.

settingsTemplateVariables()

Since

3.2.10

Returns an array of variables that should be passed to the settings template.

View source

Returns

array

supportedViewModes()

Returns the field’s supported view modes.

View source

Returns

array

targetSiteId()

Returns the site ID that target elements should have.

View source

Arguments

• $element (craft\base\ElementInterface, null)

Returns

integer

viewMode()

Returns the field’s current view mode.

View source

Returns

string

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

Events

EVENT_DEFINE_SELECTION_CRITERIA

Type

craft\events\ElementCriteriaEvent

Since

3.4.16

The event that is triggered when defining the selection criteria for this field.

---