Field

Type
Abstract Class
Namespace
craft\base
Inherits
craft\base\Field » craft\base\SavableComponent » craft\base\Component » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject
Implements
ArrayAccess, IteratorAggregate, craft\base\ComponentInterface, craft\base\FieldInterface, craft\base\SavableComponentInterface, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface
Uses traits
craft\base\ClonefixTrait, craft\base\FieldTrait, craft\base\SavableComponentTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait
Extended by
craft\fields\Assets, craft\fields\BaseOptionsField, craft\fields\BaseRelationField, craft\fields\Categories, craft\fields\Checkboxes, craft\fields\Color, craft\fields\Date, craft\fields\Dropdown, craft\fields\Email, craft\fields\Entries, craft\fields\Lightswitch, craft\fields\Matrix, craft\fields\MissingField, craft\fields\MultiSelect, craft\fields\Number, craft\fields\PlainText, craft\fields\RadioButtons, craft\fields\Table, craft\fields\Tags, 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

# Public Properties

Property Description
activeValidators yii\validators\Validator – The validators applicable to the current scenario.
attributes array – Attribute values (name => value).
behaviors yii\base\Behavior – List of behaviors attached to this component
columnPrefix string, null – The field’s content column prefix
contentColumnType string – The column type.
contentGqlType \GraphQL\Type\Definition\Type, array
context string, null – The field’s context
dateCreated DateTime, null – The date that the component was created
dateUpdated DateTime, null – The date that the component was last updated
eagerLoadingGqlConditions array, false
elementValidationRules array
errors array – Errors for all attributes or the specified attribute.
firstErrors array – The first errors.
group craft\records\FieldGroup, null
groupId integer, null – The field’s group’s ID
handle string, null – The field’s handle
id integer, string, null – The component’s ID (could be a temporary one: "new:X")
instructions string, null – The field’s instructions
isNew boolean – Whether the component is new
isTranslatable boolean
iterator ArrayIterator – An iterator for traversing the items in the list.
layoutId integer, null – The ID of the field layout that the field was fetched from
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.
settings array – The component’s settings.
settingsHtml string, null
sortOption array
sortOrder integer, null – The field’s sort position in the field layout it was fetched from
tabId integer, null – The tab ID of the field layout that the field was fetched from
translationDescription string, null
translationKeyFormat string, null – The field’s translation key format, if translationMethod is "custom"
translationMethod string – The field’s translation method
uid string, null – The field's UID
validators ArrayObject, yii\validators\Validator – All the validators declared in the model.

# contentColumnType

Type
string
Access
Read-only

The column type. yii\db\QueryBuilder::getColumnType() 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

# contentGqlType

Type
\GraphQL\Type\Definition\Type, array
Access
Read-only
Since
3.3.0

View source

# eagerLoadingGqlConditions

Type
array, false
Access
Read-only
Since
3.3.0

View source

# elementValidationRules

Type
array
Access
Read-only

View source

# group

Type
craft\records\FieldGroup, null
Access
Read-only

View source

# isTranslatable

Type
boolean
Access
Read-only

View source

# sortOption

Type
array
Access
Read-only
Since
3.2.0

View source

# translationDescription

Type
string, null
Access
Read-only
Since
3.4.0

View source

# Public Methods

Method Description
__call() Calls the named method which is not a class method.
__clone()
__construct() Constructor.
__get() Returns the value of an object property.
__isset() Checks if a property is set, i.e. defined and not null.
__set() Sets value of an object property.
__toString() Use the translated field name as the string representation.
__unset() Sets an object property to 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.
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() 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.
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.
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.
createValidators() Creates validator objects based on the validation rules specified in rules().
datetimeAttributes() Returns the names of any attributes that should hold DateTime values.
detachBehavior() Detaches a behavior from the component.
detachBehaviors() Detaches all behaviors from the component.
displayName() Returns the display name of this class.
ensureBehaviors() Makes sure that the behaviors declared in behaviors() are attached to this component.
extraFields() Returns the list of fields that can be expanded further and returned by toArray().
fields() Returns the list of fields that should be returned by default by toArray() when no specific fields are specified.
formName() Returns the form name that this model class should use.
generateAttributeLabel() Generates a user friendly attribute label based on the give attribute name.
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.
getContentColumnType() Returns the column type that this field should get within the content table.
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.
getElementValidationRules() Returns the validation rules for an element with this field.
getError() Returns the first error of the specified attribute.
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.
getGroup() Returns the field’s group.
getInputHtml() Returns the field’s input HTML.
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.
getScenario() Returns the scenario that this model is used in.
getSearchKeywords() Returns the search keywords that should be associated with this field.
getSettings() Returns an array of the component’s settings.
getSettingsHtml() Returns the component’s settings HTML.
getSortOption() Returns the sort option array that should be included in the element’s sortOptions() response.
getStaticHtml() Returns a static (non-editable) version of the field’s input HTML.
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() Returns all the validators declared in rules().
hasContentColumn() Returns whether this field has a column in the content table.
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.
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.
isEmpty()
isSelectable() Returns whether the component should be selectable in component Type selects.
isValueEmpty() Returns whether the given value should be considered “empty” to a validator.
load() Populates the model with input data.
loadMultiple() Populates a set of models with the data from end user.
modifyElementIndexQuery() Modifies an element index query.
modifyElementsQuery() Modifies an element query.
normalizeValue() Normalizes the field’s 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.
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 or JSON-encoded in an entry revision table.
setAttributes() Sets the attribute values in a massive way.
setIsFresh() Sets whether the field is fresh.
setScenario() Sets the scenario for the model.
settingsAttributes() Returns the list of settings attribute names.
supportedTranslationMethods() Returns which translation methods the field supports.
toArray() Converts the model into an array.
trigger() Triggers an event.
validate() Validates the component.
validateMultiple() 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

