class EntityReferenceIdFormatter

Plugin implementation of the 'entity reference ID' formatter.

Plugin annotation

@FieldFormatter(
  id = "entity_reference_entity_id",
  label = @Translation("Entity ID"),
  description = @Translation("Display the ID of the referenced entities."),
  field_types = {
    "entity_reference"
  }
)

Hierarchy

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

Expanded class hierarchy of EntityReferenceIdFormatter

File

core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/EntityReferenceIdFormatter.php, line 19

Namespace

class EntityReferenceIdFormatter extends EntityReferenceFormatterBase {
  
  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    foreach ($this->getEntitiesToView($items, $langcode) as $delta => $entity) {
      if ($entity->id()) {
        $elements[$delta] = [
          '#plain_text' => $entity->id(),
          // Create a cache tag entry for the referenced entity. In the case
          // that the referenced entity is deleted, the cache for referring
          // entities must be cleared.
'#cache' => [
            'tags' => $entity->getCacheTags(),
          ],
        ];
      }
    }
    return $elements;
  }

}