encodeForHTML

Encodes the input string for safe output in the body of a HTML tag. The encoding in meant to mitigate Cross Site Scripting (XSS) attacks. This function can provide more protection from XSS than the HTMLEditFormat or XMLFormat functions do.

encodeForHTML(string [, canonicalize]) → returns string

CF10+

Lucee4.5+

BL 1.0.0+

Argument Reference

string string
Required

A string to encode

canonicalize boolean
Default: `false`

If set to true, canonicalization happens before encoding. If set to false, the given input string will just be encoded. The default value for canonicalize is false. When this parameter is not specified, canonicalization will not happen. By default, when canonicalization is performed, both mixed and multiple encodings will be allowed. To use any other combinations you should canonicalize using canonicalize method and then do encoding.

Compatibility

BoxLang:

Version 1.0.0+ Requires the bx-esapi module.

Links more information about encodeForHTML

How to call encodeFor functions in CF8 and CF9 - Fully patched CF8 and CF9 servers include the OWASP ESAPI encoder jar.
OWASP Cross Site Scripting Guide - Learn more about XSS

Examples
Sample code invoking the encodeForHTML function

Simple encodeForHTML Example

Pass in a tag and HTML encode the result.

encodeForHTML("<test>")

Expected Result: <test>

© 2012–present Foundeo, Inc. and the CFDocs contributors.
Licensed under the MIT License.
ColdFusion is a trademark of Adobe Systems Incorporated.
https://cfdocs.org/encodeforhtml