public function EntityViewBuilderInterface::viewMultiple in Drupal 9

Same name and namespace in other branches

1. 8 core/lib/Drupal/Core/Entity/EntityViewBuilderInterface.php \Drupal\Core\Entity\EntityViewBuilderInterface::viewMultiple()
2. 10 core/lib/Drupal/Core/Entity/EntityViewBuilderInterface.php \Drupal\Core\Entity\EntityViewBuilderInterface::viewMultiple()

Builds the render array for the provided entities.

Parameters

array $entities: An array of entities implementing EntityInterface to view.

string $view_mode: (optional) The view mode that should be used to render the entity.

string $langcode: (optional) For which language the entity should be rendered, defaults to the current content language.

Return value

A render array for the entities, indexed by the same keys as the entities array passed in $entities.

Throws

\InvalidArgumentException Can be thrown when the set of parameters is inconsistent, like when trying to view Comments and passing a Node which is not the one the comments belongs to, or not passing one, and having the comments node not be available for loading.

1 method overrides EntityViewBuilderInterface::viewMultiple()

EntityViewBuilder::viewMultiple in core/lib/Drupal/Core/Entity/EntityViewBuilder.php

Builds the render array for the provided entities.

File

core/lib/Drupal/Core/Entity/EntityViewBuilderInterface.php, line 73

Class

EntityViewBuilderInterface

Defines an interface for entity view builders.

Namespace

Drupal\Core\Entity

Code

public function viewMultiple(array $entities = [], $view_mode = 'full', $langcode = NULL);