flashMessages()

Signature

flashMessages() — returns any

Description

Displays a marked-up listing of messages that exist in the Flash.

Parameters

Name	Type	Required	Default	Description
keys	string	yes	—	The key (or list of keys) to show the value for. You can also use the key argument instead for better readability when accessing a single key.
class	string	yes	flashMessages	HTML class to set on the div element that contains the messages.
includeEmptyContainer	boolean	yes	false	Includes the div container even if the Flash is empty.
lowerCaseDynamicClassValues	boolean	yes	false	Outputs all class attribute values in lower case (except the main one).

Examples

<!--- In the controller action --->
flashInsert(success="Your post was successfully submitted.");
flashInsert(alert="Don''t forget to tweet about this post!");
flashInsert(error="This is an error message.");

<!--- In the layout or view --->
<cfoutput>
	#flashMessages()#
</cfoutput>
<!---
	Generates this (sorted alphabetically):
	<div class="flashMessages">
		<p class="alertMessage">
			Don''t forget to tweet about this post!
		</p>
		<p class="errorMessage">
			This is an error message.
		</p>
		<p class="successMessage">
			Your post was successfully submitted.
		</p>
	</div>
--->

<!--- Only show the "success" key in the view --->
<cfoutput>
	#flashMessages(key="success")#
</cfoutput>
<!---
	Generates this:
	<div class="flashMessage">
		<p class="successMessage">
			Your post was successfully submitted.
		</p>
	</div>
--->

<!--- Show only the "success" and "alert" keys in the view, in that order --->
<cfoutput>
	#flashMessages(keys="success,alert")#
</cfoutput>
<!---
	Generates this (sorted alphabetically):
	<div class="flashMessages">
		<p class="successMessage">
			Your post was successfully submitted.
		</p>
		<p class="alertMessage">
			Don''t forget to tweet about this post!
		</p>
	</div>
--->