mirror of
https://github.com/gohugoio/hugo.git
synced 2024-12-18 16:46:45 -05:00
31 lines
753 B
Markdown
31 lines
753 B
Markdown
|
---
|
||
|
|
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]:
|
||
|
|
|
||
|
|
- `&` → `&`
|
||
|
|
- `<` → `<`
|
||
|
|
- `>` → `>`
|
||
|
|
- `'` → `'`
|
||
|
|
- `"` → `"`
|
||
|
|
|
||
|
|
For example:
|
||
|
|
|
||
|
|
```go-html-template
|
||
|
|
{{ htmlEscape "Lilo & Stitch" }} → Lilo & Stitch
|
||
|
|
{{ htmlEscape "7 > 6" }} → 7 > 6
|
||
|
|
```
|
||
|
|
|
||
|
|
[html entities]: https://developer.mozilla.org/en-US/docs/Glossary/Entity
|