URL encoding (percent encoding) with Hugo?

schnerring · January 16, 2022, 10:51am

I’ve been having the same issue. I’ve poked around in the Hugo code base and found the solution. There’s an undocumented built-in Hugo function wrapping the Golang url.QueryEscape function:

github.com

gohugoio/hugo/blob/3d5dbdcb1a11b059fc2f93ed6fadb9009bf72673/tpl/internal/go_templates/texttemplate/funcs.go#L51

    
      
          		"html":     HTMLEscaper,
          		"index":    index,
          		"slice":    slice,
          		"js":       JSEscaper,
          		"len":      length,
          		"not":      not,
          		"or":       or,
          		"print":    fmt.Sprint,
          		"printf":   fmt.Sprintf,
          		"println":  fmt.Sprintln,
          		"urlquery": URLQueryEscaper,
          
          
		// Comparisons
          		"eq": eq, // ==
          		"ge": ge, // >=
          		"gt": gt, // >
          		"le": le, // <=
          		"lt": lt, // <
          		"ne": ne, // !=
          	}
          }

github.com

gohugoio/hugo/blob/3d5dbdcb1a11b059fc2f93ed6fadb9009bf72673/tpl/internal/go_templates/texttemplate/funcs.go#L738-L742

    
      
          // URLQueryEscaper returns the escaped value of the textual representation of
          // its arguments in a form suitable for embedding in a URL query.
          func URLQueryEscaper(args ...interface{}) string {
          	return url.QueryEscape(evalArgs(args))
          }

You can use it with Hugo like this:

{{ urlquery .Permalink }}

Topic		Replies	Views
Is there a url encoder function in Hugo? support	8	5947	January 16, 2022
URLencode in Hugo support	4	4297	April 3, 2020
How do I encode a URL in frontmatter? support	12	4274	January 29, 2016
Url forward slash encoded in small letter case instead capital letter 2f instead 2F support	3	972	February 14, 2022
About htmlEscape: transform https into https%3A%2F%2F support	7	5504	January 17, 2022

URL encoding (percent encoding) with Hugo?

Related topics