hugo/docs/content/en/functions/safe/HTML.md

title	description	categories	keywords	action	toc	aliases
safe.HTML	Declares the given string as a safeHTML string.			aliases related returnType signatures safeHTML functions/safe/CSS functions/safe/HTMLAttr functions/safe/JS functions/safe/JSStr functions/safe/URL template.HTML safe.HTML INPUT	true	/functions/safehtml

Introduction

{{% include "functions/_common/go-html-template-package.md" %}}

Usage

Use the safe.HTML function to encapsulate a known safe HTML document fragment. It should not be used for HTML from a third-party, or HTML with unclosed tags or comments.

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.

Example

Without a safe declaration:

{{ $html := "<em>emphasized</em>" }}
{{ $html }}

Hugo renders the above to:

<em>emphasized</em>

To declare the string as safe:

{{ $html := "<em>emphasized</em>" }}
{{ $html | safeHTML }}

Hugo renders the above to:

<em>emphasized</em>