Home › API reference

drupal_set_message

Definition

drupal_set_message($message = NULL, $type = 'status')
drupal/includes/bootstrap.inc, line 698

Description

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'

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