function batch_load in Drupal 7

Loads a batch from the database.

Parameters

$id: The ID of the batch to load. When a progressive batch is being processed, the relevant ID is found in $_REQUEST['id'].

Return value

An array representing the batch, or FALSE if no batch was found.

2 calls to batch_load()

_batch_page in includes/batch.inc

Renders the batch processing page based on the current state of the batch.

_system_batch_theme in modules/system/system.module

Theme callback for the default batch page.

File

includes/batch.inc, line 27

Batch processing API for processes to run in multiple HTTP requests.

Code

function batch_load($id) {
  $batch = db_query("SELECT batch FROM {batch} WHERE bid = :bid AND token = :token", array(
    ':bid' => $id,
    ':token' => drupal_get_token($id),
  ))
    ->fetchField();
  if ($batch) {
    return unserialize($batch);
  }
  return FALSE;
}