Field

Type
Abstract Class
Namespace
craft\base
Inherits
craft\base\Field » craft\base\SavableComponent » craft\base\ConfigurableComponent » craft\base\Component » craft\base\Model » yii\base\Model (opens new window) » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
Implements
ArrayAccess (opens new window), IteratorAggregate (opens new window), craft\base\ComponentInterface, craft\base\ConfigurableComponentInterface, craft\base\FieldInterface, craft\base\ModelInterface, craft\base\SavableComponentInterface, yii\base\Arrayable (opens new window), yii\base\Configurable (opens new window), yii\base\StaticInstanceInterface (opens new window)
Uses traits
craft\base\ClonefixTrait, craft\base\FieldTrait, craft\base\SavableComponentTrait, yii\base\ArrayableTrait (opens new window), yii\base\StaticInstanceTrait (opens new window)
Extended by
craft\fields\Assets, craft\fields\BaseOptionsField, craft\fields\BaseRelationField, craft\fields\Categories, craft\fields\Checkboxes, craft\fields\Color, craft\fields\Country, craft\fields\Date, craft\fields\Dropdown, craft\fields\Email, craft\fields\Entries, craft\fields\Lightswitch, craft\fields\Matrix, craft\fields\MissingField, craft\fields\Money, craft\fields\MultiSelect, craft\fields\Number, craft\fields\PlainText, craft\fields\RadioButtons, craft\fields\Table, craft\fields\Tags, craft\fields\Time, craft\fields\Url, craft\fields\Users
Since
3.0.0

Field is the base class for classes representing fields in terms of objects.

View source (opens new window)

# Public Properties

Property Description
activeValidators (opens new window) yii\validators\Validator (opens new window) – The validators applicable to the current scenario (opens new window).
attributes (opens new window) array (opens new window) – Attribute values (name => value).
behaviors (opens new window) yii\base\Behavior (opens new window) – List of behaviors attached to this component.
columnPrefix string (opens new window), null (opens new window) – The field’s content column prefix
columnSuffix string (opens new window), null (opens new window) – The field’s content column suffix
contentColumnType string (opens new window), string (opens new window)[] – The column type(s).
contentGqlMutationArgumentType \GraphQL\Type\Definition\Type, array (opens new window)
contentGqlQueryArgumentType \GraphQL\Type\Definition\Type, array (opens new window)
contentGqlType \GraphQL\Type\Definition\Type, array (opens new window)
context string (opens new window), null (opens new window) – The field’s context
dateCreated DateTime (opens new window), null (opens new window) – The date that the component was created
dateUpdated DateTime (opens new window), null (opens new window) – The date that the component was last updated
describedBy string (opens new window), null (opens new window) – The aria-describedby attribute value that should be set on the focusable input(s).
eagerLoadingGqlConditions array (opens new window), null (opens new window)
elementConditionRuleType string (opens new window), array (opens new window), null (opens new window)
elementValidationRules array (opens new window)
errors (opens new window) array (opens new window) – Errors for all attributes or the specified attribute.
firstErrors (opens new window) array (opens new window) – The first errors.
group craft\models\FieldGroup, null (opens new window)
groupId integer (opens new window), null (opens new window) – The field’s group’s ID
handle string (opens new window), null (opens new window) – The field’s handle
id integer (opens new window), string (opens new window), null (opens new window) – The component’s ID (could be a temporary one: "new:X")
inputId string (opens new window)
instructions string (opens new window), null (opens new window) – The field’s instructions
isNew boolean (opens new window) – Whether the component is new (unsaved)
isTranslatable boolean (opens new window)
iterator (opens new window) ArrayIterator (opens new window) – An iterator for traversing the items in the list.
labelId string (opens new window)
layoutId integer (opens new window), null (opens new window) – The ID of the field layout that the field was fetched from
name string (opens new window), null (opens new window) – The field’s name
oldHandle string (opens new window), null (opens new window) – The field’s previous handle
oldSettings array (opens new window), null (opens new window) – The field’s previous settings
required boolean (opens new window), null (opens new window) – Whether the field is required in the field layout it was fetched from
scenario (opens new window) string (opens new window) – The scenario that this model is in.
searchable boolean (opens new window) – Whether the field's values should be registered as search keywords on the elements.
settings array (opens new window) – The component’s settings
settingsHtml string (opens new window), null (opens new window)
sortOption array (opens new window)
sortOrder integer (opens new window), null (opens new window) – The field’s sort position in the field layout it was fetched from
tabId integer (opens new window), null (opens new window) – The tab ID of the field layout that the field was fetched from
translationDescription string (opens new window), null (opens new window)
translationKeyFormat string (opens new window), null (opens new window) – The field’s translation key format, if translationMethod is "custom"
translationMethod string (opens new window) – The field’s translation method
uid string (opens new window), null (opens new window) – The field's UID
validators (opens new window) ArrayObject (opens new window), yii\validators\Validator (opens new window) – All the validators declared in the model.

