Commit ae98abc1 authored by Dries's avatar Dries
Browse files

- Patch #22652 by Stefan: improved PHPdoc of drupal_set_message().

parent 33f4134f
...@@ -738,12 +738,18 @@ function watchdog($type, $message, $severity = WATCHDOG_NOTICE, $link = NULL) { ...@@ -738,12 +738,18 @@ function watchdog($type, $message, $severity = WATCHDOG_NOTICE, $link = NULL) {
} }
/** /**
* Set a message for the user to see. * Set a message which reflects the status of the performed operation.
* *
* The message is stored in the session so that it can persist through a redirect. * If the function is called with no arguments, this function returns all set
* messages without clearing them.
* *
* If called with no arguments, this function returns all set messages without * @param $message
* clearing them. * The message should begin with a capital letter and always ends with a
* period '.'.
* @param $type
* The type of the message. One of the following values are possible:
* - 'status'
* - 'error'
*/ */
function drupal_set_message($message = NULL, $type = 'status') { function drupal_set_message($message = NULL, $type = 'status') {
if (isset($message)) { if (isset($message)) {
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment