function BatchBuilder::setProgressMessage

Same name in other branches
  1. 9 core/lib/Drupal/Core/Batch/BatchBuilder.php \Drupal\Core\Batch\BatchBuilder::setProgressMessage()
  2. 8.9.x core/lib/Drupal/Core/Batch/BatchBuilder.php \Drupal\Core\Batch\BatchBuilder::setProgressMessage()
  3. 11.x core/lib/Drupal/Core/Batch/BatchBuilder.php \Drupal\Core\Batch\BatchBuilder::setProgressMessage()

Sets the message to display when the batch is being processed.

Defaults to 'Completed @current of @total.'.

Parameters

string|\Drupal\Core\StringTranslation\TranslatableMarkup $message: The text to display. Available placeholders are:

  • '@current'
  • '@remaining'
  • '@total'
  • '@percentage'
  • '@estimate'
  • '@elapsed'.

Return value

$this

File

core/lib/Drupal/Core/Batch/BatchBuilder.php, line 182

Class

BatchBuilder
Builds an array for a batch process.

Namespace

Drupal\Core\Batch

Code

public function setProgressMessage($message) {
    $this->progressMessage = $message;
    return $this;
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.