# contentColumnType

Type
string (opens new window), string (opens new window)[]
Default value
null
Access
Read-only

The column type(s). yii\db\QueryBuilder::getColumnType() (opens new window) will be called to convert the give column type to the physical one. For example, string will be converted as varchar(255) and string(100) becomes varchar(100). not null will automatically be appended as well.

View source (opens new window)

# contentGqlMutationArgumentType

Type
\GraphQL\Type\Definition\Type, array (opens new window)
Default value
null
Access
Read-only
Since
3.5.0

View source (opens new window)

# contentGqlQueryArgumentType

Type
\GraphQL\Type\Definition\Type, array (opens new window)
Default value
null
Access
Read-only
Since
3.5.0

View source (opens new window)

# contentGqlType

Type
\GraphQL\Type\Definition\Type, array (opens new window)
Default value
null
Access
Read-only
Since
3.3.0

View source (opens new window)

# eagerLoadingGqlConditions

Type
array (opens new window), null (opens new window)
Default value
null
Access
Read-only
Since
3.3.0

View source (opens new window)

# elementConditionRuleType

Type
string (opens new window), array (opens new window), null (opens new window)
Default value
null
Access
Read-only

View source (opens new window)

# elementValidationRules

Type
array (opens new window)
Default value
null
Access
Read-only

View source (opens new window)

# group

Type
craft\models\FieldGroup, null (opens new window)
Default value
null
Access
Read-only

View source (opens new window)

# inputId

Type
string (opens new window)
Default value
null
Access
Read-only
Since
3.7.32

View source (opens new window)

# isTranslatable

Type
boolean (opens new window)
Default value
null
Access
Read-only

View source (opens new window)

# labelId

Type
string (opens new window)
Default value
null
Access
Read-only
Since
4.1.0

View source (opens new window)

# sortOption

Type
array (opens new window)
Default value
null
Access
Read-only
Since
3.2.0

View source (opens new window)

# translationDescription

Type
string (opens new window), null (opens new window)
Default value
null
Access
Read-only
Since
3.4.0

View source (opens new window)

# Public Methods

