encodeForHTMLAttribute

Encodes the input string for safe output in the attribute value of an HTML attribute, such as table width or image height. The encoding is meant to mitigate Cross Site Scripting (XSS) attacks.

encodeForHTMLAttribute(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 encodeForHTMLAttribute

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 encodeForHTMLAttribute function

Simple encodeForHTMLAttribute Example

Shows how and where encodeForHTMLAttribute would be used.

<cfoutput><div title="#encodeForHTMLAttribute("<test>")#"></cfoutput>

Expected Result: <div title="<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/encodeforhtmlattribute