class FieldType
Same name in this branch
- main core/modules/field/src/Plugin/migrate/process/FieldType.php \Drupal\field\Plugin\migrate\process\FieldType
- main core/lib/Drupal/Core/Field/Annotation/FieldType.php \Drupal\Core\Field\Annotation\FieldType
Same name and namespace in other branches
- 11.x core/modules/field/src/Plugin/migrate/process/FieldType.php \Drupal\field\Plugin\migrate\process\FieldType
- 11.x core/lib/Drupal/Core/Field/Attribute/FieldType.php \Drupal\Core\Field\Attribute\FieldType
- 11.x core/lib/Drupal/Core/Field/Annotation/FieldType.php \Drupal\Core\Field\Annotation\FieldType
- 10 core/modules/field/src/Plugin/migrate/process/FieldType.php \Drupal\field\Plugin\migrate\process\FieldType
- 10 core/lib/Drupal/Core/Field/Attribute/FieldType.php \Drupal\Core\Field\Attribute\FieldType
- 10 core/lib/Drupal/Core/Field/Annotation/FieldType.php \Drupal\Core\Field\Annotation\FieldType
- 9 core/modules/field/src/Plugin/migrate/process/FieldType.php \Drupal\field\Plugin\migrate\process\FieldType
- 9 core/lib/Drupal/Core/Field/Annotation/FieldType.php \Drupal\Core\Field\Annotation\FieldType
- 8.9.x core/modules/field/src/Plugin/migrate/process/FieldType.php \Drupal\field\Plugin\migrate\process\FieldType
- 8.9.x core/lib/Drupal/Core/Field/Annotation/FieldType.php \Drupal\Core\Field\Annotation\FieldType
Defines a FieldType attribute.
Additional attribute keys for field types can be defined in hook_field_info_alter().
Attributes
#[\Attribute(\Attribute::TARGET_CLASS)]
Hierarchy
- class \Drupal\Component\Plugin\Attribute\AttributeBase implements \Drupal\Component\Plugin\Attribute\AttributeInterface
- class \Drupal\Component\Plugin\Attribute\Plugin extends \Drupal\Component\Plugin\Attribute\AttributeBase
- class \Drupal\Core\Field\Attribute\FieldType extends \Drupal\Component\Plugin\Attribute\Plugin
- class \Drupal\Component\Plugin\Attribute\Plugin extends \Drupal\Component\Plugin\Attribute\AttributeBase
Expanded class hierarchy of FieldType
Related topics
57 files declare their use of FieldType
- AutoIncrementingTestItem.php in core/
modules/ system/ tests/ modules/ entity_test/ src/ Plugin/ Field/ FieldType/ AutoIncrementingTestItem.php - BooleanItem.php in core/
lib/ Drupal/ Core/ Field/ Plugin/ Field/ FieldType/ BooleanItem.php - ChangedItem.php in core/
lib/ Drupal/ Core/ Field/ Plugin/ Field/ FieldType/ ChangedItem.php - ChangedTestItem.php in core/
modules/ system/ tests/ modules/ entity_test/ src/ Plugin/ Field/ FieldType/ ChangedTestItem.php - CommentItem.php in core/
modules/ comment/ src/ Plugin/ Field/ FieldType/ CommentItem.php
File
-
core/
lib/ Drupal/ Core/ Field/ Attribute/ FieldType.php, line 18
Namespace
Drupal\Core\Field\AttributeView source
class FieldType extends Plugin {
/**
* Constructs a FieldType attribute.
*
* @param string $id
* The plugin ID.
* @param \Drupal\Core\StringTranslation\TranslatableMarkup $label
* The human-readable name of the field type.
* @param \Drupal\Core\StringTranslation\TranslatableMarkup|array|null $description
* (optional) A short human-readable description for the field type.
* @param string $category
* (optional) The category under which the field type should be listed in
* the UI.
* @param int $weight
* (optional) The weight of the field type.
* @param string|null $default_widget
* (optional) The plugin ID of the default widget for this field type.
* This widget must be available whenever the field type is available (i.e.
* provided by the field type module, or by a module the field type module
* depends on).
* @param string|null $default_formatter
* (optional) The plugin ID of the default formatter for this field type.
* This formatter must be available whenever the field type is available
* (i.e. provided by the field type module, or by a module the field type
* module depends on).
* @param bool $no_ui
* (optional) A boolean stating that fields of this type cannot be created
* through the UI.
* @param string|null $list_class
* (optional) The typed data class used for wrapping multiple data items of
* the type. Must implement the \Drupal\Core\TypedData\ListInterface.
* @param int|null $cardinality
* (optional) An integer defining a fixed cardinality for this field type.
* If this value is not set, cardinality can be configured in the field UI.
* @param array $constraints
* (optional) An array of validation constraints for this type.
* @param array $config_dependencies
* (optional) An array of configuration dependencies.
* @param array $column_groups
* (optional) An array of column groups for the field type.
* @param array $serialized_property_names
* (optional) An array of property names that should be serialized.
* @param string|null $deriver
* (optional) The deriver class for the data type.
* @param string|null $module
* The name of the module providing the field type plugin.
*/
public function __construct(public readonly string $id, public readonly TranslatableMarkup $label, public readonly TranslatableMarkup|array|null $description = NULL, public readonly string $category = '', public readonly int $weight = 0, public readonly ?string $default_widget = NULL, public readonly ?string $default_formatter = NULL, public readonly bool $no_ui = FALSE, public readonly ?string $list_class = NULL, public readonly ?int $cardinality = NULL, public readonly array $constraints = [], public readonly array $config_dependencies = [], public readonly array $column_groups = [], public readonly array $serialized_property_names = [], public readonly ?string $deriver = NULL, public readonly ?string $module = NULL) {
}
}
Members
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.