hugo/content/en/functions/get.md
Bjørn Erik Pedersen b9bd35d72e Squashed 'docs/' content from commit fdea5430f
git-subtree-dir: docs
git-subtree-split: fdea5430f89dfd849d39212abdf5ace0a4763e5a
2019-10-21 10:22:28 +02:00

1.1 KiB

title description godocref date publishdate lastmod categories menu keywords signature workson hugoversion relatedfuncs deprecated aliases needsexample
.Get Accesses positional and ordered parameters in shortcode declaration. 2017-02-01 2017-02-01 2017-02-01
functions
docs
parent
functions
shortcodes
.Get INDEX
.Get KEY
false
true

.Get is specifically used when creating your own shortcode template, to access the positional and named 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) }}