Return to v2.1 docs

highlight()


View Helpers Miscellaneous Functions string controller


Highlights the phrase(s) everywhere in the text if found by wrapping them in span tags.

Name Type Required Default Description
text string Yes Text to search in.
phrase string No Phrase (or list of phrases) to highlight. This argument is also aliased as phrases.
delimiter string No , Delimiter to use when passing in multiple phrases.
tag string No span HTML tag to use to wrap the highlighted phrase(s).
class string No highlight Class to use in the tags wrapping highlighted phrase(s).
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.
<!--- Will output: You searched for: <span class="highlight">CFWheels --->
#highlight(text="You searched for: CFWheels", phrases="CFWheels")#

Related Functions

Miscellaneous Functions