function BatchBuilder::setInitMessage

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

Sets the displayed message while processing is initialized.

Defaults to 'Initializing.'.

Parameters

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

Return value

$this

File

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

Class

BatchBuilder
Builds an array for a batch process.

Namespace

Drupal\Core\Batch

Code

public function setInitMessage($message) {
    $this->initMessage = $message;
    return $this;
}

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