Files
hugoDocs/content/en/functions/transform/XMLEscape.md
T

1.2 KiB

title, description, categories, keywords, params
title description categories keywords params
transform.XMLEscape Returns the given string, removing disallowed characters then escaping the result to its XML equivalent.
functions_and_methods
aliases related returnType signatures
string
transform.XMLEscape INPUT

{{< new-in 0.121.0 />}}

The transform.XMLEscape function removes disallowed characters as defined in the XML specification, then escapes the result by replacing the following characters with HTML entities:

  • " → &#34;
  • ' → &#39;
  • & → &amp;
  • < → &lt;
  • > → &gt;
  • \t → &#x9;
  • \n → &#xA;
  • \r → &#xD;

For example:

{{ transform.XMLEscape "<p>abc</p>" }} → &lt;p&gt;abc&lt;/p&gt;

When using transform.XMLEscape in a template rendered by Go's html/template package, declare the string to be safe HTML to avoid double escaping. For example, in an RSS template:

<description>{{ .Summary | transform.XMLEscape | safeHTML }}</description>