hugo/docs/content/en/methods/shortcode/IsNamedParams.md
2024-06-21 09:41:24 +02:00

831 B

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

To support both positional and named arguments 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 >}}