diff options
| -rw-r--r-- | modules/field/field.crud.inc | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/modules/field/field.crud.inc b/modules/field/field.crud.inc index 6df32352b..f9c96c92b 100644 --- a/modules/field/field.crud.inc +++ b/modules/field/field.crud.inc @@ -835,11 +835,12 @@ function field_delete_instance($instance, $field_cleanup = TRUE) { /** * Purges a batch of deleted Field API data, instances, or fields. * - * This function will purge deleted field data on up to a specified maximum - * number of entities and then return. If a deleted field instance with no - * remaining data records is found, the instance itself will be purged. - * If a deleted field with no remaining field instances is found, the field - * itself will be purged. + * This function will purge deleted field data in batches. The batch size + * is defined as an argument to the function, and once each batch is finished, + * it continues with the next batch until all have completed. If a deleted field + * instance with no remaining data records is found, the instance itself will + * be purged. If a deleted field with no remaining field instances is found, the + * field itself will be purged. * * @param $batch_size * The maximum number of field data records to purge before returning. |