Skip to content

Commit

Permalink
tpl: Add a querify function to generate query strings inside templates
Browse files Browse the repository at this point in the history
The query function will take a set of parameters specified like a dict and return a url.Values object which can be .Encode'd into a query string.

Example:

<a href="http://www.google.com?{{ (querify "q" "test" "page" 3).Encode | safeHTML }}">Search</a>

Returns:

<a href="http://www.google.com?page=3&q=test">Search</a>

Closes gohugoio#2257
  • Loading branch information
jimmysawczuk authored and tychoish committed Aug 13, 2017
1 parent dc38181 commit 83ba413
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
17 changes: 17 additions & 0 deletions tpl/template_funcs.go
Expand Up @@ -27,6 +27,7 @@ import (
"html"
"html/template"
"math/rand"
"net/url"
"os"
"reflect"
"regexp"
Expand Down Expand Up @@ -1745,6 +1746,21 @@ func sha1(in interface{}) (string, error) {
return hex.EncodeToString(hash[:]), nil
}

// querify converts the given parameters into a url.Values object
func querify(params ...interface{}) (url.Values, error) {
qs := url.Values{}
vals, err := dictionary(params...)
if err != nil {
return url.Values{}, fmt.Errorf("querify keys must be strings")
}

for name, value := range vals {
qs.Add(name, url.QueryEscape(fmt.Sprintf("%v", value)))
}

return qs, nil
}

func init() {
funcMap = template.FuncMap{
"absURL": func(a string) template.HTML { return template.HTML(helpers.AbsURL(a)) },
Expand Down Expand Up @@ -1794,6 +1810,7 @@ func init() {
"partial": partial,
"plainify": plainify,
"pluralize": pluralize,
"querify": querify,
"readDir": readDirFromWorkingDir,
"readFile": readFileFromWorkingDir,
"ref": ref,
Expand Down
2 changes: 2 additions & 0 deletions tpl/template_funcs_test.go
Expand Up @@ -103,6 +103,7 @@ modBool: {{modBool 15 3}}
mul: {{mul 2 3}}
plainify: {{ plainify "Hello <strong>world</strong>, gophers!" }}
pluralize: {{ "cat" | pluralize }}
querify: {{ (querify "foo" 1 "bar" 2 "baz" "with spaces").Encode | safeHTML }}
readDir: {{ range (readDir ".") }}{{ .Name }}{{ end }}
readFile: {{ readFile "README.txt" }}
relURL 1: {{ "http://gohugo.io/" | relURL }}
Expand Down Expand Up @@ -154,6 +155,7 @@ modBool: true
mul: 6
plainify: Hello world, gophers!
pluralize: cats
querify: bar=2&baz=with%2Bspaces&foo=1
readDir: README.txt
readFile: Hugo Rocks!
relURL 1: http://gohugo.io/
Expand Down

0 comments on commit 83ba413

Please sign in to comment.