diff options
| author | Dries Buytaert <dries@buytaert.net> | 2005-05-14 18:32:22 +0000 |
|---|---|---|
| committer | Dries Buytaert <dries@buytaert.net> | 2005-05-14 18:32:22 +0000 |
| commit | ae98abc15b7028b750fc2b40b756b37be89c1034 (patch) | |
| tree | 34563b620e7a2c40b5238ead45991facb88e2d0e | |
| parent | 33f4134fac5ab47ab7130c8aa18d465aa247a283 (diff) | |
| download | brdo-ae98abc15b7028b750fc2b40b756b37be89c1034.tar.gz brdo-ae98abc15b7028b750fc2b40b756b37be89c1034.tar.bz2 | |
- Patch #22652 by Stefan: improved PHPdoc of drupal_set_message().
| -rw-r--r-- | includes/bootstrap.inc | 14 |
1 files changed, 10 insertions, 4 deletions
diff --git a/includes/bootstrap.inc b/includes/bootstrap.inc index 520bacf61..9e8b4d217 100644 --- a/includes/bootstrap.inc +++ b/includes/bootstrap.inc @@ -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 - * clearing them. + * @param $message + * 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') { if (isset($message)) { |