[Batch Plugin] Plugin implementations should use PHP attributes instead of annotations

Created on 25 July 2024, 4 months ago

Problem/Motivation

Drupal 10.2 change notices:
Plugin implementations should use PHP attributes instead of annotations →
Plugin types should use PHP attributes instead of annotations →

Many core plugins have been switched already:
Plugins converted from Annotations to Attributes in 10.3.0 →

No deprecation version has been set for when the core plugin managers will no longer accept Annotations, as they are presently coded to use Attributes, and fallback to Annotations; it is planned that Annotations will be deprecated in Drupal 11.
📌 Triggering deprecations for plugins using annotations when core plugin type has been converted to attributes Needs work

https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Component%21Anno...
https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Component%21Plug...

Attribute-based plugins →

Proposed resolution

For forward compatibility and to increase the window to developers to swap from Annotations, add Attribute as primary plugin discovery method.
- Fork new branch for Drupal 10.2+
- Add Attributes with fallback to Annotations for BC

This is where core adds Attribute as primary over Annotation:
https://git.drupalcode.org/project/drupal/-/commit/d7b47da6deda8a417760c...

Remaining tasks

All

User interface changes

None.

API changes

Developers using Batch Plugin will need to eventually update their plugins to use Attributes.

Data model changes

Plugins now use Attributes instead of Annotations.

📌 Task

Status

Active

Version

1.0

Component

Code

Created by

🇦🇺Australia elc

Live updates comments and jobs are added and updated live.

Comments & Activities

Issue created by @elc
Comment 3 months ago →
🇬🇧United Kingdom Dubs
Thank you @elc for pointing this out. I am happy to amend to code. I looked at the links you shared - can you elaborate on how to support fallback - your second point (Add Attributes with fallback to Annotations for BC). I do want any modules using this will continue to work.

Thanks again :-)
Assigned to Dubs
Status changed to Needs work 3 months ago3:48pm 30 August 2024
Comment 3 months ago →
🇬🇧United Kingdom Dubs
Comment 17 days ago →
🇦🇺Australia elc
This is where Drupal Core uses Attributes primarily with a fallback to Annotation:
https://git.drupalcode.org/project/drupal/-/blob/d7b47da6deda8a417760c26...

This is part of the commit linked the summary.

This is the constructor of the DefaultPluginManager which is given the Attribute and Annotation classes for discovery:
https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Plugin%21...

contrib.social Blog FAQ Discussions

Production build 0.71.5 2024