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 implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
    • class \Drupal\Core\Field\PluginSettingsBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Field\PluginSettingsInterface, \Drupal\Component\Plugin\DependentPluginInterface
      • class \Drupal\Core\Field\FormatterBase extends \Drupal\Core\Field\PluginSettingsBase implements \Drupal\Core\Field\FormatterInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface
        • class \Drupal\Core\Field\Plugin\Field\FieldFormatter\EntityReferenceFormatterBase extends \Drupal\Core\Field\FormatterBase
          • class \Drupal\Core\Field\Plugin\Field\FieldFormatter\EntityReferenceIdFormatter extends \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;
    }

}

Members