hugo/docs/content/en/methods/page/Params.md

---
title: Params
description: Returns a map of custom parameters as defined in the front matter of the given page.
categories: []
keywords: []
action:
  related:
    - functions/collections/IndexFunction
    - methods/site/Params
    - methods/page/Param
  returnType: maps.Params
  signatures: [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]:

```go-html-template
{{ .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:

```go-html-template
{{ index .Params "key-with-hyphens" }} → 2023
```

[`index`]: /functions/collections/indexfunction
[chaining]: /getting-started/glossary/#chain
[identifiers]: /getting-started/glossary/#identifier
Squashed 'docs/' content from commit 5c085a37b git-subtree-dir: docs git-subtree-split: 5c085a37b297bf12f59efeaae591418ec025c10d 2024-01-27 04:48:33 -05:00			`---`
			`title: Params`
			`description: Returns a map of custom parameters as defined in the front matter of the given page.`
			`categories: []`
			`keywords: []`
			`action:`
			`related:`
			`- functions/collections/IndexFunction`
			`- methods/site/Params`
			`- methods/page/Param`
			`returnType: maps.Params`
			`signatures: [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`
Squashed 'docs/' changes from 5c085a37b..a9584e3d1 a9584e3d1 ci: bump GitHub workflow actions to latest versions f37ee374d Fix methods related to time.After a49214057 Correct heading render hook example 4b696f936 Update README.md b5a6e4039 Clean up the contributing section a5d79ed19 Fixed typo: instea → instead 6150a60e3 Remove the "local file templates" page 9395743dc Update/vendor theme 33d8c10cc Remove output format "name" parameter 7200ad97d Add security section to resources.GetRemote page 3f1e056b2 Remove erroneous front matter field 07c9a7e42 Add alpha index to glossary 6619c8aa0 Fix Page.Params example 145a92359 Simplify string concat example in math.Add 42488bb09 Add string concat example to math.Add eb20521a2 Fix flash of unstyled content with mathematical markup 74603bebe Fix typo in 'typesetting' git-subtree-dir: docs git-subtree-split: a9584e3d146c4a194d937a4dc8a37cde5ba1c618 2024-02-07 14:46:41 -05:00			`[author]`
Squashed 'docs/' content from commit 5c085a37b git-subtree-dir: docs git-subtree-split: 5c085a37b297bf12f59efeaae591418ec025c10d 2024-01-27 04:48:33 -05:00			`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]:`

			```go-html-template
			`{{ .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:

			```go-html-template
			`{{ index .Params "key-with-hyphens" }} → 2023`
			```

			[`index`]: /functions/collections/indexfunction
			`[chaining]: /getting-started/glossary/#chain`
			`[identifiers]: /getting-started/glossary/#identifier`