function drupal_set_message

Sets a message to display to the user.

Messages are stored in a session variable and displayed in page.tpl.php via the $messages theme variable.

Example usage:

drupal_set_message(t('An error occurred and processing did not complete.'), 'error');

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.

Return value

array|null A multidimensional array with keys corresponding to the set message types. The indexed array values of each contain the set messages for that type. Or, if there are no messages set, the function returns NULL.

See also

drupal_get_messages()

theme_status_messages()

264 calls to drupal_set_message()
action_admin_configure_submit in drupal/core/modules/action/action.admin.inc
Form submission handler for action_admin_configure().
action_admin_delete_form_submit in drupal/core/modules/action/action.admin.inc
Form submission handler for action_admin_delete_form().
action_admin_delete_orphans_post in drupal/core/modules/action/action.admin.inc
Post-deletion operations for deleting action orphans.
action_message_action in drupal/core/modules/action/action.module
Sends a message to the current user's screen.
aggregator_aggregator_remove in drupal/core/modules/aggregator/aggregator.processor.inc
Implements hook_aggregator_remove().

... See full list

File

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

Code

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

    // Mark this page as being uncacheable.
    drupal_page_is_cacheable(FALSE);
  }

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