diff options
| author | webchick <webchick@24967.no-reply.drupal.org> | 2012-03-23 13:47:27 -0600 |
|---|---|---|
| committer | webchick <webchick@24967.no-reply.drupal.org> | 2012-03-23 13:47:27 -0600 |
| commit | 146a05e440711f7f89d48e27be007171311261a3 (patch) | |
| tree | 7353af8ea5277869f300316c0799f8059b88f066 | |
| parent | 7b115a0e167e66b49fe8db3202e0c963377a857b (diff) | |
| download | brdo-146a05e440711f7f89d48e27be007171311261a3.tar.gz brdo-146a05e440711f7f89d48e27be007171311261a3.tar.bz2 | |
Issue #1395974 by webbykat, Michelle, rdrh555: Clarify field_purge_batch() documentation.
| -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. |