hugo/docs/content/en/methods/page/Params.md
2024-02-07 20:46:41 +01:00

1.2 KiB

title description categories keywords action
Params Returns a map of custom parameters as defined in the front matter of the given page.
related returnType signatures
functions/collections/IndexFunction
methods/site/Params
methods/page/Param
maps.Params
PAGE.Params

With this front matter:

{{< code-toggle file=content/news/annual-conference.md >}} title = 'Annual conference' date = 2023-10-17T15:11:37-07:00 display_related = true [author] email = 'jsmith@example.org' name = 'John Smith' {{< /code-toggle >}}

The title and date fields are standard parameters---the other fields are user-defined.

Access the custom parameters by chaining the identifiers:

{{ .Params.display_related }} → true
{{ .Params.author.name }} → John Smith

In the template example above, each of the keys is a valid identifier. For example, none of the keys contains a hyphen. To access a key that is not a valid identifier, use the index function:

{{ index .Params "key-with-hyphens" }} → 2023