mirror of
https://github.com/gohugoio/hugo.git
synced 2025-08-21 21:35:28 +02:00
Merge commit '35dec7c96f7ee3eb17dd444f7067f0c776fb56ae'
This commit is contained in:
@@ -1,24 +1,30 @@
|
||||
---
|
||||
title: transform.HTMLEscape
|
||||
linkTitle: htmlEscape
|
||||
description: Returns the given string with the reserved HTML codes escaped.
|
||||
categories: [functions]
|
||||
description: Returns the given string, escaping special characters by replacing them with HTML entities.
|
||||
categories: []
|
||||
keywords: []
|
||||
menu:
|
||||
docs:
|
||||
parent: functions
|
||||
function:
|
||||
action:
|
||||
aliases: [htmlEscape]
|
||||
related:
|
||||
- functions/transform/HTMLUnescape
|
||||
returnType: string
|
||||
signatures: [transform.HTMLEscape INPUT]
|
||||
relatedFunctions:
|
||||
- transform.HTMLEscape
|
||||
- transform.HTMLUnescape
|
||||
aliases: [/functions/htmlescape]
|
||||
---
|
||||
|
||||
In the result `&` becomes `&` and so on. It escapes only: `<`, `>`, `&`, `'` and `"`.
|
||||
The `transform.HTMLEscape` function escapes five special characters by replacing them with [HTML entities]:
|
||||
|
||||
- `&` → `&`
|
||||
- `<` → `<`
|
||||
- `>` → `>`
|
||||
- `'` → `'`
|
||||
- `"` → `"`
|
||||
|
||||
For example:
|
||||
|
||||
```go-html-template
|
||||
{{ htmlEscape "Hugo & Caddy > WordPress & Apache" }} → "Hugo & Caddy > WordPress & Apache"
|
||||
{{ htmlEscape "Lilo & Stitch" }} → Lilo & Stitch
|
||||
{{ htmlEscape "7 > 6" }} → 7 > 6
|
||||
```
|
||||
|
||||
[html entities]: https://developer.mozilla.org/en-US/docs/Glossary/Entity
|
||||
|
Reference in New Issue
Block a user