Defines a FieldWidget annotation object.
Widgets handle how fields are displayed in edit forms.
Additional annotation keys for widgets can be defined in hook_field_widget_info_alter().
Hierarchy
- class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
- class \Drupal\Core\Field\Annotation\FieldWidget
See also
\Drupal\Core\Field\WidgetPluginManager
\Drupal\Core\Field\WidgetInterface
Related topics
- Annotations
- Annotations for class discovery and metadata description.
- Field Widget API
- Define Field API widget types.
File
- core/lib/Drupal/Core/Field/Annotation/FieldWidget.php, line 22
Namespace
Drupal\Core\Field\Annotation
Members
| Name | Modifiers | Type | Description |
|---|---|---|---|
| FieldWidget::$class | public | property | The name of the widget class. |
| FieldWidget::$description | public | property | A short description of the widget type. |
| FieldWidget::$field_types | public | property | An array of field types the widget supports. |
| FieldWidget::$id | public | property | The plugin ID. |
| FieldWidget::$label | public | property | The human-readable name of the widget type. |
| FieldWidget::$multiple_values | public | property | Does the field widget handles multiple values at once. |
| FieldWidget::$weight | public | property | An integer to determine the weight of this widget relative to other widgets in the Field UI when selecting a widget for a given field. |
| Plugin::$definition | protected | property | The plugin definition read from the class annotation. |
| Plugin::get | public | function | Gets the value of an annotation. Overrides AnnotationInterface::get |
| Plugin::getClass | public | function | Gets the class of the annotated class. Overrides AnnotationInterface::getClass |
| Plugin::getId | public | function | Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId |
| Plugin::getProvider | public | function | Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider |
| Plugin::parse | protected | function | Parses an annotation into its definition. |
| Plugin::setClass | public | function | Sets the class of the annotated class. Overrides AnnotationInterface::setClass |
| Plugin::setProvider | public | function | Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider |
| Plugin::__construct | public | function | Constructs a Plugin object. |
Please login to continue.