Define Field API widget types.
Field API widgets specify how fields are displayed in edit forms. Fields of a given field type may be edited using more than one widget. In this case, the Field UI module allows the site builder to choose which widget to use.
Widgets are Plugins managed by the \Drupal\Core\Field\WidgetPluginManager class. A widget is a plugin annotated with class \Drupal\Core\Field\Annotation\FieldWidget that implements \Drupal\Core\Field\WidgetInterface (in most cases, by subclassing \Drupal\Core\Field\WidgetBase). Widget plugins need to be in the namespace \Drupal\{your_module}\Plugin\Field\FieldWidget.
Widgets are Form API elements with additional processing capabilities. The methods of the WidgetInterface object are typically called by respective methods in the \Drupal\Core\Entity\Entity\EntityFormDisplay class.
See also
Plugin API
Parent topics
- Hooks
- Define functions that alter the behavior of Drupal core.
File
- core/modules/field/field.api.php, line 97
- Field API documentation.
Functions
Name | Location | Description |
---|---|---|
hook_field_widget_form_alter | core/modules/field/field.api.php | Alter forms for field widgets provided by other modules. |
hook_field_widget_info_alter | core/modules/field/field.api.php | Perform alterations on Field API widget types. |
hook_field_widget_WIDGET_TYPE_form_alter | core/modules/field/field.api.php | Alter widget forms for a specific widget provided by another module. |
Classes
Name | Location | Description |
---|---|---|
FieldWidget | core/lib/Drupal/Core/Field/Annotation/FieldWidget.php | Defines a FieldWidget annotation object. |
WidgetBase | core/lib/Drupal/Core/Field/WidgetBase.php | Base class for 'Field widget' plugin implementations. |
WidgetPluginManager | core/lib/Drupal/Core/Field/WidgetPluginManager.php | Plugin type manager for field widgets. |
Interfaces
Name | Location | Description |
---|---|---|
WidgetInterface | core/lib/Drupal/Core/Field/WidgetInterface.php | Interface definition for field widget plugins. |
Please login to continue.