Skip to content

Commit

Permalink
Issue backdrop#3311: [DX][Docs] Update the API documentation to inclu…
Browse files Browse the repository at this point in the history
…de the new 'info' type for messages.

backdrop/backdrop-issues#3311
  • Loading branch information
klonos authored Oct 12, 2018
1 parent 5d8fc76 commit a2126c3
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions core/includes/bootstrap.inc
Original file line number Diff line number Diff line change
Expand Up @@ -2321,12 +2321,22 @@ function watchdog($type, $message, $variables = array(), $severity = WATCHDOG_NO
* (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.
* @param 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.
* @param string $type
* (optional) The message's type. Defaults to 'status'. These values are
* (optional) The type of the message. Defaults to 'status'. These values are
* supported:
* - 'status'
* - 'warning'
* - 'error'
* - 'status': for "Yay! it worked." messages that need to be displayed as a
* direct result of a user action. Shown once, on the page where the user
* action finishes.
* - 'info': for "Did you know that ...?" messages that need to show generic
* information, persistently across various pages. Can be the result of a
* user action on another section of the site (excludes messages that should
* be warnings/errors).
* - 'warning': for "Careful! You should know that ..." messages.
* - 'error': for "Oh-oh, something went wrong." messages.
* @param bool $repeat
* (optional) If this is FALSE and the message is already set, then the
* message won't be repeated. Defaults to TRUE.
Expand Down

0 comments on commit a2126c3

Please sign in to comment.