Issue #1241938 by swentel, Niklas Fiekas, yched: Added support for...

Issue #1241938 by swentel, Niklas Fiekas, yched: Added support for #placeholder to relevant Field API widgets.

core/modules/field/modules/email/lib/Drupal/email/Plugin/field/widget/EmailDefaultWidget.php

@@ -20,11 +20,27 @@
  *   label = @Translation("E-mail"),
  *   field_types = {
  *     "email"
+ *   },
+ *   settings = {
+ *     "placeholder" = ""
  *   }
  * )
  */
 class EmailDefaultWidget extends WidgetBase {
 
+  /**
+   * Implements Drupal\field\Plugin\Type\Widget\WidgetInterface::settingsForm().
+   */
+  public function settingsForm(array $form, array &$form_state) {
+    $element['placeholder'] = array(
+      '#type' => 'textfield',
+      '#title' => t('Placeholder'),
+      '#default_value' => $this->getSetting('placeholder'),
+      '#description' => t('The placeholder is a short hint (a word or short phrase) intended to aid the user with data entry. A hint could be a sample value or a brief description of the expected format.'),
+    );
+    return $element;
+  }
+
   /**
    * Implements Drupal\field\Plugin\Type\Widget\WidgetInterface::formElement().
    */
@@ -32,6 +48,7 @@ public function formElement(array $items, $delta, array $element, $langcode, arr
     $element['value'] = $element + array(
       '#type' => 'email',
       '#default_value' => isset($items[$delta]['value']) ? $items[$delta]['value'] : NULL,
+      '#placeholder' => $this->getSetting('placeholder'),
     );
     return $element;
   }

core/modules/field/modules/email/lib/Drupal/email/Tests/EmailFieldTest.php

@@ -56,6 +56,9 @@ function testEmailField() {
       'bundle' => 'test_bundle',
       'widget' => array(
         'type' => 'email_default',
+        'settings' => array(
+          'placeholder' => 'example@example.com',
+        ),
       ),
       'display' => array(
         'full' => array(
@@ -69,6 +72,7 @@ function testEmailField() {
     $this->drupalGet('test-entity/add/test_bundle');
     $langcode = LANGUAGE_NOT_SPECIFIED;
     $this->assertFieldByName("{$this->field['field_name']}[$langcode][0][value]", '', 'Widget found.');
+    $this->assertRaw('placeholder="example@example.com"');
 
     // Submit a valid e-mail address and ensure it is accepted.
     $value = 'test@example.com';

core/modules/field/modules/link/lib/Drupal/link/Tests/LinkFieldTest.php

@@ -58,6 +58,9 @@ function testURLValidation() {
       ),
       'widget' => array(
         'type' => 'link_default',
+        'settings' => array(
+          'placeholder_url' => 'http://example.com',
+        ),
       ),
       'display' => array(
         'full' => array(
@@ -71,6 +74,7 @@ function testURLValidation() {
     // Display creation form.
     $this->drupalGet('test-entity/add/test_bundle');
     $this->assertFieldByName("{$this->field['field_name']}[$langcode][0][url]", '', 'Link URL field is displayed');
+    $this->assertRaw('placeholder="http://example.com"');
 
     // Verify that a valid URL can be submitted.
     $value = 'http://www.example.com/';
@@ -121,6 +125,10 @@ function testLinkTitle() {
       ),
       'widget' => array(
         'type' => 'link_default',
+        'settings' => array(
+          'placeholder_url' => 'http://example.com',
+          'placeholder_title' => 'Enter a title for this link',
+        ),
       ),
       'display' => array(
         'full' => array(
@@ -141,11 +149,15 @@ function testLinkTitle() {
       // Display creation form.
       $this->drupalGet('test-entity/add/test_bundle');
       $this->assertFieldByName("{$this->field['field_name']}[$langcode][0][url]", '', 'URL field found.');
+      $this->assertRaw('placeholder="http://example.com"');
 
       if ($title_setting === DRUPAL_DISABLED) {
         $this->assertNoFieldByName("{$this->field['field_name']}[$langcode][0][title]", '', 'Title field not found.');
+        $this->assertNoRaw('placeholder="Enter a title for this link"');
       }
       else {
+        $this->assertRaw('placeholder="Enter a title for this link"');
+
         $this->assertFieldByName("{$this->field['field_name']}[$langcode][0][title]", '', 'Title field found.');
         if ($title_setting === DRUPAL_REQUIRED) {
           // Verify that the title is required, if the URL is non-empty.

core/modules/field/modules/link/link.module

@@ -97,19 +97,53 @@ function link_field_widget_info() {
   $widgets['link_default'] = array(
     'label' => 'Link',
     'field types' => array('link'),
+    'settings' => array(
+      'placeholder_title' => '',
+      'placeholder_url' => '',
+    ),
   );
   return $widgets;
 }
 
+/**
+ * Implements hook_field_widget_settings_form().
+ */
+function link_field_widget_settings_form($field, $instance) {
+  $widget = $instance['widget'];
+  $settings = $widget['settings'];
+
+  $form['placeholder_url'] = array(
+    '#type' => 'textfield',
+    '#title' => t('Placeholder for URL'),
+    '#default_value' => $settings['placeholder_url'],
+    '#description' => t('The placeholder is a short hint (a word or short phrase) intended to aid the user with data entry. A hint could be a sample value or a brief description of the expected format.'),
+  );
+  $form['placeholder_title'] = array(
+    '#type' => 'textfield',
+    '#title' => t('Placeholder for link title'),
+    '#default_value' => $settings['placeholder_title'],
+    '#description' => t('The placeholder is a short hint (a word or short phrase) intended to aid the user with data entry. A hint could be a sample value or a brief description of the expected format.'),
+    '#states' => array(
+      'invisible' => array(
+        ':input[name="instance[settings][title]"]' => array('value' => DRUPAL_DISABLED),
+      ),
+    ),
+  );
+
+  return $form;
+}
+
 /**
  * Implements hook_field_widget_form().
  */
 function link_field_widget_form(&$form, &$form_state, $field, $instance, $langcode, $items, $delta, $element) {
   $settings = $instance['settings'];
+  $widget_settings = $instance['widget']['settings'];
 
   $element['url'] = array(
     '#type' => 'url',
     '#title' => t('URL'),
+    '#placeholder' => isset($widget_settings['placeholder_url']) ? $widget_settings['placeholder_url'] : '',
     '#default_value' => isset($items[$delta]['url']) ? $items[$delta]['url'] : NULL,
     '#maxlength' => 2048,
     '#required' => $element['#required'],
@@ -117,6 +151,7 @@ function link_field_widget_form(&$form, &$form_state, $field, $instance, $langco
   $element['title'] = array(
     '#type' => 'textfield',
     '#title' => t('Title'),
+    '#placeholder' => isset($widget_settings['placeholder_title']) ? $widget_settings['placeholder_title'] : '',
     '#default_value' => isset($items[$delta]['title']) ? $items[$delta]['title'] : NULL,
     '#maxlength' => 255,
     '#access' => $settings['title'] != DRUPAL_DISABLED,

core/modules/field/modules/number/lib/Drupal/number/Plugin/field/widget/NumberWidget.php

@@ -22,11 +22,27 @@
  *     "number_integer",
  *     "number_decimal",
  *     "number_float"
+ *   },
+ *   settings = {
+ *     "placeholder" = ""
  *   }
  * )
  */
 class NumberWidget extends WidgetBase {
 
+  /**
+   * Implements Drupal\field\Plugin\Type\Widget\WidgetInterface::settingsForm().
+   */
+  public function settingsForm(array $form, array &$form_state) {
+    $element['placeholder'] = array(
+      '#type' => 'textfield',
+      '#title' => t('Placeholder'),
+      '#default_value' => $this->getSetting('placeholder'),
+      '#description' => t('The placeholder is a short hint (a word or short phrase) intended to aid the user with data entry. A hint could be a sample value or a brief description of the expected format.'),
+    );
+    return $element;
+  }
+
   /**
    * Implements Drupal\field\Plugin\Type\Widget\WidgetInterface::formElement().
    */
@@ -39,6 +55,7 @@ public function formElement(array $items, $delta, array $element, $langcode, arr
     $element += array(
       '#type' => 'number',
       '#default_value' => $value,
+      '#placeholder' => $this->getSetting('placeholder'),
     );
 
     // Set the step for floating point and decimal numbers.

core/modules/field/modules/number/lib/Drupal/number/Tests/NumberFieldTest.php

@@ -59,6 +59,9 @@ function testNumberDecimalField() {
       'bundle' => 'test_bundle',
       'widget' => array(
         'type' => 'number',
+        'settings' => array(
+          'placeholder' => '0.00'
+        ),
       ),
       'display' => array(
         'default' => array(
@@ -72,6 +75,7 @@ function testNumberDecimalField() {
     $this->drupalGet('test-entity/add/test_bundle');
     $langcode = LANGUAGE_NOT_SPECIFIED;
     $this->assertFieldByName("{$this->field['field_name']}[$langcode][0][value]", '', 'Widget is displayed');
+    $this->assertRaw('placeholder="0.00"');
 
     // Submit a signed decimal value within the allowed precision and scale.
     $value = '-1234.5678';

core/modules/field/modules/text/lib/Drupal/text/Plugin/field/widget/TextareaWidget.php

@@ -22,7 +22,8 @@
  *     "text_long"
  *   },
  *   settings = {
- *     "rows" = "5"
+ *     "rows" = "5",
+ *     "placeholder" = ""
  *   }
  * )
  */
@@ -39,6 +40,12 @@ public function settingsForm(array $form, array &$form_state) {
       '#required' => TRUE,
       '#min' => 1,
     );
+    $element['placeholder'] = array(
+      '#type' => 'textfield',
+      '#title' => t('Placeholder'),
+      '#default_value' => $this->getSetting('placeholder'),
+      '#description' => t('The placeholder is a short hint (a word or short phrase) intended to aid the user with data entry. A hint could be a sample value or a brief description of the expected format.'),
+    );
     return $element;
   }
 
@@ -50,6 +57,7 @@ public function formElement(array $items, $delta, array $element, $langcode, arr
       '#type' => 'textarea',
       '#default_value' => isset($items[$delta]['value']) ? $items[$delta]['value'] : NULL,
       '#rows' => $this->getSetting('rows'),
+      '#placeholder' => $this->getSetting('placeholder'),
       '#attributes' => array('class' => array('text-full')),
     );
 

core/modules/field/modules/text/lib/Drupal/text/Plugin/field/widget/TextareaWithSummaryWidget.php

@@ -22,7 +22,8 @@
  *   },
  *   settings = {
  *     "rows" = "9",
- *     "summary_rows" = "3"
+ *     "summary_rows" = "3",
+ *     "placeholder" = ""
  *   }
  * )
  */

core/modules/field/modules/text/lib/Drupal/text/Plugin/field/widget/TextfieldWidget.php

@@ -22,7 +22,8 @@
  *     "text"
  *   },
  *   settings = {
- *     "size" = "60"
+ *     "size" = "60",
+ *     "placeholder" = ""
  *   }
  * )
  */
@@ -39,6 +40,12 @@ public function settingsForm(array $form, array &$form_state) {
       '#required' => TRUE,
       '#min' => 1,
     );
+    $element['placeholder'] = array(
+      '#type' => 'textfield',
+      '#title' => t('Placeholder'),
+      '#default_value' => $this->getSetting('placeholder'),
+      '#description' => t('The placeholder is a short hint (a word or short phrase) intended to aid the user with data entry. A hint could be a sample value or a brief description of the expected format.'),
+    );
     return $element;
   }
 
@@ -50,6 +57,7 @@ public function formElement(array $items, $delta, array $element, $langcode, arr
       '#type' => 'textfield',
       '#default_value' => isset($items[$delta]['value']) ? $items[$delta]['value'] : NULL,
       '#size' => $this->getSetting('size'),
+      '#placeholder' => $this->getSetting('placeholder'),
       '#maxlength' => $this->field['settings']['max_length'],
       '#attributes' => array('class' => array('text-full')),
     );

core/modules/field/modules/text/lib/Drupal/text/Tests/TextFieldTest.php

@@ -114,6 +114,9 @@ function _testTextfieldWidgets($field_type, $widget_type) {
       ),
       'widget' => array(
         'type' => $widget_type,
+        'settings' => array(
+          'placeholder' => 'A placeholder on ' . $widget_type,
+        ),
       ),
       'display' => array(
         'full' => array(
@@ -128,6 +131,7 @@ function _testTextfieldWidgets($field_type, $widget_type) {
     $this->drupalGet('test-entity/add/test_bundle');
     $this->assertFieldByName("{$this->field_name}[$langcode][0][value]", '', 'Widget is displayed');
     $this->assertNoFieldByName("{$this->field_name}[$langcode][0][format]", '1', 'Format selector is not displayed');
+    $this->assertRaw(format_string('placeholder="A placeholder on !widget_type"', array('!widget_type' => $widget_type)));
 
     // Submit with some value.
     $value = $this->randomName();

core/modules/field_ui/lib/Drupal/field_ui/Tests/FieldUiTestBase.php

@@ -25,7 +25,7 @@ function setUp() {
     parent::setUp();
 
     // Create test user.
-    $admin_user = $this->drupalCreateUser(array('access content', 'administer content types', 'administer taxonomy', 'administer users'));
+    $admin_user = $this->drupalCreateUser(array('access content', 'administer content types', 'administer taxonomy', 'administer users', 'bypass node access'));
     $this->drupalLogin($admin_user);
 
     // Create content type, with underscores.

core/modules/taxonomy/lib/Drupal/taxonomy/Plugin/field/widget/TaxonomyAutocompleteWidget.php

@@ -23,13 +23,27 @@
  *   },
  *   settings = {
  *     "size" = "60",
- *     "autocomplete_path" = "taxonomy/autocomplete"
+ *     "autocomplete_path" = "taxonomy/autocomplete",
+ *     "placeholder" = ""
  *   },
  *   multiple_values = TRUE
  * )
  */
 class TaxonomyAutocompleteWidget extends WidgetBase {
 
+  /**
+   * Implements Drupal\field\Plugin\Type\Widget\WidgetInterface::settingsForm().
+   */
+  public function settingsForm(array $form, array &$form_state) {
+    $element['placeholder'] = array(
+      '#type' => 'textfield',
+      '#title' => t('Placeholder'),
+      '#default_value' => $this->getSetting('placeholder'),
+      '#description' => t('The placeholder is a short hint (a word or short phrase) intended to aid the user with data entry. A hint could be a sample value or a brief description of the expected format.'),
+    );
+    return $element;
+  }
+
   /**
    * Implements Drupal\field\Plugin\Type\Widget\WidgetInterface::formElement().
    */
@@ -45,6 +59,7 @@ public function formElement(array $items, $delta, array $element, $langcode, arr
       '#default_value' => taxonomy_implode_tags($tags),
       '#autocomplete_path' => $this->getSetting('autocomplete_path') . '/' . $field['field_name'],
       '#size' => $this->getSetting('size'),
+      '#placeholder' => $this->getSetting('placeholder'),
       '#maxlength' => 1024,
       '#element_validate' => array('taxonomy_autocomplete_validate'),
     );

core/modules/taxonomy/lib/Drupal/taxonomy/Tests/TermTest.php

@@ -142,7 +142,12 @@ function testTaxonomyNode() {
   function testNodeTermCreationAndDeletion() {
     // Enable tags in the vocabulary.
     $instance = $this->instance;
-    $instance['widget'] = array('type' => 'taxonomy_autocomplete');
+    $instance['widget'] = array(
+      'type' => 'taxonomy_autocomplete',
+      'settings' => array(
+        'placeholder' => 'Start typing here.',
+      ),
+    );
     field_update_instance($instance);
     $terms = array(
       'term1' => $this->randomName(),
@@ -159,8 +164,12 @@ function testNodeTermCreationAndDeletion() {
     // free-tagging field created by the default profile.
     $edit[$instance['field_name'] . "[$langcode]"] = drupal_implode_tags($terms);
 
+    // Verify the placeholder is there.
+    $this->drupalGet('node/add/article');
+    $this->assertRaw('placeholder="Start typing here."');
+
     // Preview and verify the terms appear but are not created.
-    $this->drupalPost('node/add/article', $edit, t('Preview'));
+    $this->drupalPost(NULL, $edit, t('Preview'));
     foreach ($terms as $term) {
       $this->assertText($term, 'The term appears on the node preview');
     }