View Helpers

simpleFormat()

Signature

simpleFormat() — returns string

Available in: controller Category: Miscellaneous Functions

Returns formatted text using HTML break tags () and HTML paragraph elements (

) based on the newline characters and carriage returns in the text that is passed in.

Name	Type	Required	Default	Description
`text`	`string`	yes	—	The text to format.
`wrap`	`boolean`	no	`true`	Set to `true` to wrap the result in a paragraph HTML element.
`encode`	`boolean`	no	`true`	Use this argument to decide whether the output of the function should be encoded in order to prevent Cross Site Scripting (XSS) attacks. Set it to `true` to encode all relevant output for the specific HTML element in question (e.g. tag content, attribute values, and URLs). For HTML elements that have both tag content and attribute values you can set this argument to `attributes` to only encode attribute values and not tag content.