function OptionsDefaultFormatter::viewElements

Same name in other branches
  1. 8.9.x core/modules/options/src/Plugin/Field/FieldFormatter/OptionsDefaultFormatter.php \Drupal\options\Plugin\Field\FieldFormatter\OptionsDefaultFormatter::viewElements()
  2. 10 core/modules/options/src/Plugin/Field/FieldFormatter/OptionsDefaultFormatter.php \Drupal\options\Plugin\Field\FieldFormatter\OptionsDefaultFormatter::viewElements()
  3. 11.x core/modules/options/src/Plugin/Field/FieldFormatter/OptionsDefaultFormatter.php \Drupal\options\Plugin\Field\FieldFormatter\OptionsDefaultFormatter::viewElements()

Overrides FormatterInterface::viewElements

File

core/modules/options/src/Plugin/Field/FieldFormatter/OptionsDefaultFormatter.php, line 28

Class

OptionsDefaultFormatter
Plugin implementation of the 'list_default' formatter.

Namespace

Drupal\options\Plugin\Field\FieldFormatter

Code

public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    // Only collect allowed options if there are actually items to display.
    if ($items->count()) {
        $provider = $items->getFieldDefinition()
            ->getFieldStorageDefinition()
            ->getOptionsProvider('value', $items->getEntity());
        // Flatten the possible options, to support opt groups.
        $options = OptGroup::flattenOptions($provider->getPossibleOptions());
        foreach ($items as $delta => $item) {
            $value = $item->value;
            // If the stored value is in the current set of allowed values, display
            // the associated label, otherwise just display the raw value.
            $output = $options[$value] ?? $value;
            $elements[$delta] = [
                '#markup' => $output,
                '#allowed_tags' => FieldFilteredMarkup::allowedTags(),
            ];
        }
    }
    return $elements;
}

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