summaryrefslogtreecommitdiffstats
path: root/docs/content/en/functions/transform/HTMLUnescape.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/content/en/functions/transform/HTMLUnescape.md')
-rw-r--r--docs/content/en/functions/transform/HTMLUnescape.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/content/en/functions/transform/HTMLUnescape.md b/docs/content/en/functions/transform/HTMLUnescape.md
new file mode 100644
index 000000000..180318077
--- /dev/null
+++ b/docs/content/en/functions/transform/HTMLUnescape.md
@@ -0,0 +1,30 @@
+---
+title: transform.HTMLUnescape
+description: Returns the given string, replacing each HTML entity with its corresponding character.
+categories: []
+keywords: []
+action:
+ aliases: [htmlUnescape]
+ related:
+ - functions/transform/HTMLEscape
+ returnType: string
+ signatures: [transform.HTMLUnescape INPUT]
+aliases: [/functions/htmlunescape]
+---
+
+The `transform.HTMLUnescape` function replaces [HTML entities] with their corresponding characters.
+
+```go-html-template
+{{ htmlUnescape "Lilo & Stitch" }} → Lilo & Stitch
+{{ htmlUnescape "7 > 6" }} → 7 > 6
+```
+
+In most contexts Go's [html/template] package will escape special characters. To bypass this behavior, pass the unescaped string through the [`safeHTML`] function.
+
+```go-html-template
+{{ htmlUnescape "Lilo & Stitch" | safeHTML }}
+```
+
+[`safehtml`]: /functions/safe/html
+[html entities]: https://developer.mozilla.org/en-us/docs/glossary/entity
+[html/template]: https://pkg.go.dev/html/template