summaryrefslogtreecommitdiffstats
path: root/docs/content/en/functions/transform/HTMLEscape.md
blob: 62249367bb9e4bef55ffdcb36c61624c550ef446 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
---
title: transform.HTMLEscape
linkTitle: htmlEscape
description: Returns the given string with the reserved HTML codes escaped.
categories: [functions]
keywords: []
menu:
  docs:
    parent: functions
function:
  aliases: [htmlEscape]
  returnType: string
  signatures: [transform.HTMLEscape INPUT]
relatedFunctions:
  - transform.HTMLEscape
  - transform.HTMLUnescape
aliases: [/functions/htmlescape]
---

In the result `&` becomes `&amp;` and so on. It escapes only: `<`, `>`, `&`, `'` and `"`.

```go-html-template
{{ htmlEscape "Hugo & Caddy > WordPress & Apache" }} → "Hugo &amp; Caddy &gt; WordPress &amp; Apache"
```