Skip to content

FieldTrait

Type
Trait
Namespace
craft\base
Implemented by
craft\base\Field, 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

FieldTrait implements the common methods and properties for field classes.

View source

Public Properties

PropertyDescription
columnPrefixstring, null – The field’s content column prefix
columnSuffixstring, null – The field’s content column suffix
contextstring, null – The field’s context
describedBystring, null – The aria-describedby attribute value that should be set on the focusable input(s).
groupIdinteger, null – The field’s group’s ID
handlestring, null – The field’s handle
instructionsstring, null – The field’s instructions
layoutIdinteger, null – The ID of the field layout that the field was fetched from
namestring, null – The field’s name
oldHandlestring, null – The field’s previous handle
oldSettingsarray, null – The field’s previous settings
requiredboolean, null – Whether the field is required in the field layout it was fetched from
searchableboolean – Whether the field's values should be registered as search keywords on the elements.
sortOrderinteger, null – The field’s sort position in the field layout it was fetched from
tabIdinteger, null – The tab ID of the field layout that the field was fetched from
translationKeyFormatstring, null – The field’s translation key format, if translationMethod is "custom"
translationMethodstring – The field’s translation method
uidstring, null – The field's UID

columnPrefix

Type
string, null
Default value
null

The field’s content column prefix

View source

columnSuffix

Type
string, null
Default value
null
Since
3.7.0

The field’s content column suffix

View source

context

Type
string, null
Default value
null

The field’s context

View source

describedBy

Type
string, null
Default value
null
Since
3.7.24

The aria-describedby attribute value that should be set on the focusable input(s).

See also craft\base\FieldInterface::getInputHtml()

View source

groupId

Type
integer, null
Default value
null

The field’s group’s ID

View source

handle

Type
string, null
Default value
null

The field’s handle

View source

instructions

Type
string, null
Default value
null

The field’s instructions

View source

layoutId

Type
integer, null
Default value
null

The ID of the field layout that the field was fetched from

View source

name

Type
string, null
Default value
null

The field’s name

View source

oldHandle

Type
string, null
Default value
null

The field’s previous handle

View source

oldSettings

Type
array, null
Default value
null
Since
3.1.2

The field’s previous settings

View source

required

DEPRECATED

Deprecated in 4.1.4. craft\fieldlayoutelements\BaseField::$required should be used instead

Type
boolean, null
Default value
null

Whether the field is required in the field layout it was fetched from

View source

searchable

Type
boolean
Default value
false

Whether the field's values should be registered as search keywords on the elements.

View source

sortOrder

Type
integer, null
Default value
null

The field’s sort position in the field layout it was fetched from

View source

tabId

Type
integer, null
Default value
null

The tab ID of the field layout that the field was fetched from

View source

translationKeyFormat

Type
string, null
Default value
null

The field’s translation key format, if translationMethod is "custom"

View source

translationMethod

Type
string
Default value
\craft\base\Field::TRANSLATION_METHOD_NONE

The field’s translation method

View source

uid

Type
string, null
Default value
null

The field's UID

View source