encodeForURL

Encodes the input string for safe output in URLs to prevent Cross Site Scripting attacks.

encodeForURL(string [,canonicalize]); → returns string

CF10+

Lucee4.5+

BL 1.0.0+

Argument Reference

string string
Required

The 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 and 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.

Examples
Sample code invoking the encodeForURL function

URL Encode a value

encodeForURL("<tag>")

Expected Result: %3Ctag%3E

URL Encode a value with escaped HTML entities

encodeForURL("&lt;tag&gt;",true)

Expected Result: %3Ctag%3E

Example Usage

<cfset formula = "5+3=8">
<cfoutput>http://example.com/math?formula=#encodeForURL(formula)#</cfoutput>

Expected Result: http://example.com/math?formula=5%2B3%3D8

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