class BasicStringFormatter

Same name and namespace in other branches
  1. 11.x core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/BasicStringFormatter.php \Drupal\Core\Field\Plugin\Field\FieldFormatter\BasicStringFormatter
  2. 10 core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/BasicStringFormatter.php \Drupal\Core\Field\Plugin\Field\FieldFormatter\BasicStringFormatter
  3. 9 core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/BasicStringFormatter.php \Drupal\Core\Field\Plugin\Field\FieldFormatter\BasicStringFormatter
  4. 8.9.x core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/BasicStringFormatter.php \Drupal\Core\Field\Plugin\Field\FieldFormatter\BasicStringFormatter

Plugin implementation of the 'basic_string' formatter.

Attributes

#[FieldFormatter(id: 'basic_string', label: new TranslatableMarkup('Plain text'), field_types: [ 'string_long', 'email', ])]

Hierarchy

Expanded class hierarchy of BasicStringFormatter

File

core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/BasicStringFormatter.php, line 13

Namespace

Drupal\Core\Field\Plugin\Field\FieldFormatter
View source
class BasicStringFormatter extends FormatterBase {
  
  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    foreach ($items as $delta => $item) {
      // The text value has no text format assigned to it, so the user input
      // should equal the output, including newlines.
      $elements[$delta] = [
        '#type' => 'inline_template',
        '#template' => '{{ value|nl2br }}',
        '#context' => [
          'value' => $item->value,
        ],
      ];
    }
    return $elements;
  }

}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.