Method Description
__call() (opens new window) Calls the named method which is not a class method.
__clone()
__construct()
__get() (opens new window) Returns the value of a component property.
__isset() (opens new window) Checks if a property is set, i.e. defined and not null.
__set() (opens new window) Sets the value of a component property.
__toString() Use the translated field name as the string representation.
__unset() (opens new window) Sets a component property to be null.
activeAttributes() (opens new window) Returns the attribute names that are subject to validation in the current scenario.
addError() (opens new window) Adds a new error to the specified attribute.
addErrors() (opens new window) 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.
afterValidate() (opens new window) This method is invoked after validation ends.
attachBehavior() (opens new window) Attaches a behavior to this component.
attachBehaviors() (opens new window) Attaches a list of behaviors to the component.
attributeHints() (opens new window) Returns the attribute hints.
attributeLabels() Returns the attribute labels.
attributes() (opens new window) 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() (opens new window) This method is invoked before validation starts.
behaviors() Returns a list of behaviors that this component should behave as.
canGetProperty() (opens new window) Returns a value indicating whether a property can be read.
canSetProperty() (opens new window) Returns a value indicating whether a property can be set.
className() (opens new window) Returns the fully qualified name of this class.
clearErrors() (opens new window) Removes errors for all attributes or a single attribute.
copyValue() Copies the field’s value from one element to another.
createValidators() (opens new window) Creates validator objects based on the validation rules specified in rules() (opens new window).
datetimeAttributes() Returns the names of any attributes that should hold DateTime (opens new window) values.
detachBehavior() (opens new window) Detaches a behavior from the component.
detachBehaviors() (opens new window) Detaches all behaviors from the component.
displayName() Returns the display name of this class.
ensureBehaviors() (opens new window) Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component.
extraFields() (opens new window) Returns the list of fields that can be expanded further and returned by toArray() (opens new window).
fields() (opens new window) Returns the list of fields that should be returned by default by toArray() (opens new window) when no specific fields are specified.
formName() (opens new window) Returns the form name that this model class should use.
generateAttributeLabel() (opens new window) Generates a user friendly attribute label based on the give attribute name.
getActiveValidators() (opens new window) Returns the validators applicable to the current scenario (opens new window).
getAttributeHint() (opens new window) Returns the text hint for the specified attribute.
getAttributeLabel() (opens new window) Returns the text label for the specified attribute.
getAttributes() (opens new window) Returns attribute values.
getBehavior() (opens new window) Returns the named behavior object.
getBehaviors() (opens new window) Returns all behaviors attached to this component.
getContentColumnType() Returns the column type(s) that this field should get within the content table.
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.
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() (opens new window) Returns the errors for all attributes as a one-dimensional array.
getErrors() (opens new window) Returns the errors for all attributes or a single attribute.
getFirstError() (opens new window) Returns the first error of the specified attribute.
getFirstErrors() (opens new window) Returns the first error of every attribute in the model.
getGroup() Returns the field’s group.
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() (opens new window) 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).
getScenario() (opens new window) 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.
getTableAttributeHtml() Returns the HTML that should be shown for this field in Table View.
getTranslationDescription() Returns the description of this field’s translation support.
getTranslationKey() Returns the field’s translation key, based on a given element.
getValidators() (opens new window) Returns all the validators declared in rules() (opens new window).
hasContentColumn() Returns whether this field has a column in the content table.
hasErrors() Returns a value indicating whether there is any validation error.
hasEventHandlers() (opens new window) Returns a value indicating whether there is any handler attached to the named event.
hasMethod() (opens new window) Returns a value indicating whether a method is defined.
hasProperty() (opens new window) Returns a value indicating whether a property is defined for this component.
includeInGqlSchema() Returns whether the field should be included in the given GraphQL schema.
init() Initializes the object.
instance() (opens new window) Returns static class instance, which can be used to obtain meta information.
isAttributeActive() (opens new window) Returns a value indicating whether the attribute is active in the current scenario.
isAttributeRequired() (opens new window) Returns a value indicating whether the attribute is required.
isAttributeSafe() (opens new window) Returns a value indicating whether the attribute is safe for massive assignments.
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() (opens new window) Populates the model with input data.
loadMultiple() (opens new window) Populates a set of models with the data from end user.
modifyElementIndexQuery() Modifies an element index query.
modifyElementsQuery() Modifies an element query.
normalizeValue() Normalizes the field’s value for use.
normalizeValueFromRequest() Normalizes a posted field value for use.
off() (opens new window) Detaches an existing event handler from this component.
offsetExists() (opens new window) Returns whether there is an element at the specified offset.
offsetGet() (opens new window) Returns the element at the specified offset.
offsetSet() (opens new window) Sets the element at the specified offset.
offsetUnset() (opens new window) Sets the element value at the specified offset to null.
on() (opens new window) Attaches an event handler to an event.
onUnsafeAttribute() (opens new window) This method is invoked when an unsafe attribute is being massively assigned.
rules() Returns the validation rules for attributes.
safeAttributes() (opens new window) Returns the attribute names that are safe to be massively assigned in the current scenario.
scenarios() (opens new window) 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() (opens new window) Sets the scenario for the model.
settingsAttributes() Returns the list of settings attribute names.
supportedTranslationMethods() Returns which translation methods the field supports.
toArray() (opens new window) Converts the model into an array.
trigger() (opens new window) Triggers an event.
useFieldset() Returns whether the field should use a <fieldset> + <legend> instead of a <div> + <label>.
validate() (opens new window) Performs the data validation.
validateMultiple() (opens new window) Validates multiple models.
valueType() Returns the PHPDoc type this field’s values will have.

