Back
highlight()
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 |
When set to true, encodes tag content, attribute values, and URLs so that Cross Site Scripting (XSS) attacks can be prevented. Set 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")#
Copied!