encodeForURL

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

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

  1. CFDocs
  2. Functions
  3. ColdFusion 10 New Functions and Tags
  4. encodeForURL
  5. CF10+
  6. Lucee4.5+
  7. BL 1.0.0+
  8. 0 Issue
  9. Edit
See Also:   decodeFromURL   Canonicalize

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 

encodeForURL("<tag>")

Expected Result: %3Ctag%3E

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

Expected Result: %3Ctag%3E

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

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

Signup for cfbreak to stay updated on the latest news from the ColdFusion / CFML community. One email, every friday.

Fork me on GitHub