FieldTrait ​
- Type
- Trait
- Namespace
- craft\base
- Implemented by
- craft\base\Field, 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
FieldTrait implements the common methods and properties for field classes.
Public Properties ​
Property | Description |
---|---|
columnSuffix | string, null – The field’s content column suffix |
context | string, null – The field’s context |
dateDeleted | DateTime, null – The date that the field was trashed |
describedBy | string, null – The aria-describedby attribute value that should be set on the focusable input(s). |
handle | string, null – The field’s handle |
instructions | string, null – The field’s instructions |
layoutElement | craft\fieldlayoutelements\CustomField, null – The field layout element |
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 |
searchable | boolean – Whether the field's values should be registered as search keywords on the elements. |
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 |
columnSuffix
​
DEPRECATED
Deprecated in 5.0.0
The field’s content column suffix
context
​
The field’s context
dateDeleted
​
The date that the field was trashed
describedBy
​
The aria-describedby
attribute value that should be set on the focusable input(s).
See also craft\base\FieldInterface::getInputHtml()
handle
​
The field’s handle
instructions
​
The field’s instructions
layoutElement
​
- Type
- craft\fieldlayoutelements\CustomField, null
- Default value
null
- Since
- 5.0.0
The field layout element
name
​
The field’s name
oldHandle
​
The field’s previous handle
oldSettings
​
The field’s previous settings
required
​
DEPRECATED
Deprecated in 4.1.4. craft\fieldlayoutelements\BaseField::$required should be used instead
Whether the field is required in the field layout it was fetched from
searchable
​
- Type
- boolean
- Default value
false
Whether the field's values should be registered as search keywords on the elements.
translationKeyFormat
​
The field’s translation key format, if translationMethod is "custom"
translationMethod
​
- Type
- string
- Default value
\craft\base\Field::TRANSLATION_METHOD_NONE
The field’s translation method
uid
​
The field's UID