function FormatterInterface::prepareView
Same name in other branches
- 8.9.x core/lib/Drupal/Core/Field/FormatterInterface.php \Drupal\Core\Field\FormatterInterface::prepareView()
- 10 core/lib/Drupal/Core/Field/FormatterInterface.php \Drupal\Core\Field\FormatterInterface::prepareView()
- 11.x core/lib/Drupal/Core/Field/FormatterInterface.php \Drupal\Core\Field\FormatterInterface::prepareView()
Allows formatters to load information for field values being displayed.
This should be used when a formatter needs to load additional information from the database in order to render a field, for example a reference field that displays properties of the referenced entities such as name or type.
This method operates on multiple entities. The $entities_items parameter is an array keyed by entity ID. For performance reasons, information for all involved entities should be loaded in a single query where possible.
Changes or additions to field values are done by directly altering the items.
Parameters
\Drupal\Core\Field\FieldItemListInterface[] $entities_items: An array with the field values from the multiple entities being rendered.
1 method overrides FormatterInterface::prepareView()
- FormatterBase::prepareView in core/
lib/ Drupal/ Core/ Field/ FormatterBase.php - Allows formatters to load information for field values being displayed.
File
-
core/
lib/ Drupal/ Core/ Field/ FormatterInterface.php, line 60
Class
- FormatterInterface
- Interface definition for field formatter plugins.
Namespace
Drupal\Core\FieldCode
public function prepareView(array $entities_items);
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.