From 7fe1ece946f0bdfbab9770c0e26d4e6cbef63c7a Mon Sep 17 00:00:00 2001 From: Angie Byron Date: Tue, 20 Apr 2010 18:48:05 +0000 Subject: #717602 by heyrocker, jhodgdon: Document hook_batch_alter(). --- modules/system/system.api.php | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/modules/system/system.api.php b/modules/system/system.api.php index 49dfec100..4c97cd757 100644 --- a/modules/system/system.api.php +++ b/modules/system/system.api.php @@ -3192,6 +3192,34 @@ function hook_token_info() { ); } +/** + * Alter batch information before a batch is processed. + * + * Called by batch_process() to allow modules to alter a batch before it is + * processed. + * + * @param $batch + * The associative array of batch information. See batch_set() for details on + * what this could contain. + * + * @see batch_set() + * @see batch_process() + * + * @ingroup batch + */ +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'); + } + } +} + /** * Alter the metadata about available placeholder tokens and token types. * -- cgit v1.2.3