class BasicStringFormatter

Plugin implementation of the 'basic_string' formatter.

Plugin annotation

@FieldFormatter(
  id = "basic_string",
  label = @Translation("Plain text"),
  field_types = {
    "string_long",
    "email"
  }
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
    • class \Drupal\Core\Field\PluginSettingsBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Field\PluginSettingsInterface, \Drupal\Component\Plugin\DependentPluginInterface
      • class \Drupal\Core\Field\FormatterBase extends \Drupal\Core\Field\PluginSettingsBase implements \Drupal\Core\Field\FormatterInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface
        • class \Drupal\Core\Field\Plugin\Field\FieldFormatter\BasicStringFormatter extends \Drupal\Core\Field\FormatterBase

Expanded class hierarchy of BasicStringFormatter

File

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

Namespace

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;
    }

}

Members