File: HTMLEscape.md

package info (click to toggle)
hugo 0.131.0-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 45,580 kB
  • sloc: javascript: 31,172; xml: 248; makefile: 73; sh: 42
file content (30 lines) | stat: -rw-r--r-- 753 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
---
title: transform.HTMLEscape
description: Returns the given string, escaping special characters by replacing them with HTML entities.
categories: []
keywords: []
action:
  aliases: [htmlEscape]
  related:
    - functions/transform/HTMLUnescape
  returnType: string
  signatures: [transform.HTMLEscape INPUT]
aliases: [/functions/htmlescape]
---

The `transform.HTMLEscape` function escapes five special characters by replacing them with [HTML entities]:

- `&` → `&`
- `<` → `&lt;`
- `>` → `&gt;`
- `'` → `&#39;`
- `"` → `&#34;`

For example:

```go-html-template
{{ htmlEscape "Lilo & Stitch" }} → Lilo &amp; Stitch
{{ htmlEscape "7 > 6" }} → 7 &gt; 6
```

[html entities]: https://developer.mozilla.org/en-US/docs/Glossary/Entity