function ContentEntityStorageBase::readFieldItemsToPurge

Same name in other branches
  1. 8.9.x core/lib/Drupal/Core/Entity/ContentEntityStorageBase.php \Drupal\Core\Entity\ContentEntityStorageBase::readFieldItemsToPurge()
  2. 10 core/lib/Drupal/Core/Entity/ContentEntityStorageBase.php \Drupal\Core\Entity\ContentEntityStorageBase::readFieldItemsToPurge()
  3. 11.x core/lib/Drupal/Core/Entity/ContentEntityStorageBase.php \Drupal\Core\Entity\ContentEntityStorageBase::readFieldItemsToPurge()

Reads values to be purged for a single field.

This method is called during field data purge, on fields for which onFieldDefinitionDelete() has previously run.

Parameters

\Drupal\Core\Field\FieldDefinitionInterface $field_definition: The field definition.

$batch_size: The maximum number of field data records to purge before returning.

Return value

\Drupal\Core\Field\FieldItemListInterface[] An array of field item lists, keyed by entity revision id.

1 call to ContentEntityStorageBase::readFieldItemsToPurge()
ContentEntityStorageBase::purgeFieldData in core/lib/Drupal/Core/Entity/ContentEntityStorageBase.php
2 methods override ContentEntityStorageBase::readFieldItemsToPurge()
ContentEntityNullStorage::readFieldItemsToPurge in core/lib/Drupal/Core/Entity/ContentEntityNullStorage.php
Reads values to be purged for a single field.
SqlContentEntityStorage::readFieldItemsToPurge in core/lib/Drupal/Core/Entity/Sql/SqlContentEntityStorage.php
Reads values to be purged for a single field.

File

core/lib/Drupal/Core/Entity/ContentEntityStorageBase.php, line 580

Class

ContentEntityStorageBase
Base class for content entity storage handlers.

Namespace

Drupal\Core\Entity

Code

protected abstract function readFieldItemsToPurge(FieldDefinitionInterface $field_definition, $batch_size);

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.