diff options
Diffstat (limited to 'docs/content/en/functions/Get.md')
-rw-r--r-- | docs/content/en/functions/Get.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/docs/content/en/functions/Get.md b/docs/content/en/functions/Get.md new file mode 100644 index 000000000..142e9811b --- /dev/null +++ b/docs/content/en/functions/Get.md @@ -0,0 +1,26 @@ +--- +title: .Get +description: Accesses positional and ordered parameters in shortcode declaration. +categories: [functions] +keywords: [] +menu: + docs: + parent: functions +function: + aliases: [] + returnType: any + signatures: + - .Get INDEX + - .Get KEY +relatedFunctions: [] +--- + +`.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 named or positional parameters that do not exist, `.Get` returns an empty string instead of interrupting the build. This allows you to chain `.Get` with `if`, `with`, `default` or `cond` to check for parameter existence. For example: + +```go-html-template +{{ $quality := default "100" (.Get 1) }} +``` + +[sc]: /templates/shortcode-templates/ |