From 28c97881efc2b16903af8af85631d39cf89c2a46 Mon Sep 17 00:00:00 2001
From: Lee Rowlands <lee.rowlands@previousnext.com.au>
Date: Fri, 2 Feb 2024 08:57:56 +1000
Subject: [PATCH] Issue #3415412 by dww, gorkagr, acbramley, mstrelan: Field
type plugin description is assumed to be an array
---
.../field_test.field_type_categories.yml | 3 +++
.../TestItemWithMultipleDescriptions.php | 23 +++++++++++++++++++
.../TestItemWithSingleDescription.php | 20 ++++++++++++++++
.../field_ui/src/Form/FieldStorageAddForm.php | 11 +++++----
.../tests/src/Functional/ManageFieldsTest.php | 10 ++++++++
5 files changed, 63 insertions(+), 4 deletions(-)
create mode 100644 core/modules/field/tests/modules/field_test/field_test.field_type_categories.yml
create mode 100644 core/modules/field/tests/modules/field_test/src/Plugin/Field/FieldType/TestItemWithMultipleDescriptions.php
create mode 100644 core/modules/field/tests/modules/field_test/src/Plugin/Field/FieldType/TestItemWithSingleDescription.php
diff --git a/core/modules/field/tests/modules/field_test/field_test.field_type_categories.yml b/core/modules/field/tests/modules/field_test/field_test.field_type_categories.yml
new file mode 100644
index 000000000000..9ad2a5183833
--- /dev/null
+++ b/core/modules/field/tests/modules/field_test/field_test.field_type_categories.yml
@@ -0,0 +1,3 @@
+field_test_descriptions:
+ label: 'Field Test'
+ description: 'Fields for testing descriptions.'
diff --git a/core/modules/field/tests/modules/field_test/src/Plugin/Field/FieldType/TestItemWithMultipleDescriptions.php b/core/modules/field/tests/modules/field_test/src/Plugin/Field/FieldType/TestItemWithMultipleDescriptions.php
new file mode 100644
index 000000000000..d193ebf2f811
--- /dev/null
+++ b/core/modules/field/tests/modules/field_test/src/Plugin/Field/FieldType/TestItemWithMultipleDescriptions.php
@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Drupal\field_test\Plugin\Field\FieldType;
+
+/**
+ * Defines the 'test_field_with_multiple_descriptions' entity field item.
+ *
+ * @FieldType(
+ * id = "test_field_with_multiple_descriptions",
+ * label = @Translation("Test field (multiple descriptions"),
+ * description = {
+ * @Translation("This multiple line description needs to use an array"),
+ * @Translation("This second line contains important information"),
+ * },
+ * category = "field_test_descriptions",
+ * default_widget = "test_field_widget",
+ * default_formatter = "field_test_default"
+ * )
+ */
+class TestItemWithMultipleDescriptions extends TestItem {
+}
diff --git a/core/modules/field/tests/modules/field_test/src/Plugin/Field/FieldType/TestItemWithSingleDescription.php b/core/modules/field/tests/modules/field_test/src/Plugin/Field/FieldType/TestItemWithSingleDescription.php
new file mode 100644
index 000000000000..e14dd039bb5c
--- /dev/null
+++ b/core/modules/field/tests/modules/field_test/src/Plugin/Field/FieldType/TestItemWithSingleDescription.php
@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Drupal\field_test\Plugin\Field\FieldType;
+
+/**
+ * Defines the 'test_field_with_single_description' entity field item.
+ *
+ * @FieldType(
+ * id = "test_field_with_single_description",
+ * label = @Translation("Test field (single description"),
+ * description = @Translation("This one-line field description is important for testing"),
+ * category = "field_test_descriptions",
+ * default_widget = "test_field_widget",
+ * default_formatter = "field_test_default"
+ * )
+ */
+class TestItemWithSingleDescription extends TestItem {
+}
diff --git a/core/modules/field_ui/src/Form/FieldStorageAddForm.php b/core/modules/field_ui/src/Form/FieldStorageAddForm.php
index 63ba58114d3f..e738094d8c81 100644
--- a/core/modules/field_ui/src/Form/FieldStorageAddForm.php
+++ b/core/modules/field_ui/src/Form/FieldStorageAddForm.php
@@ -367,14 +367,17 @@ protected function addFieldOptionsForGroup(array &$form, FormStateInterface $for
$group_field_options = [];
foreach ($unique_definitions as $option) {
$identifier = $option['unique_identifier'];
+ // If the field type plugin's annotation defines description as an
+ // array, render it as an item_list.
+ $description = !is_array($option['description']) ? $option['description'] : [
+ '#theme' => 'item_list',
+ '#items' => $option['description'],
+ ];
$radio_element = [
'#type' => 'radio',
'#theme_wrappers' => ['form_element__new_storage_type'],
'#title' => $option['label'],
- '#description' => [
- '#theme' => 'item_list',
- '#items' => $option['description'],
- ],
+ '#description' => $description,
'#id' => $identifier,
'#weight' => $option['weight'],
'#parents' => ['group_field_options_wrapper'],
diff --git a/core/modules/field_ui/tests/src/Functional/ManageFieldsTest.php b/core/modules/field_ui/tests/src/Functional/ManageFieldsTest.php
index e037cb519ef9..649c2d7f6d72 100644
--- a/core/modules/field_ui/tests/src/Functional/ManageFieldsTest.php
+++ b/core/modules/field_ui/tests/src/Functional/ManageFieldsTest.php
@@ -136,6 +136,16 @@ public function testAddField() {
'type' => 'article',
]);
+ // Make sure field descriptions appear, both 1 line and multiple lines.
+ $this->drupalGet('/admin/structure/types/manage/' . $type->id() . '/fields/add-field');
+ $edit = [
+ 'new_storage_type' => 'field_test_descriptions',
+ ];
+ $this->submitForm($edit, 'Continue');
+ $this->assertSession()->pageTextContains('This one-line field description is important for testing');
+ $this->assertSession()->pageTextContains('This multiple line description needs to use an array');
+ $this->assertSession()->pageTextContains('This second line contains important information');
+
// Create a new field without actually saving it.
$this->fieldUIAddNewField('admin/structure/types/manage/' . $type->id(), 'test_field', 'Test field', 'test_field', [], [], FALSE);
// Assert that the field was not created.
--
GitLab