HUGO
News Docs Themes Community GitHub

Params

Returns a collection of the shortcode arguments.

Syntax

SHORTCODE.Params

Returns

any

When you call a shortcode using positional arguments, the Params method returns a slice.

content/about.md
{{< myshortcode "Hello" "world" >}}
layouts/shortcodes/myshortcode.html
{{ index .Params 0 }} → Hello
{{ index .Params 1 }} → world

When you call a shortcode using named arguments, the Params method returns a map.

content/about.md
{{< myshortcode greeting="Hello" name="world" >}}
layouts/shortcodes/myshortcode.html
{{ .Params.greeting }} → Hello
{{ .Params.name }} → world