# __toString()

Use the translated field name as the string representation.

View source (opens new window)

Returns

string (opens new window)

# afterElementDelete()

Performs actions after the element has been deleted.

View source (opens new window)

Arguments

# afterElementDeleteForSite()

Since
4.7.0

Performs actions after the element has been deleted.

View source (opens new window)

Arguments

# afterElementPropagate()

Since
3.2.0

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

View source (opens new window)

Arguments

# afterElementRestore()

Since
3.1.0

Performs actions after the element has been restored.

View source (opens new window)

Arguments

# afterElementSave()

Performs actions after the element has been saved.

View source (opens new window)

Arguments

# attributeLabels()

Returns the attribute labels.

Attribute labels are mainly used for display purpose. For example, given an attribute firstName, we can declare a label First Name which is more user-friendly and can be displayed to end users.

By default an attribute label is generated using generateAttributeLabel() (opens new window). This method allows you to explicitly specify attribute labels.

Note, in order to inherit labels defined in the parent class, a child class needs to merge the parent labels with child labels using functions such as array_merge().

View source (opens new window)

Returns

array (opens new window) – Attribute labels (name => label)

# beforeElementDelete()

Performs actions before an element is deleted.

View source (opens new window)

Arguments

Returns

boolean (opens new window) – Whether the element should be deleted

# beforeElementDeleteForSite()

Since
4.7.0

Performs actions before an element is deleted for a site.

View source (opens new window)

Arguments

Returns

boolean (opens new window) – Whether the element should be deleted for a site

# beforeElementRestore()

Since
3.1.0

Performs actions before an element is restored.

View source (opens new window)

Arguments

Returns

boolean (opens new window) – Whether the element should be restored

# beforeElementSave()

Performs actions before an element is saved.

View source (opens new window)

Arguments

Returns

boolean (opens new window) – Whether the element should be saved

# beforeSave()

Performs actions before a component is saved.

View source (opens new window)

Arguments

Returns

boolean (opens new window) – Whether the component should be saved

# copyValue()

Since
3.7.0

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

View source (opens new window)

Arguments

# getContentColumnType()

Returns the column type(s) that this field should get within the content table.

This method will only be called if hasContentColumn() returns true.

If the field type requires multiple columns, an array should be returned:

return [
    'date' => 'datetime',
    'tz' => 'string',
];

When this is the case, all columns’ values will be passed to normalizeValue() as an associative array, whose keys match the keys returned by this method. The field type should also override serializeValue() to ensure values are being returned as associative arrays using the same keys.

WARNING

JSON columns do not work with MariaDB, so they should not be used by plugins which will be shared publicly.

View source (opens new window)

Returns

string (opens new window), string (opens new window)[] – The column type(s). yii\db\QueryBuilder::getColumnType() (opens new window) will be called to convert the give column type to the physical one. For example, string will be converted as varchar(255) and string(100) becomes varchar(100). not null will automatically be appended as well.

# getContentGqlMutationArgumentType()

Since
3.5.0

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

View source (opens new window)

Returns

\GraphQL\Type\Definition\Type, array (opens new window)

# getContentGqlQueryArgumentType()

Since
3.5.0

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

View source (opens new window)

Returns

\GraphQL\Type\Definition\Type, array (opens new window)

# getContentGqlType()

Since
3.3.0

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

View source (opens new window)

Returns

\GraphQL\Type\Definition\Type, array (opens new window)

# getEagerLoadingGqlConditions()

Since
3.3.0

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.

View source (opens new window)

Returns

array (opens new window), null (opens new window)

# 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 (opens new window)

Returns

string (opens new window), array (opens new window), null (opens new window)

# 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() (opens new window), 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 (opens new window) to live:

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

View source (opens new window)

Returns

