W3cubDocs

/Drupal 8

function hook_batch_alter

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
Define functions that alter the behavior of Drupal core.

File

core/lib/Drupal/Core/Form/form.api.php, line 323
Callbacks and hooks related to form system.

Code

function hook_batch_alter(&$batch) {
}

© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.
https://api.drupal.org/api/drupal/core!lib!Drupal!Core!Form!form.api.php/function/hook_batch_alter/8.1.x