function hook_batch_alter

Same name in other branches
  1. 7.x modules/system/system.api.php \hook_batch_alter()
  2. 9 core/lib/Drupal/Core/Form/form.api.php \hook_batch_alter()
  3. 8.9.x core/lib/Drupal/Core/Form/form.api.php \hook_batch_alter()
  4. 11.x core/lib/Drupal/Core/Form/form.api.php \hook_batch_alter()

Alter batch information before a batch is processed.

Called by batch_process() to allow modules to alter a batch before it is processed.

Parameters

$batch: The associative array of batch information. See batch_set() for details on what this could contain.

See also

batch_set()

batch_process()

Related topics

Batch operations
Creates and processes batch operations.
Hooks
Define functions that alter the behavior of Drupal core.
1 invocation of hook_batch_alter()
batch_process in core/includes/form.inc
Processes the batch.

File

core/lib/Drupal/Core/Form/form.api.php, line 338

Code

function hook_batch_alter(&$batch) {
}

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