hugo/content/en/methods/shortcode/IsNamedParams.md
Bjørn Erik Pedersen 9b0050e9aa Squashed 'docs/' content from commit 5c085a37b
git-subtree-dir: docs
git-subtree-split: 5c085a37b297bf12f59efeaae591418ec025c10d
2024-01-27 10:48:33 +01:00

833 B

title description categories keywords action
IsNamedParams Reports whether the shortcode call uses named parameters.
related returnType signatures
methods/shortcode/Get
bool
SHORTCODE.IsNamedParams

To support both positional and named parameters when calling a shortcode, use the IsNamedParams method to determine how the shortcode was called.

With this shortcode template:

{{< code file=layouts/shortcodes/myshortcode.html >}} {{ if .IsNamedParams }} {{ printf "%s %s." (.Get "greeting") (.Get "firstName") }} {{ else }} {{ printf "%s %s." (.Get 0) (.Get 1) }} {{ end }} {{< /code >}}

Both of these calls return the same value:

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