drupal_get_messages($type = NULL, $clear_queue = TRUE)
Returns all messages that have been set with drupal_set_message().
Parameters
string $type: (optional) Limit the messages returned by type. Defaults to NULL, meaning all types. These values are supported:
- NULL
- 'status'
- 'warning'
- 'error'
bool $clear_queue: (optional) If this is TRUE, the queue will be cleared of messages of the type specified in the $type parameter. Otherwise the queue will be left intact. Defaults to TRUE.
Return value
array An associative, nested array of messages grouped by message type, with the top-level keys as the message type. The messages returned are limited to the type specified in the $type parameter, if any. If there are no messages of the specified type, an empty array is returned. See drupal_set_message() for the array structure of individual messages.
See also
status-messages.html.twig
File
- core/includes/bootstrap.inc, line 493
- Functions that need to be loaded on every Drupal request.
Code
function drupal_get_messages($type = NULL, $clear_queue = TRUE) { if ($messages = drupal_set_message()) { if ($type) { if ($clear_queue) { unset($_SESSION['messages'][$type]); } if (isset($messages[$type])) { return array($type => $messages[$type]); } } else { if ($clear_queue) { unset($_SESSION['messages']); } return $messages; } } return array(); }
Please login to continue.