docs/content/en/methods/shortcode/Get.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

---
title: Get
description: Returns the value of the given parameter.
categories: []
keywords: []
action:
  related:
    - methods/shortcode/IsNamedParams
    - methods/shortcode/Params
  returnType: any
  signatures: [SHORTCODE.Get PARAM]
toc: true
---

Specify the parameter by position or by name. When calling a shortcode within markdown, use either positional or named parameters, but not both.

{{% note %}}
Some shortcodes support positional parameters, some support named parameters, and others support both. Refer to the shortcode's documentation for usage details.
{{% /note %}}

## Positional parameters

This shortcode call uses positional parameters:

{{< code file=content/about.md lang=md >}}
{{</* myshortcode "Hello" "world" */>}}
{{< /code >}}

To retrieve parameters by position:

{{< code file=layouts/shortcodes/myshortcode.html  >}}
{{ printf "%s %s." (.Get 0) (.Get 1) }} → Hello world.
{{< /code >}}

## Named parameters

This shortcode call uses named parameters:

{{< code file=content/about.md lang=md >}}
{{</* myshortcode greeting="Hello" firstName="world" */>}}
{{< /code >}}

To retrieve parameters by name:

{{< code file=layouts/shortcodes/myshortcode.html  >}}
{{ printf "%s %s." (.Get "greeting") (.Get "firstName") }} → Hello world.
{{< /code >}}

{{% note %}}
Parameter names are case-sensitive.
{{% /note %}}