mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-07 20:30:36 -05:00
1.2 KiB
1.2 KiB
title | description | categories | menu | keywords | signature | relatedfuncs | |||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
safeHTMLAttr | Declares the provided string as a safe HTML attribute. |
|
|
|
|
Given a site configuration that contains this menu entry:
{{< code-toggle file="hugo" >}} menu.main name = "IRC" url = "irc://irc.freenode.net/#golang" {{< /code-toggle >}}
Attempting to use the url
value directly in an attribute:
{{ range site.Menus.main }}
<a href="{{ .URL }}">{{ .Name }}</a>
{{ end }}
Will produce:
<a href="#ZgotmplZ">IRC</a>
ZgotmplZ
is a special value, inserted by Go's template/html package, that indicates that unsafe content reached a CSS or URL context.
To indicate that the HTML attribute is safe:
{{ range site.Menus.main }}
<a {{ printf "href=%q" .URL | safeHTMLAttr }}>{{ .Name }}</a>
{{ end }}
{{% note %}}
As demonstrated above, you must pass the HTML attribute name and value through the function. Applying safeHTMLAttr
to the attribute value has no effect.
{{% /note %}}