blob: 7cfefdfb2dba771ed8510572292cdf7722b5917d (
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
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
|
---
title: safe.HTMLAttr
description: Declares the given key-value pair as a safe HTML attribute.
categories: []
keywords: []
params:
functions_and_methods:
aliases: [safeHTMLAttr]
returnType: template.HTMLAttr
signatures: [safe.HTMLAttr INPUT]
aliases: [/functions/safehtmlattr]
---
## Introduction
{{% include "/_common/functions/go-html-template-package.md" %}}
## Usage
Use the `safe.HTMLAttr` function to encapsulate an HTML attribute from a trusted source.
Use of this type presents a security risk: the encapsulated content should come from a trusted source, as it will be included verbatim in the template output.
See the [Go documentation] for details.
[Go documentation]: https://pkg.go.dev/html/template#HTMLAttr
## Example
Without a safe declaration:
```go-html-template
{{ with .Date }}
{{ $humanDate := time.Format "2 Jan 2006" . }}
{{ $machineDate := time.Format "2006-01-02T15:04:05-07:00" . }}
<time datetime="{{ $machineDate }}">{{ $humanDate }}</time>
{{ end }}
```
Hugo renders the above to:
```html
<time datetime="2024-05-26T07:19:55+02:00">26 May 2024</time>
```
To declare the key-value pair as safe:
```go-html-template
{{ with .Date }}
{{ $humanDate := time.Format "2 Jan 2006" . }}
{{ $machineDate := time.Format "2006-01-02T15:04:05-07:00" . }}
<time {{ printf "datetime=%q" $machineDate | safeHTMLAttr }}>{{ $humanDate }}</time>
{{ end }}
```
Hugo renders the above to:
```html
<time datetime="2024-05-26T07:19:55+02:00">26 May 2024</time>
```
|
