function hook_batch_alter in Drupal 9

Same name and namespace in other branches

1. 8 core/lib/Drupal/Core/Form/form.api.php \hook_batch_alter()
2. 7 modules/system/system.api.php \hook_batch_alter()
3. 10 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

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 327

Callbacks and hooks related to form system.

Code

function hook_batch_alter(&$batch) {
}