User Guide Cancel

EncodeForURL

 

Description

Encodes the input string for use in URLs.

Returns

Encoded string

Category

Display and formatting functions

Syntax

encodeForURL(inputString [,canonicalize])

See also

Canonicalize,EncodeForHTMLAttribute,EncodeForHTML,EncodeForCSS,EncodeForJavaScript

History

ColdFusion 10: Added this function.

Parameters

Parameter

Description

inputString

Required. The string to encode.

canonicalize

Optional. 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 perform encoding.

Example

<cfscript>
bookName ="What to do when 1 & 1 don't = 2";
myURL='http://site.com?book=#EncodeForURL(bookName)#';
WriteOutput(myURL);
</cfscript>
<cfscript> bookName ="What to do when 1 & 1 don't = 2"; myURL='http://site.com?book=#EncodeForURL(bookName)#'; WriteOutput(myURL); </cfscript>
<cfscript>
       bookName ="What to do when 1 & 1 don't = 2";
       myURL='http://site.com?book=#EncodeForURL(bookName)#';
       WriteOutput(myURL);
</cfscript>

Output

http://site.com?book=What+to+do+when+1+%26+1+don%27t+%3D+2

Note:

EncodeForURL encodes spaces as '+'. If '%20' is desired, then replace '+' with '%20' after encoding the string.

Get help faster and easier

New user?