function hook_batch_alter in Drupal 7

Same name and namespace in other branches

1. 8 core/lib/Drupal/Core/Form/form.api.php \hook_batch_alter()
2. 9 core/lib/Drupal/Core/Form/form.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 function implements hook_batch_alter()

Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.

overlay_batch_alter in modules/overlay/overlay.module

Implements hook_batch_alter().

1 invocation of hook_batch_alter()

batch_process in includes/form.inc

Processes the batch.

File

modules/system/system.api.php, line 4646

Hooks provided by Drupal core and the System module.

Code

function hook_batch_alter(&$batch) {

  // If the current page request is inside the overlay, add ?render=overlay to
  // the success callback URL, so that it appears correctly within the overlay.
  if (overlay_get_mode() == 'child') {
    if (isset($batch['url_options']['query'])) {
      $batch['url_options']['query']['render'] = 'overlay';
    }
    else {
      $batch['url_options']['query'] = array(
        'render' => 'overlay',
      );
    }
  }
}