highlight()

Signature

highlight() — returns string

Available in: controller Category: Miscellaneous Functions

Description

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

Parameters

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.