Returns

string

# afterElementDelete()

Performs actions after the element has been deleted.

View source

Arguments

# afterElementPropagate()

Since
3.2.0

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

View source

Arguments

# afterElementRestore()

Since
3.1.0

Performs actions after the element has been restored.

View source

Arguments

# afterElementSave()

Performs actions after the element has been saved.

View source

Arguments

# beforeElementDelete()

Performs actions before an element is deleted.

View source

Arguments

Returns

boolean – Whether the element should be deleted

# beforeElementRestore()

Since
3.1.0

Performs actions before an element is restored.

View source

Arguments

Returns

boolean – Whether the element should be restored

# beforeElementSave()

Performs actions before an element is saved.

View source

Arguments

Returns

boolean – Whether the element should be saved

# beforeSave()

Performs actions before a component is saved.

View source

Arguments

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

Returns

boolean – Whether the component should be saved

# getContentColumnType()

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

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

View source

Returns

string – The column type. yii\db\QueryBuilder::getColumnType() 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.

# getContentGqlType()

Since
3.3.0

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

View source

Returns

\GraphQL\Type\Definition\Type, array

# 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

Returns

array, false

# 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

# getGroup()

Returns the field’s group.

View source

Returns

craft\records\FieldGroup, null

# 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\web\View 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)
{
    // Come up with an ID value based on $name
    $id = Craft::$app->view->formatInputId($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

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.

# 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 entry is actually getting saved. That is determined by getTranslationKey().

View source

Arguments

Returns

boolean

# 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

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.

# 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

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 entry drafts.

View source

Arguments

Returns

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

# getTableAttributeHtml()

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

View source

Arguments

Returns

string – 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

Arguments

Returns

string, null

# 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

Arguments

Returns

string – 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

Returns

boolean

# 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

# isEmpty()

DEPRECATED

Deprecated in 3.0.0-RC15. Use isValueEmpty() instead.

View source

Arguments

  • $value (mixed)

Returns

boolean

# 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”

# 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

# 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

Arguments

Returns

null, falsefalse in the event that the method is sure that no elements are going to be found.

# 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 entry.myFieldHandle is called from a template, or right before getInputHtml() is called. Whatever this method returns is what entry.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.)

View source

Arguments

Returns

mixed – The prepared field value

# serializeValue()

Prepares the field’s value to be stored somewhere, like the content table or JSON-encoded in an entry revision 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

Returns

mixed – The serialized field value

# setIsFresh()

Sets whether the field is fresh.

View source

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

Returns

string[]

# 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 phpDocType()
{
     return 'int|mixed|\\craft\\elements\\db\\ElementQuery';
}

View source

Returns

string

# Protected Methods

Method Description
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.
isFresh() Returns whether this is the first time the element's content has been edited.
requestParamName() Returns the field’s param name on the request.
resolveFields() Determines which fields can be returned by toArray().

# defineRules()

Since
3.4.0

Returns the validation rules for attributes.

See rules() for details about what should be returned.

Models should override this method instead of rules() so EVENT_DEFINE_RULES handlers can modify the class-defined rules.

View source

Returns

array

# isFresh()

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

View source

Arguments

Returns

boolean

# requestParamName()

Returns the field’s param name on the request.

View source

Arguments

Returns

string, null – The field’s param name on the request

# 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 craft\events\FieldElementEvent::$isValid 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 craft\events\FieldElementEvent::$isValid 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 craft\events\FieldElementEvent::$isValid to false to prevent the element from getting saved.