github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-12-27 21:10:51 +00:00
Code Issues Projects Releases Packages Wiki Activity

Improve .Get docs

Browse source
This commit is contained in:
cmal 2018-04-17 11:29:25 +02:00 committed by Bjørn Erik Pedersen
parent e2b277bba5
commit 74520d2cfd
1 changed files with 5 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
docs/content/functions/get.md
View file

@ -20,10 +20,13 @@ needsexample: true
---
`.Get` is specifically used when creating your own [shortcode template][sc].
`.Get` is specifically used when creating your own [shortcode template][sc], to access the [positional and named](/templates/shortcode-templates/#positional-vs-named-parameters) parameters passed to it. When used with a numeric INDEX, it queries positional parameters (starting with 0). With a string KEY, it queries named parameters.
When accessing a named parameter that does not exist, `.Get` returns an empty string instead of interrupting the build. The same goes with positional parameters in hugo version 0.40 and after. This allows you to chain `.Get` with `if`, `with`, `default` or `cond` to check for parameter existence. For example, you may now use:
```
{{ $quality := default "100" (.Get 1) }}
```
[sc]: /templates/shortcode-templates/