Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. BatchBuilder.php

function 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;
}

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal