FieldTrait
- Type
- Trait
- Namespace
- craft\base
- Implemented by
- craft\base\Field, craft\fields\BaseOptionsField, craft\fields\Checkboxes, craft\fields\Color, craft\fields\Date, craft\fields\Dropdown, craft\fields\Email, 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\Url
- Since
- 3.0
FieldTrait implements the common methods and properties for field classes.
Public Properties
| Property | Description |
|---|---|
| $columnPrefix | string, null – The field’s content column prefix |
| $context | string, null – The field’s context |
| $groupId | integer, null – The field’s group’s ID |
| $handle | string, null – The field’s handle |
| $instructions | string, null – The field’s instructions |
| $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 |
| $searchable | boolean – Whether the field's values should be registered as search keywords on the elements. |
| $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 |
| $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 |
$columnPrefix
Signature
public string, null $columnPrefix = null
$context
Signature
public string, null $context = null
$groupId
Signature
public integer, null $groupId = null
$handle
Signature
public string, null $handle = null
$instructions
Signature
public string, null $instructions = null
$layoutId
Signature
public integer, null $layoutId = null
$name
Signature
public string, null $name = null
$oldHandle
Signature
public string, null $oldHandle = null
$oldSettings
Signature
public array, null $oldSettings = null
$required
Signature
public boolean, null $required = null
$searchable
- Type
- boolean
Whether the field's values should be registered as search keywords on the elements.
Signature
public boolean $searchable = true
$sortOrder
Signature
public integer, null $sortOrder = null
$tabId
Signature
public integer, null $tabId = null
$translationKeyFormat
Signature
public string, null $translationKeyFormat = null
$translationMethod
Signature
public string $translationMethod = \craft\base\Field::TRANSLATION_METHOD_NONE
$uid
Signature
public string, null $uid = null