Issue #3420978 by mstrelan, smustgrave: Convert FieldWidget plugin discovery to attributes

(cherry picked from commit d0e96114)

core/lib/Drupal/Core/Datetime/Plugin/Field/FieldWidget/TimestampDatetimeWidget.php

@@ -3,22 +3,23 @@
 namespace Drupal\Core\Datetime\Plugin\Field\FieldWidget;
 
 use Drupal\Core\Datetime\DrupalDateTime;
+use Drupal\Core\Field\Attribute\FieldWidget;
 use Drupal\Core\Field\FieldItemListInterface;
 use Drupal\Core\Field\WidgetBase;
 use Drupal\Core\Form\FormStateInterface;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
 
 /**
  * Plugin implementation of the 'datetime timestamp' widget.
- *
- * @FieldWidget(
- *   id = "datetime_timestamp",
- *   label = @Translation("Datetime Timestamp"),
- *   field_types = {
- *     "timestamp",
- *     "created",
- *   }
- * )
  */
+#[FieldWidget(
+  id: 'datetime_timestamp',
+  label: new TranslatableMarkup('Datetime Timestamp'),
+  field_types: [
+    'timestamp',
+    'created',
+  ],
+)]
 class TimestampDatetimeWidget extends WidgetBase {
 
   /**

core/lib/Drupal/Core/Field/Attribute/FieldWidget.php

+<?php
+
+namespace Drupal\Core\Field\Attribute;
+
+use Drupal\Component\Plugin\Attribute\Plugin;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
+
+/**
+ * Defines a FieldWidget attribute for plugin discovery.
+ *
+ * Plugin Namespace: Plugin\Field\FieldWidget
+ *
+ * Widgets handle how fields are displayed in edit forms.
+ *
+ * Additional attribute keys for widgets can be defined in
+ * hook_field_widget_info_alter().
+ *
+ * @see \Drupal\Core\Field\WidgetPluginManager
+ * @see \Drupal\Core\Field\WidgetInterface
+ *
+ * @ingroup field_widget
+ */
+#[\Attribute(\Attribute::TARGET_CLASS)]
+class FieldWidget extends Plugin {
+
+  /**
+   * Constructs a FieldWidget attribute.
+   *
+   * @param string $id
+   *   The plugin ID.
+   * @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $label
+   *   (optional) The human-readable name of the widget type.
+   * @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $description
+   *   (optional) A short description of the widget type.
+   * @param string[] $field_types
+   *   (optional) An array of field types the widget supports.
+   * @param bool $multiple_values
+   *   (optional) Does the field widget handles multiple values at once.
+   * @param int|null $weight
+   *   (optional) An integer to determine weight of this widget relative to
+   *   other widgets. Other widgets are in the Field UI when selecting a widget
+   *   for a given field.
+   * @param class-string|null $deriver
+   *   (optional) The deriver class.
+   */
+  public function __construct(
+    public readonly string $id,
+    public readonly ?TranslatableMarkup $label = NULL,
+    public readonly ?TranslatableMarkup $description = NULL,
+    public readonly array $field_types = [],
+    public readonly bool $multiple_values = FALSE,
+    public readonly ?int $weight = NULL,
+    public readonly ?string $deriver = NULL,
+  ) {}
+
+}

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

@@ -2,22 +2,21 @@
 
 namespace Drupal\Core\Field\Plugin\Field\FieldWidget;
 
+use Drupal\Core\Field\Attribute\FieldWidget;
 use Drupal\Core\Field\FieldItemListInterface;
 use Drupal\Core\Field\WidgetBase;
 use Drupal\Core\Form\FormStateInterface;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
 
 /**
  * Plugin implementation of the 'boolean_checkbox' widget.
- *
- * @FieldWidget(
- *   id = "boolean_checkbox",
- *   label = @Translation("Single on/off checkbox"),
- *   field_types = {
- *     "boolean"
- *   },
- *   multiple_values = TRUE
- * )
  */
+#[FieldWidget(
+  id: 'boolean_checkbox',
+  label: new TranslatableMarkup('Single on/off checkbox'),
+  field_types: ['boolean'],
+  multiple_values: TRUE,
+)]
 class BooleanCheckboxWidget extends WidgetBase {
 
   /**

core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/EmailDefaultWidget.php

@@ -2,22 +2,21 @@
 
 namespace Drupal\Core\Field\Plugin\Field\FieldWidget;
 
+use Drupal\Core\Field\Attribute\FieldWidget;
 use Drupal\Core\Field\FieldItemListInterface;
 use Drupal\Core\Field\WidgetBase;
 use Drupal\Core\Form\FormStateInterface;
 use Drupal\Core\Render\Element\Email;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
 
 /**
  * Plugin implementation of the 'email_default' widget.
- *
- * @FieldWidget(
- *   id = "email_default",
- *   label = @Translation("Email"),
- *   field_types = {
- *     "email"
- *   }
- * )
  */
+#[FieldWidget(
+  id: 'email_default',
+  label: new TranslatableMarkup('Email'),
+  field_types: ['email'],
+)]
 class EmailDefaultWidget extends WidgetBase {
 
   /**

core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/EntityReferenceAutocompleteTagsWidget.php

@@ -2,22 +2,21 @@
 
 namespace Drupal\Core\Field\Plugin\Field\FieldWidget;
 
+use Drupal\Core\Field\Attribute\FieldWidget;
 use Drupal\Core\Field\FieldItemListInterface;
 use Drupal\Core\Form\FormStateInterface;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
 
 /**
  * Plugin implementation of the 'entity_reference_autocomplete_tags' widget.
- *
- * @FieldWidget(
- *   id = "entity_reference_autocomplete_tags",
- *   label = @Translation("Autocomplete (Tags style)"),
- *   description = @Translation("An autocomplete text field with tagging support."),
- *   field_types = {
- *     "entity_reference"
- *   },
- *   multiple_values = TRUE
- * )
  */
+#[FieldWidget(
+  id: 'entity_reference_autocomplete_tags',
+  label: new TranslatableMarkup('Autocomplete (Tags style)'),
+  description: new TranslatableMarkup('An autocomplete text field with tagging support.'),
+  field_types: ['entity_reference'],
+  multiple_values: TRUE,
+)]
 class EntityReferenceAutocompleteTagsWidget extends EntityReferenceAutocompleteWidget {
 
   /**

core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/EntityReferenceAutocompleteWidget.php

@@ -2,24 +2,23 @@
 
 namespace Drupal\Core\Field\Plugin\Field\FieldWidget;
 
+use Drupal\Core\Field\Attribute\FieldWidget;
 use Drupal\Core\Field\FieldItemListInterface;
 use Drupal\Core\Field\WidgetBase;
 use Drupal\Core\Form\FormStateInterface;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
 use Drupal\user\EntityOwnerInterface;
 use Symfony\Component\Validator\ConstraintViolationInterface;
 
 /**
  * Plugin implementation of the 'entity_reference_autocomplete' widget.
- *
- * @FieldWidget(
- *   id = "entity_reference_autocomplete",
- *   label = @Translation("Autocomplete"),
- *   description = @Translation("An autocomplete text field."),
- *   field_types = {
- *     "entity_reference"
- *   }
- * )
  */
+#[FieldWidget(
+  id: 'entity_reference_autocomplete',
+  label: new TranslatableMarkup('Autocomplete'),
+  description: new TranslatableMarkup('An autocomplete text field.'),
+  field_types: ['entity_reference'],
+)]
 class EntityReferenceAutocompleteWidget extends WidgetBase {
 
   /**

core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/LanguageSelectWidget.php

@@ -2,22 +2,21 @@
 
 namespace Drupal\Core\Field\Plugin\Field\FieldWidget;
 
+use Drupal\Core\Field\Attribute\FieldWidget;
 use Drupal\Core\Field\FieldItemListInterface;
 use Drupal\Core\Field\WidgetBase;
 use Drupal\Core\Form\FormStateInterface;
 use Drupal\Core\Language\LanguageInterface;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
 
 /**
  * Plugin implementation of the 'Language' widget.
- *
- * @FieldWidget(
- *   id = "language_select",
- *   label = @Translation("Language select"),
- *   field_types = {
- *     "language"
- *   }
- * )
  */
+#[FieldWidget(
+  id: 'language_select',
+  label: new TranslatableMarkup('Language select'),
+  field_types: ['language'],
+)]
 class LanguageSelectWidget extends WidgetBase {
 
   /**

core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/NumberWidget.php

@@ -2,25 +2,26 @@
 
 namespace Drupal\Core\Field\Plugin\Field\FieldWidget;
 
+use Drupal\Core\Field\Attribute\FieldWidget;
 use Drupal\Core\Field\FieldFilteredMarkup;
 use Drupal\Core\Field\FieldItemListInterface;
 use Drupal\Core\Field\WidgetBase;
 use Drupal\Core\Form\FormStateInterface;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
 use Symfony\Component\Validator\ConstraintViolationInterface;
 
 /**
  * Plugin implementation of the 'number' widget.
- *
- * @FieldWidget(
- *   id = "number",
- *   label = @Translation("Number field"),
- *   field_types = {
- *     "integer",
- *     "decimal",
- *     "float"
- *   }
- * )
  */
+#[FieldWidget(
+  id: 'number',
+  label: new TranslatableMarkup('Number field'),
+  field_types: [
+    'integer',
+    'decimal',
+    'float',
+  ],
+)]
 class NumberWidget extends WidgetBase {
 
   /**

core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/OptionsButtonsWidget.php

@@ -2,25 +2,26 @@
 
 namespace Drupal\Core\Field\Plugin\Field\FieldWidget;
 
+use Drupal\Core\Field\Attribute\FieldWidget;
 use Drupal\Core\Field\FieldItemListInterface;
 use Drupal\Core\Form\FormStateInterface;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
 
 /**
  * Plugin implementation of the 'options_buttons' widget.
- *
- * @FieldWidget(
- *   id = "options_buttons",
- *   label = @Translation("Check boxes/radio buttons"),
- *   field_types = {
- *     "boolean",
- *     "entity_reference",
- *     "list_integer",
- *     "list_float",
- *     "list_string",
- *   },
- *   multiple_values = TRUE
- * )
  */
+#[FieldWidget(
+  id: 'options_buttons',
+  label: new TranslatableMarkup('Check boxes/radio buttons'),
+  field_types: [
+    'boolean',
+    'entity_reference',
+    'list_integer',
+    'list_float',
+    'list_string',
+  ],
+  multiple_values: TRUE,
+)]
 class OptionsButtonsWidget extends OptionsWidgetBase {
 
   /**

core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/OptionsSelectWidget.php

@@ -3,24 +3,25 @@
 namespace Drupal\Core\Field\Plugin\Field\FieldWidget;
 
 use Drupal\Component\Utility\Html;
+use Drupal\Core\Field\Attribute\FieldWidget;
 use Drupal\Core\Field\FieldItemListInterface;
 use Drupal\Core\Form\FormStateInterface;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
 
 /**
  * Plugin implementation of the 'options_select' widget.
- *
- * @FieldWidget(
- *   id = "options_select",
- *   label = @Translation("Select list"),
- *   field_types = {
- *     "entity_reference",
- *     "list_integer",
- *     "list_float",
- *     "list_string"
- *   },
- *   multiple_values = TRUE
- * )
  */
+#[FieldWidget(
+  id: 'options_select',
+  label: new TranslatableMarkup('Select list'),
+  field_types: [
+    'entity_reference',
+    'list_integer',
+    'list_float',
+    'list_string',
+  ],
+  multiple_values: TRUE,
+)]
 class OptionsSelectWidget extends OptionsWidgetBase {
 
   /**

core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/StringTextareaWidget.php

@@ -2,21 +2,20 @@
 
 namespace Drupal\Core\Field\Plugin\Field\FieldWidget;
 
+use Drupal\Core\Field\Attribute\FieldWidget;
 use Drupal\Core\Field\FieldItemListInterface;
 use Drupal\Core\Field\WidgetBase;
 use Drupal\Core\Form\FormStateInterface;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
 
 /**
  * Plugin implementation of the 'string_textarea' widget.
- *
- * @FieldWidget(
- *   id = "string_textarea",
- *   label = @Translation("Text area (multiple rows)"),
- *   field_types = {
- *     "string_long"
- *   }
- * )
  */
+#[FieldWidget(
+  id: 'string_textarea',
+  label: new TranslatableMarkup('Text area (multiple rows)'),
+  field_types: ['string_long'],
+)]
 class StringTextareaWidget extends WidgetBase {
 
   /**

core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/StringTextfieldWidget.php

@@ -2,21 +2,20 @@
 
 namespace Drupal\Core\Field\Plugin\Field\FieldWidget;
 
+use Drupal\Core\Field\Attribute\FieldWidget;
 use Drupal\Core\Field\FieldItemListInterface;
 use Drupal\Core\Field\WidgetBase;
 use Drupal\Core\Form\FormStateInterface;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
 
 /**
  * Plugin implementation of the 'string_textfield' widget.
- *
- * @FieldWidget(
- *   id = "string_textfield",
- *   label = @Translation("Textfield"),
- *   field_types = {
- *     "string"
- *   }
- * )
  */
+#[FieldWidget(
+  id: 'string_textfield',
+  label: new TranslatableMarkup('Textfield'),
+  field_types: ['string'],
+)]
 class StringTextfieldWidget extends WidgetBase {
 
   /**

core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/UriWidget.php

@@ -2,21 +2,20 @@
 
 namespace Drupal\Core\Field\Plugin\Field\FieldWidget;
 
+use Drupal\Core\Field\Attribute\FieldWidget;
 use Drupal\Core\Field\FieldItemListInterface;
 use Drupal\Core\Field\WidgetBase;
 use Drupal\Core\Form\FormStateInterface;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
 
 /**
  * Plugin implementation of the 'uri' widget.
- *
- * @FieldWidget(
- *   id = "uri",
- *   label = @Translation("URI field"),
- *   field_types = {
- *     "uri",
- *   }
- * )
  */
+#[FieldWidget(
+  id: 'uri',
+  label: new TranslatableMarkup('URI field'),
+  field_types: ['uri'],
+)]
 class UriWidget extends WidgetBase {
 
   /**

core/lib/Drupal/Core/Field/WidgetPluginManager.php

@@ -5,6 +5,7 @@
 use Drupal\Component\Plugin\Factory\DefaultFactory;
 use Drupal\Core\Cache\CacheBackendInterface;
 use Drupal\Core\Extension\ModuleHandlerInterface;
+use Drupal\Core\Field\Attribute\FieldWidget;
 use Drupal\Core\Plugin\DefaultPluginManager;
 
 /**
@@ -42,7 +43,7 @@ class WidgetPluginManager extends DefaultPluginManager {
    *   The 'field type' plugin manager.
    */
   public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler, FieldTypePluginManagerInterface $field_type_manager) {
-    parent::__construct('Plugin/Field/FieldWidget', $namespaces, $module_handler, 'Drupal\Core\Field\WidgetInterface', 'Drupal\Core\Field\Annotation\FieldWidget');
+    parent::__construct('Plugin/Field/FieldWidget', $namespaces, $module_handler, 'Drupal\Core\Field\WidgetInterface', FieldWidget::class, 'Drupal\Core\Field\Annotation\FieldWidget');
 
     $this->setCacheBackend($cache_backend, 'field_widget_types_plugins');
     $this->alterInfo('field_widget_info');

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

@@ -4,21 +4,20 @@
 
 use Drupal\comment\Plugin\Field\FieldType\CommentItemInterface;
 use Drupal\Component\Utility\Html;
+use Drupal\Core\Field\Attribute\FieldWidget;
 use Drupal\Core\Field\FieldItemListInterface;
 use Drupal\Core\Field\WidgetBase;
 use Drupal\Core\Form\FormStateInterface;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
 
 /**
  * Provides a default comment widget.
- *
- * @FieldWidget(
- *   id = "comment_default",
- *   label = @Translation("Comment"),
- *   field_types = {
- *     "comment"
- *   }
- * )
  */
+#[FieldWidget(
+  id: 'comment_default',
+  label: new TranslatableMarkup('Comment'),
+  field_types: ['comment'],
+)]
 class CommentWidget extends WidgetBase {
 
   /**

core/modules/content_moderation/src/Plugin/Field/FieldWidget/ModerationStateWidget.php

@@ -4,6 +4,7 @@
 
 use Drupal\content_moderation\Plugin\Field\ModerationStateFieldItemList;
 use Drupal\Core\Entity\EntityTypeManagerInterface;
+use Drupal\Core\Field\Attribute\FieldWidget;
 use Drupal\Core\Field\FieldDefinitionInterface;
 use Drupal\Core\Field\FieldItemListInterface;
 use Drupal\Core\Field\Plugin\Field\FieldWidget\OptionsSelectWidget;
@@ -11,19 +12,17 @@
 use Drupal\Core\Session\AccountInterface;
 use Drupal\content_moderation\ModerationInformation;
 use Drupal\content_moderation\StateTransitionValidationInterface;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
 /**
  * Plugin implementation of the 'moderation_state_default' widget.
- *
- * @FieldWidget(
- *   id = "moderation_state_default",
- *   label = @Translation("Moderation state"),
- *   field_types = {
- *     "string"
- *   }
- * )
  */
+#[FieldWidget(
+  id: 'moderation_state_default',
+  label: new TranslatableMarkup('Moderation state'),
+  field_types: ['string'],
+)]
 class ModerationStateWidget extends OptionsSelectWidget {
 
   /**

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

@@ -2,20 +2,19 @@
 
 namespace Drupal\datetime\Plugin\Field\FieldWidget;
 
+use Drupal\Core\Field\Attribute\FieldWidget;
 use Drupal\Core\Field\FieldItemListInterface;
 use Drupal\Core\Form\FormStateInterface;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
 
 /**
  * Plugin implementation of the 'datetime_datelist' widget.
- *
- * @FieldWidget(
- *   id = "datetime_datelist",
- *   label = @Translation("Select list"),
- *   field_types = {
- *     "datetime"
- *   }
- * )
  */
+#[FieldWidget(
+  id: 'datetime_datelist',
+  label: new TranslatableMarkup('Select list'),
+  field_types: ['datetime'],
+)]
 class DateTimeDatelistWidget extends DateTimeWidgetBase {
 
   /**

core/modules/datetime/src/Plugin/Field/FieldWidget/DateTimeDefaultWidget.php

@@ -3,23 +3,22 @@
 namespace Drupal\datetime\Plugin\Field\FieldWidget;
 
 use Drupal\Core\Entity\EntityStorageInterface;
+use Drupal\Core\Field\Attribute\FieldWidget;
 use Drupal\Core\Field\FieldItemListInterface;
 use Drupal\Core\Field\FieldDefinitionInterface;
 use Drupal\Core\Form\FormStateInterface;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
 use Drupal\datetime\Plugin\Field\FieldType\DateTimeItem;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
 /**
  * Plugin implementation of the 'datetime_default' widget.
- *
- * @FieldWidget(
- *   id = "datetime_default",
- *   label = @Translation("Date and time"),
- *   field_types = {
- *     "datetime"
- *   }
- * )
  */
+#[FieldWidget(
+  id: 'datetime_default',
+  label: new TranslatableMarkup('Date and time'),
+  field_types: ['datetime'],
+)]
 class DateTimeDefaultWidget extends DateTimeWidgetBase {
 
   /**

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

@@ -2,21 +2,20 @@
 
 namespace Drupal\datetime_range\Plugin\Field\FieldWidget;
 
+use Drupal\Core\Field\Attribute\FieldWidget;
 use Drupal\Core\Field\FieldItemListInterface;
 use Drupal\Core\Form\FormStateInterface;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
 use Drupal\datetime_range\Plugin\Field\FieldType\DateRangeItem;
 
 /**
  * Plugin implementation of the 'daterange_datelist' widget.
- *
- * @FieldWidget(
- *   id = "daterange_datelist",
- *   label = @Translation("Select list"),
- *   field_types = {
- *     "daterange"
- *   }
- * )
  */
+#[FieldWidget(
+  id: 'daterange_datelist',
+  label: new TranslatableMarkup('Select list'),
+  field_types: ['daterange'],
+)]
 class DateRangeDatelistWidget extends DateRangeWidgetBase {
 
   /**

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

@@ -3,23 +3,22 @@
 namespace Drupal\datetime_range\Plugin\Field\FieldWidget;
 
 use Drupal\Core\Entity\EntityStorageInterface;
+use Drupal\Core\Field\Attribute\FieldWidget;
 use Drupal\Core\Field\FieldDefinitionInterface;
 use Drupal\Core\Field\FieldItemListInterface;
 use Drupal\Core\Form\FormStateInterface;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
 use Drupal\datetime_range\Plugin\Field\FieldType\DateRangeItem;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
 /**
  * Plugin implementation of the 'daterange_default' widget.
- *
- * @FieldWidget(
- *   id = "daterange_default",
- *   label = @Translation("Date and time range"),
- *   field_types = {
- *     "daterange"
- *   }
- * )
  */
+#[FieldWidget(
+  id: 'daterange_default',
+  label: new TranslatableMarkup('Date and time range'),
+  field_types: ['daterange'],
+)]
 class DateRangeDefaultWidget extends DateRangeWidgetBase {
 
   /**