You are here

public function FieldableEntityStorageInterface::purgeFieldData in Drupal 10

Same name and namespace in other branches
  1. 8 core/lib/Drupal/Core/Entity/FieldableEntityStorageInterface.php \Drupal\Core\Entity\FieldableEntityStorageInterface::purgeFieldData()
  2. 9 core/lib/Drupal/Core/Entity/FieldableEntityStorageInterface.php \Drupal\Core\Entity\FieldableEntityStorageInterface::purgeFieldData()

Purges a batch of field data.

Parameters

\Drupal\Core\Field\FieldDefinitionInterface $field_definition: The deleted field whose data is being purged.

int $batch_size: The maximum number of field data records to purge before returning, relating to the count of field data records returned by \Drupal\Core\Entity\FieldableEntityStorageInterface::countFieldData().

Return value

int The number of field data records that have been purged.

1 method overrides FieldableEntityStorageInterface::purgeFieldData()
ContentEntityStorageBase::purgeFieldData in core/lib/Drupal/Core/Entity/ContentEntityStorageBase.php
Purges a batch of field data.

File

core/lib/Drupal/Core/Entity/FieldableEntityStorageInterface.php, line 43

Class

FieldableEntityStorageInterface
A storage that supports entity types with field definitions.

Namespace

Drupal\Core\Entity

Code

public function purgeFieldData(FieldDefinitionInterface $field_definition, $batch_size);