encodeForXML

Encodes a string for safe use within an XML tag body. Use encodeForXMLAttribute for variables output inside an XML attribute value.

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

encodeForXML 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.
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.

Examples sample code invoking the encodeForXML function

Encodes the ampersand into an XML entity.

encodeForXML("Fred & Ted")

Expected Result: Fred & Ted


Fork me on GitHub