You are here

Home » API reference » Feeds 8.3 » StateInterface.php » StateInterface

public function StateInterface::setMessage in Feeds 8.3

Sets a message to display to the user.

This should be used by plugins instead of the Drupal messenger service. It will store messages and display them at the appropriate time.

Parameters

string $message: (optional) The translated message to be displayed to the user. For consistency with other messages, it should begin with a capital letter and end with a period.

string $type: (optional) The message's type. Defaults to 'status'. These values are supported:

  • 'status'
  • 'warning'
  • 'error'.

bool $repeat: (optional) If this is FALSE and the message is already set, then the message won't be repeated. Defaults to FALSE.

See also

\Drupal\Core\Messenger\MessengerInterface::addMessage()

1 method overrides StateInterface::setMessage()
State::setMessage in src/State.php
Sets a message to display to the user.

File

src/StateInterface.php, line 111

Class

StateInterface
Status of the import or clearing operation of a Feed.

Namespace

Drupal\feeds

Code

public function setMessage($message = NULL, $type = 'status', $repeat = FALSE);