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
$required	boolean, null – Whether the field is required in the field layout it was fetched from
$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

`$columnPrefix`

Type: string, null

The field’s content column prefix

View source

Signature

public string, null $columnPrefix = null

`$context`

Type: string, null

The field’s context

View source

Signature

public string, null $context = null

`$groupId`

Type: integer, null

The field’s group’s ID

View source

Signature

public integer, null $groupId = null

`$handle`

Type: string, null

The field’s handle

View source

Signature

public string, null $handle = null

`$instructions`

Type: string, null

The field’s instructions

View source

Signature

public string, null $instructions = null

`$layoutId`

Type: integer, null

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

View source

Signature

public integer, null $layoutId = null

`$name`

Type: string, null

The field’s name

View source

Signature

public string, null $name = null

`$oldHandle`

Type: string, null

The field’s previous handle

View source

Signature

public string, null $oldHandle = null

`$required`

Type: boolean, null

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

View source

Signature

public boolean, null $required = null

`$sortOrder`

Type: integer, null

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

View source

Signature

public integer, null $sortOrder = null

`$tabId`

Type: integer, null

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

View source

Signature

public integer, null $tabId = null

`$translationKeyFormat`

Type: string, null

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

View source

Signature

public string, null $translationKeyFormat = null

`$translationMethod`

Type: string

The field’s translation method

View source

Signature

public string $translationMethod = \craft\base\Field::TRANSLATION_METHOD_NONE

FieldTrait

# Public Properties

#$columnPrefix

Signature

#$context

Signature

#$groupId

Signature

#$handle

Signature

#$instructions

Signature

#$layoutId

Signature

#$name

Signature

#$oldHandle

Signature

#$required

Signature

#$sortOrder

Signature

#$tabId

Signature

#$translationKeyFormat

Signature

#$translationMethod

Signature

Public Properties

`$columnPrefix`

`$context`

`$groupId`

`$handle`

`$instructions`

`$layoutId`

`$name`

`$oldHandle`

`$required`

`$sortOrder`

`$tabId`

`$translationKeyFormat`

`$translationMethod`