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

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

Introduction

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

Usage

Use the safe.URL function to encapsulate a known safe URL or URL substring. Schemes other than the following are considered unsafe:

• http:
• https:
• mailto:

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:

{{ $href := "irc://irc.freenode.net/#golang" }}
<a href="{{ $href }}">IRC</a>

Hugo renders the above to:

<a href="#ZgotmplZ">IRC</a>

{{% note %}} ZgotmplZ is a special value that indicates that unsafe content reached a CSS or URL context at runtime. {{% /note %}}

To declare the string as safe:

{{ $href := "irc://irc.freenode.net/#golang" }}
<a href="{{ $href | safeURL }}">IRC</a>

Hugo renders the above to:

<a href="irc://irc.freenode.net/#golang">IRC</a>