1 system.api.php hook_batch_alter(&$batch)

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 Allow modules to interact with the Backdrop core.

File

core/modules/system/system.api.php, line 3879
Hooks provided by Backdrop core and the System module.

Code

function hook_batch_alter(&$batch) {
  // Add a query string to the completion page URL.
  if (isset($batch['url_options']['query'])) {
    $batch['url_options']['query']['foo'] = 'bar';
  }
}