You are here

protected function SingleImageFormatter::getEntitiesToView in Single Image 8

Returns the referenced entities for display.

The method takes care of:

  • checking entity access,
  • placing the entities in the language expected for display.

It is thus strongly recommended that formatters use it in their implementation of viewElements($items) rather than dealing with $items directly.

For each entity, the EntityReferenceItem by which the entity is referenced is available in $entity->_referringItem. This is useful for field types that store additional values next to the reference itself.

Parameters

\Drupal\Core\Field\EntityReferenceFieldItemListInterface $items: The item list.

string $langcode: The language code of the referenced entities to display.

Return value

\Drupal\Core\Entity\EntityInterface[] The array of referenced entities to display, keyed by delta.

Overrides ImageFormatterBase::getEntitiesToView

See also

::prepareView()

File

src/Plugin/Field/FieldFormatter/SingleImageFormatter.php, line 24

Class

SingleImageFormatter
Plugin implementation of the 'single_image_formatter' formatter.

Namespace

Drupal\single_image_formatter\Plugin\Field\FieldFormatter

Code

protected function getEntitiesToView(EntityReferenceFieldItemListInterface $items, $langcode) {
  $files = parent::getEntitiesToView($items, $langcode);
  $file = reset($files);
  return $file ? [
    $file,
  ] : [];
}