FieldInterface
- Type
- Interface
- Namespace
- craft\base
- Extends
- craft\base\Chippable, craft\base\CpEditable, craft\base\Grippable, craft\base\SavableComponentInterface
- Implemented by
- craft\base\ElementContainerFieldInterface, craft\base\Field, craft\base\MergeableFieldInterface, craft\base\PreviewableFieldInterface, craft\base\RelationalFieldInterface, craft\base\ThumbableFieldInterface, craft\fields\Addresses, 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\Icon, craft\fields\Lightswitch, craft\fields\Link, 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\Users
- Since
- 3.0.0
FieldInterface defines the common interface to be implemented by field classes.
A class implementing this interface should also use craft\base\SavableComponentTrait and craft\base\FieldTrait.
Public Methods
Method | Description |
---|---|
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. |
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. |
copyValue() | Copies the field’s value from one element to another. |
dbType() | Returns the DB data type(s) that this field will store within the elements_sites.content column. |
displayName() | Returns the display name of this class. |
extraFields() | Returns the list of additional fields that can be returned by toArray() in addition to those listed in fields(). |
fields() | Returns the list of fields that should be returned by default by toArray() when no specific fields are specified. |
get() | Returns a component by its ID. |
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() | Returns the URL to the component’s edit page in the control panel. |
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. |
getHandle() | Returns the handle of the component. |
getId() | Returns the ID of the component, which should be used as the value of hidden 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. |
getLabelId() | Returns the input’s label ID. |
getOrientation() | Returns the orientation the field should use (ltr or rtl ). |
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. |
getStaticHtml() | Returns a static (non-editable) version of the field’s input HTML. |
getStatus() | Returns the status of the field for a given element. |
getTranslationDescription() | Returns the description of this field’s translation support. |
getTranslationKey() | Returns the field’s translation key, based on a given element. |
getUiLabel() | Returns what the component should be called within the control panel. |
getValueSql() | Returns a SQL expression which extracts the field’s value from the elements_sites.content column. |
icon() | Returns the field type’s SVG icon. |
includeInGqlSchema() | Returns whether the field should be included in the given GraphQL schema. |
instance() | Returns static class instance, which can be used to obtain meta information. |
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. |
modifyElementIndexQuery() | Modifies an element index query. |
normalizeValue() | Normalizes the field’s value for use. |
normalizeValueFromRequest() | Normalizes a posted field value for use. |
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. |
serializeValue() | Prepares the field’s value to be stored somewhere, like the content table. |
setIsFresh() | Sets whether the field is fresh. |
settingsAttributes() | Returns the list of settings attribute names. |
supportedTranslationMethods() | Returns which translation methods the field supports. |
toArray() | Converts the object into an array. |
useFieldset() | Returns whether the field should use a <fieldset> + <legend> instead of a <div> + <label> . |
afterElementDelete()
Performs actions after the element has been deleted.
Arguments
$element
(craft\base\ElementInterface) – The element that was just deleted
afterElementDeleteForSite()
- Since
- 4.7.0
Performs actions after the element has been deleted.
Arguments
$element
(craft\base\ElementInterface) – The element that was just deleted for a site
afterElementPropagate()
- Since
- 3.2.0
Performs actions after the element has been fully saved and propagated to other sites.
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.
Arguments
$element
(craft\base\ElementInterface) – The element that was just restored
afterElementSave()
Performs actions after the element has been saved.
Arguments
$element
(craft\base\ElementInterface) – The element that was just saved$isNew
(boolean) – Whether the element is brand new
beforeElementDelete()
Performs actions before an element is deleted.
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.
Arguments
$element
(craft\base\ElementInterface) – The element that is about to be deleted
Returns
boolean – Whether the element should be deleted for a site
beforeElementRestore()
- Since
- 3.1.0
Performs actions before an element is restored.
Arguments
$element
(craft\base\ElementInterface) – The element that is about to be restored
Returns
boolean – Whether the element should be restored
beforeElementSave()
Performs actions before an element is saved.
Arguments
$element
(craft\base\ElementInterface) – The element that is about to be saved$isNew
(boolean) – Whether the element is brand new
Returns
boolean – Whether the element should be saved
copyValue()
- Since
- 3.7.0
Copies the field’s value from one element to another.
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().
Returns
string, string[], null – The column type(s).
getContentGqlMutationArgumentType()
- Since
- 3.5.0
Returns the GraphQL type to be used as an argument in mutations for this field type.
Returns
\GraphQL\Type\Definition\Type
, array
getContentGqlQueryArgumentType()
- Since
- 3.5.0
Returns the GraphQL type to be used as an argument in queries for this field type.
Returns
\GraphQL\Type\Definition\Type
, array
getContentGqlType()
- Since
- 3.3.0
Returns the GraphQL type to be used for this field type.
Returns
\GraphQL\Type\Definition\Type
, array
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.
Returns
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],
]
Returns
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:
- craft\helpers\Html::id() will generate a valid element ID from an input name.
- 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 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().
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
Returns
string – The input HTML.
getInputId()
- Since
- 3.7.32
Returns the input’s ID, which the <label>
’s for
attribute should reference.
Returns
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().
Arguments
$element
(craft\base\ElementInterface, null) – The element being edited
Returns
getLabelId()
- Since
- 4.1.0
Returns the input’s label ID.
Returns
getOrientation()
- Since
- 3.7.5
Returns the orientation the field should use (ltr
or rtl
).
Arguments
$element
(craft\base\ElementInterface, null) – The element being edited
Returns
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.
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.
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.
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
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:
- A
\craft\enums\AttributeStatus
case - The status label
For example:
return [AttributeStatus::Modified, 'The field has been modified.');
Arguments
$element
(craft\base\ElementInterface)
getTranslationDescription()
- Since
- 3.4.0
Returns the description of this field’s translation support.
Arguments
$element
(craft\base\ElementInterface, null) – The element being edited
Returns
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.
Arguments
$element
(craft\base\ElementInterface) – The element being saved
Returns
string – The translation key
getValueSql()
- Since
- 5.0.0
Returns a SQL expression which extracts the field’s value from the elements_sites.content
column.
Arguments
Returns
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/.
Returns
includeInGqlSchema()
- Since
- 3.6.0
Returns whether the field should be included in the given GraphQL schema.
Arguments
$schema
(craft\models\GqlSchema)
Returns
isMultiInstance()
- Since
- 5.0.0
Returns whether the field can be included multiple times within a field layout.
Returns
isRequirable()
- Since
- 4.0.0
Returns whether the field can be marked as required.
Returns
isValueEmpty()
Returns whether the given value should be considered “empty” to a validator.
See also yii\validators\Validator::$isEmptyView 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”
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.
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 acontent
table column per\craft\base\hasContentColumn()
, the value will benull
.) - 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.
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.
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';
}
Returns
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.
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.
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
setIsFresh()
Sets whether the field is fresh.
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)
See also getTranslationKey()View source
Returns
string[]
useFieldset()
- Since
- 3.6.0
Returns whether the field should use a <fieldset>
+ <legend>
instead of a <div>
+ <label>
.