docs: Update querify function description and examples

The querify function now accepts a slice per #8305.
This commit is contained in:
Joe Mooring 2021-05-10 08:18:37 -07:00 committed by GitHub
parent c46fc838a9
commit 2c7f5b62f6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,7 +1,7 @@
---
title: querify
linktitle: querify
description: Takes a set of key-value pairs and returns a query string to be appended to URLs.
description: Takes a set or slice of key-value pairs and returns a query string to be appended to URLs.
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01
@ -11,7 +11,7 @@ menu:
parent: "functions"
keywords: [urls]
godocref:
signature: ["querify KEY VALUE [KEY VALUE]..."]
signature: ["querify KEY VALUE [KEY VALUE]...", "querify COLLECTION"]
hugoversion:
deprecated: false
workson: []
@ -19,16 +19,19 @@ relatedfuncs: []
aliases: []
---
`querify` takes a set of key-value pairs and returns a [query string](https://en.wikipedia.org/wiki/Query_string) that can be appended to a URL. E.g.
`querify` takes a set or slice of key-value pairs and returns a [query string](https://en.wikipedia.org/wiki/Query_string) that can be appended to a URL.
The following example creates a link to a search results page on Google.
The following examples create a link to a search results page on Google.
```
```go-html-template
<a href="https://www.google.com?{{ (querify "q" "test" "page" 3) | safeURL }}">Search</a>
{{ $qs := slice "q" "test" "page" 3 }}
<a href="https://www.google.com?{{ (querify $qs) | safeURL }}">Search</a>
```
This example renders the following HTML:
Both of these examples render the following HTML:
```
```html
<a href="https://www.google.com?page=3&q=test">Search</a>
```