class FieldWidget in Drupal 10

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.

35 classes are annotated with FieldWidget

BooleanCheckboxWidget in core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/BooleanCheckboxWidget.php

Plugin implementation of the 'boolean_checkbox' widget.

CommentWidget in core/modules/comment/src/Plugin/Field/FieldWidget/CommentWidget.php

Provides a default comment widget.

DateRangeDatelistWidget in core/modules/datetime_range/src/Plugin/Field/FieldWidget/DateRangeDatelistWidget.php

Plugin implementation of the 'daterange_datelist' widget.

DateRangeDefaultWidget in core/modules/datetime_range/src/Plugin/Field/FieldWidget/DateRangeDefaultWidget.php

Plugin implementation of the 'daterange_default' widget.

DateTimeDatelistWidget in core/modules/datetime/src/Plugin/Field/FieldWidget/DateTimeDatelistWidget.php

Plugin implementation of the 'datetime_datelist' widget.

... See full list

File

core/lib/Drupal/Core/Field/Annotation/FieldWidget.php, line 22

Namespace

Drupal\Core\Field\Annotation

class FieldWidget extends Plugin {

  /**
   * The plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * The human-readable name of the widget type.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation
   */
  public $label;

  /**
   * A short description of the widget type.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation
   */
  public $description;

  /**
   * The name of the widget class.
   *
   * This is not provided manually, it will be added by the discovery mechanism.
   *
   * @var string
   */
  public $class;

  /**
   * An array of field types the widget supports.
   *
   * @var array
   */
  public $field_types = [];

  /**
   * Does the field widget handles multiple values at once.
   *
   * @var bool
   */
  public $multiple_values = FALSE;

  /**
   * 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.
   *
   * This property is optional and it does not need to be declared.
   *
   * @var int
   */
  public $weight = NULL;

}

Members

Name	Modifiers	Type	Description	Overrides
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.	1
Plugin::get	public	function	Gets the value of an annotation. Overrides AnnotationInterface::get	6
Plugin::getClass	public	function	Gets the class of the annotated class. Overrides AnnotationInterface::getClass	1
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	1
Plugin::parse	protected	function	Parses an annotation into its definition.
Plugin::setClass	public	function	Sets the class of the annotated class. Overrides AnnotationInterface::setClass	1
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.	3