HUGO
News Docs Themes Community GitHub

IsNamedParams

Reports whether the shortcode call uses named arguments.

Syntax

SHORTCODE.IsNamedParams

Returns

bool

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:

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

Both of these calls return the same value:

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