callback_batch_finished($success, $results, $operations)
Complete a batch process.
Callback for batch_set().
This callback may be specified in a batch to perform clean-up operations, or to analyze the results of the batch operations.
Parameters
$success: A boolean indicating whether the batch has completed successfully.
$results: The value set in $context['results'] by callback_batch_operation().
$operations: If $success is FALSE, contains the operations that remained unprocessed.
Related topics
- Callbacks
- Callback function signatures.
File
- core/lib/Drupal/Core/Form/form.api.php, line 113
- Callbacks and hooks related to form system.
Code
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 | function callback_batch_finished($success, $results, $operations) { if ($success) { // Here we do something meaningful with the results. $message = t("@count items were processed.", array( '@count' => count($results), )); $list = array( '#theme' => 'item_list', '#items' => $results, ); $message .= drupal_render($list); drupal_set_message($message); } else { // An error occurred. // $operations contains the operations that remained unprocessed. $error_operation = reset($operations); $message = t('An error occurred while processing %error_operation with arguments: @arguments', array( '%error_operation' => $error_operation[0], '@arguments' => print_r($error_operation[1], TRUE) )); drupal_set_message($message, 'error'); }} |
Please login to continue.