Difference between revisions of "Nats display admin message"
From TMM Wiki
Jump to navigationJump to searchm |
TMMStephenY (talk | contribs) m |
||
Line 6: | Line 6: | ||
= nats_display_admin_message = | = nats_display_admin_message = | ||
Outputs, or stores in a variable, HTML that displays the | Outputs, or stores in a variable, HTML that displays the | ||
− | + | user action messages in the administration interface. | |
== Parameters == | == Parameters == | ||
Line 30: | Line 30: | ||
== Output == | == Output == | ||
− | An HTML table containing any | + | An HTML table containing any action message for the |
− | [[Admin (NATS)|admin]]. The table includes any error, warning, or | + | [[Ct#Admin (Person, NATS)|admin]]. The table includes any error, warning, or |
confirmation messages the admin should review. | confirmation messages the admin should review. | ||
Line 40: | Line 40: | ||
# There are no action messages to display | # There are no action messages to display | ||
# The server's [[Query String|query string]] is empty. | # The server's [[Query String|query string]] is empty. | ||
+ | |||
+ | [[Category:NATS4 Template Functions]] |
Latest revision as of 15:53, 20 May 2011
Applies to NATS 4.0.25 and greater.
nats_display_admin_message
Outputs, or stores in a variable, HTML that displays the user action messages in the administration interface.
Parameters
(Required parameters in bold)
Parameter | Description | Possible Values | Example | |
---|---|---|---|---|
return | The Smarty variable to receive the user action messages. | Any Smarty variable name. | return="myvar" | |
assign_prefix | Prefix output variables with this word. (Click link for details) | Any valid Smarty variable name | None. (No prefix is used) | assign_prefix="myvar" |
Output
An HTML table containing any action message for the admin. The table includes any error, warning, or confirmation messages the admin should review.
Notes
This function returns no value under the following three circumstances:
- The configuration flag NO_ADMIN_ACTION_MESSAGES is set to "1"
- There are no action messages to display
- The server's query string is empty.