array (opens new window)

# getGroup()

Returns the field’s group.

View source (opens new window)

Returns

craft\models\FieldGroup, null (opens new window)

# getInputHtml()

Returns the field’s input HTML.

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

return '<textarea name="'.$name.'">'.$value.'</textarea>';

For more complex inputs, 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 path/to/myplugin/templates/_fieldinput.html, passing the $name and $value variables to it:

return Craft::$app->view->renderTemplate('myplugin/_fieldinput', [
    'name'  => $name,
    'value' => $value
]);

If you need to tie any JavaScript code to your input, 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 getInputHtml() 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:

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

public function getInputHtml($value, $element): string
{
    // Generate a valid ID based on the input name
    $id = craft\helpers\Html::id($name);
    // Figure out what that ID is going to be namespaced into
    $namespacedId = Craft::$app->view->namespaceInputId($id);
    // Render and return the input template
    return Craft::$app->view->renderTemplate('myplugin/_fieldinput', [
        'name' => $name,
        'id' => $id,
        'namespacedId' => $namespacedId,
        'value' => $value,
    ]);
}

And the _fieldinput.html template might look like this:

<textarea id="{{ id }}" name="{{ name }}">{{ value }}</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 (opens new window)

Arguments

Returns

string (opens new window) – The input HTML.

# getInputId()

Since
3.7.32

Returns the input’s ID, which the <label>’s for attribute should reference.

View source (opens new window)

Returns

string (opens new window)

# 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 (opens new window)

Arguments

Returns

boolean (opens new window)

# getLabelId()

Since
4.1.0

Returns the input’s label ID.

View source (opens new window)

Returns

string (opens new window)

# getOrientation()

Since
3.7.5

Returns the orientation the field should use (ltr or rtl).

View source (opens new window)

Arguments

Returns

string (opens new window)

# getSearchKeywords()

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 (opens new window)

Arguments

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

Returns

string (opens new window) – A string of search keywords.

# getSortOption()

Since
3.2.0

Returns the sort option array that should be included in the element’s sortOptions() response.

See also craft\base\SortableFieldInterface::getSortOption() View source (opens new window)

Returns

array (opens new window)

# 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 (opens new window)

Arguments

Returns

string (opens new window) – The static version of the field’s input HTML

# getStatus()

Since
3.7.0

Returns the status of the field for a given element.

If the field has a known status, an array should be returned with two elements:

  • The status class (modified, outdated, or conflicted)
  • The status label

For example:

return ['modified', 'The field has been modified.');

View source (opens new window)

Arguments

Returns

array (opens new window), null (opens new window)

# getTableAttributeHtml()

Returns the HTML that should be shown for this field in Table View.

View source (opens new window)

Arguments

Returns

string (opens new window) – The HTML that should be shown for this field in Table View

# getTranslationDescription()

Since
3.4.0

Returns the description of this field’s translation support.

View source (opens new window)

Arguments

Returns

string (opens new window), null (opens new window)

# getTranslationKey()

Returns the field’s translation key, based on a given element.

When saving an element on a multi-site Craft install, if $propagate is true for craft\services\Elements::saveElement(), then getTranslationKey() will be called for each custom field and for each site the element should be propagated to. If the method returns the same value as it did for the initial site, then the initial site’s value will be copied over to the target site.

View source (opens new window)

Arguments

Returns

string (opens new window) – The translation key

# hasContentColumn()

Returns whether this field has a column in the content table.

WARNING

If you set this to false, you will be on your own in terms of saving and retrieving your field values.

View source (opens new window)

Returns

boolean (opens new window)

# includeInGqlSchema()

Since
3.6.0

Returns whether the field should be included in the given GraphQL schema.

View source (opens new window)

Arguments

Returns

boolean (opens new window)

# 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 (opens new window)

# isRequirable()

Since
4.0.0

Returns whether the field can be marked as required.

View source (opens new window)

Returns

boolean (opens new window)

# isValueEmpty()

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

View source (opens new window)

Arguments

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

Returns

boolean (opens new window) – Whether the value should be considered “empty”

# 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 (opens new window)

Arguments

