Use PHP attribute for block plugin. (#145)

Chi-teck · May 20, 2024 · 0f1ed5e · 0f1ed5e
1 parent 504d605
commit 0f1ed5e
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 18 deletions.
diff --git a/templates/Plugin/_block/block.twig b/templates/Plugin/_block/block.twig
@@ -10,7 +10,9 @@ namespace Drupal\{{ machine_name }}\Plugin\Block;
 use Drupal\Core\Access\AccessResult;
 use Drupal\Core\Session\AccountInterface;
   {% endif %}
+use Drupal\Core\Block\Attribute\Block;
 use Drupal\Core\Block\BlockBase;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
   {% if configurable %}
 use Drupal\Core\Form\FormStateInterface;
   {% endif %}
@@ -23,13 +25,12 @@ use Symfony\Component\DependencyInjection\ContainerInterface;
 
 /**
  * Provides {{ plugin_label|article|lower }} block.
- *
- * @Block(
- *   id = "{{ plugin_id }}",
- *   admin_label = @Translation("{{ plugin_label }}"),
- *   category = @Translation("{{ category }}"),
- * )
  */
+#[Block(
+  id: '{{ plugin_id }}',
+  admin_label: new TranslatableMarkup('{{ plugin_label }}'),
+  category: new TranslatableMarkup('{{ category }}'),
+)]
 final class {{ class }} extends BlockBase {% if services %}implements ContainerFactoryPluginInterface {% endif %}{
 
 {% if services %}

diff --git a/tests/functional/Generator/Plugin/_block/_n_deps/_n_config/src/Plugin/Block/ExampleBlock.php b/tests/functional/Generator/Plugin/_block/_n_deps/_n_config/src/Plugin/Block/ExampleBlock.php
@@ -4,17 +4,18 @@
 
 namespace Drupal\foo\Plugin\Block;
 
+use Drupal\Core\Block\Attribute\Block;
 use Drupal\Core\Block\BlockBase;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
 
 /**
  * Provides an example block.
- *
- * @Block(
- *   id = "foo_example",
- *   admin_label = @Translation("Example"),
- *   category = @Translation("Custom"),
- * )
  */
+#[Block(
+  id: 'foo_example',
+  admin_label: new TranslatableMarkup('Example'),
+  category: new TranslatableMarkup('Custom'),
+)]
 final class ExampleBlock extends BlockBase {
 
   /**

diff --git a/tests/functional/Generator/Plugin/_block/_w_deps/_w_config/src/Plugin/Block/ExampleBlock.php b/tests/functional/Generator/Plugin/_block/_w_deps/_w_config/src/Plugin/Block/ExampleBlock.php
@@ -5,22 +5,23 @@
 namespace Drupal\foo\Plugin\Block;
 
 use Drupal\Core\Access\AccessResult;
+use Drupal\Core\Block\Attribute\Block;
 use Drupal\Core\Block\BlockBase;
 use Drupal\Core\CronInterface;
 use Drupal\Core\Form\FormStateInterface;
 use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
 use Drupal\Core\Session\AccountInterface;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
 /**
  * Provides an example block.
- *
- * @Block(
- *   id = "foo_example",
- *   admin_label = @Translation("Example"),
- *   category = @Translation("Custom"),
- * )
  */
+#[Block(
+  id: 'foo_example',
+  admin_label: new TranslatableMarkup('Example'),
+  category: new TranslatableMarkup('Custom'),
+)]
 final class ExampleBlock extends BlockBase implements ContainerFactoryPluginInterface {
 
   /**