Same name and namespace in other branches
  1. 4.6.x includes/bootstrap.inc \drupal_set_message()
  2. 5.x includes/bootstrap.inc \drupal_set_message()
  3. 6.x includes/bootstrap.inc \drupal_set_message()
  4. 7.x includes/bootstrap.inc \drupal_set_message()
  5. 8.9.x core/includes/bootstrap.inc \drupal_set_message()

Set a message which reflects the status of the performed operation.

If the function is called with no arguments, this function returns all set messages without clearing them.

Parameters

$message: The message should begin with a capital letter and always ends with a period '.'.

$type: The type of the message. One of the following values are possible:

  • 'status'
  • 'error'
83 calls to drupal_set_message()
aggregator_form_category_submit in modules/aggregator.module
Process aggregator_form_category form submissions. @todo Add delete confirmation dialog.
aggregator_form_feed_submit in modules/aggregator.module
Process aggregator_form_feed form submissions. @todo Add delete confirmation dialog.
aggregator_page_list_submit in modules/aggregator.module
aggregator_parse_feed in modules/aggregator.module
aggregator_remove in modules/aggregator.module

... See full list

File

includes/bootstrap.inc, line 722
Functions that need to be loaded on every Drupal request.

Code

function drupal_set_message($message = NULL, $type = 'status') {
  if ($message) {
    if (!isset($_SESSION['messages'])) {
      $_SESSION['messages'] = array();
    }
    if (!isset($_SESSION['messages'][$type])) {
      $_SESSION['messages'][$type] = array();
    }
    $_SESSION['messages'][$type][] = $message;
  }

  // messages not set when DB connection fails
  return isset($_SESSION['messages']) ? $_SESSION['messages'] : NULL;
}