# modifyElementsQuery()

Modifies an element query.

This method will be called whenever elements are being searched for that may have this field assigned to them. If the method returns false, the query will be stopped before it ever gets a chance to execute.

View source (opens new window)

Arguments

Throws

# 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 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 (opens new window)

Arguments

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 (opens new window)

Arguments

Returns

mixed – The prepared field value

# 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 (opens new window)

Arguments

Returns

mixed – The serialized field value

# setIsFresh()

Sets whether the field is fresh.

View source (opens new window)

Arguments

# 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 (opens new window)

Returns

string (opens new window)[]

# useFieldset()

Since
3.6.0

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

View source (opens new window)

Returns

boolean (opens new window)

# valueType()

Since
3.2.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 (opens new window)

Returns

string (opens new window)

# Protected Methods

Method Description
defineBehaviors() Returns the behaviors to attach to this class.
defineRules() Returns the validation rules for attributes.
extractFieldsFor() (opens new window) 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() (opens new window) 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() (opens new window) Determines which fields can be returned by toArray() (opens new window).
searchKeywords() Returns the search keywords that should be associated with this field.

# 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 (opens new window)

Returns

array (opens new window)

# inputHtml()

Since
3.5.0

Returns the field’s input HTML.

See also getInputHtml() View source (opens new window)

Arguments

Returns

string (opens new window) – The input HTML.

# isFresh()

Returns whether this is the first time the element’s content has been edited.

View source (opens new window)

Arguments

Returns

boolean (opens new window)

# requestParamName()

Returns the field’s param name on the request.

View source (opens new window)

Arguments

Returns

string (opens new window), null (opens new window) – The field’s param name on the request

# 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 (opens new window)

Arguments

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

Returns

string (opens new window) – 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

# Events

# EVENT_AFTER_ELEMENT_DELETE

Type
craft\events\FieldElementEvent

The event that is triggered after the element is deleted.

# EVENT_AFTER_ELEMENT_PROPAGATE

Type
craft\events\FieldElementEvent
Since
3.2.0

The event that is triggered after the element is fully saved and propagated to other sites.

# EVENT_AFTER_ELEMENT_RESTORE

Type
craft\events\FieldElementEvent
Since
3.1.0

The event that is triggered after the element is restored.

# EVENT_AFTER_ELEMENT_SAVE

Type
craft\events\FieldElementEvent

The event that is triggered after the element is saved.

# EVENT_BEFORE_ELEMENT_DELETE

Type
craft\events\FieldElementEvent

The event that is triggered before the element is deleted.

You may set yii\base\ModelEvent::$isValid (opens new window) to false to prevent the element from getting deleted.

# EVENT_BEFORE_ELEMENT_RESTORE

Type
craft\events\FieldElementEvent
Since
3.1.0

The event that is triggered before the element is restored.

You may set yii\base\ModelEvent::$isValid (opens new window) to false to prevent the element from getting restored.

# EVENT_BEFORE_ELEMENT_SAVE

Type
craft\events\FieldElementEvent

The event that is triggered before the element is saved.

You may set yii\base\ModelEvent::$isValid (opens new window) to false to prevent the element from getting saved.

# EVENT_DEFINE_INPUT_HTML

Type
craft\events\DefineFieldHtmlEvent
Since
3.5.0

The event that is triggered when defining the field’s input HTML.

# EVENT_DEFINE_KEYWORDS

Type
craft\events\DefineFieldKeywordsEvent
Since
3.5.0

The event that is triggered when defining the field’s search keywords for an element.

Note that you must set craft\base\Event::$handled (opens new window) to true if you want the field to accept your custom $keywords value.

Event::on(
    craft\fields\Lightswitch::class,
    craft\base\Field::EVENT_DEFINE_KEYWORDS,
    function(craft\events\DefineFieldKeywordsEvent $e
) {
    // @var craft\fields\Lightswitch $field
    $field = $e->sender;

    if ($field->handle === 'fooOrBar') {
        // Override the keywords depending on whether the lightswitch is enabled or not
        $e->keywords = $e->value ? 'foo' : 'bar';
        $e->handled = true;
    }
});