version: 1.10

package html

import "html"

Overview

Package html provides functions for escaping and unescaping HTML text.

Index

• func EscapeString(s string) string
• func UnescapeString(s string) string

Examples

• EscapeString
• UnescapeString

Package files

entity.go escape.go

func EscapeString
¶

func EscapeString(s string) string

EscapeString escapes special characters like “<” to become “<”. It escapes
only five such characters: <, >, &, ‘ and “. UnescapeString(EscapeString(s)) ==
s always holds, but the converse isn’t always true.

Example:

const s = `"Fran & Freddie's Diner" <tasty@example.com>`
fmt.Println(html.EscapeString(s))
// Output: &#34;Fran &amp; Freddie&#39;s Diner&#34; &lt;tasty@example.com&gt;

func UnescapeString
¶

func UnescapeString(s string) string

UnescapeString unescapes entities like “<” to become “<”. It unescapes a
larger range of entities than EscapeString escapes. For example, “á”
unescapes to “á”, as does “á” and “á”. UnescapeString(EscapeString(s))
== s always holds, but the converse isn’t always true.

Example:

const s = `"Fran & Freddie's Diner" <tasty@example.com>`
fmt.Println(html.UnescapeString(s))
// Output: "Fran & Freddie's Diner" <tasty@example.com>

Subdirectories

• ..
• template