HUGO
News Docs Themes Community GitHub

ByParam

Returns the given page collection sorted by the given parameter in ascending order.

Syntax

PAGES.ByParam PARAM

Returns

page.Pages

If the given parameter is not present in front matter, Hugo will use the matching parameter in your site configuration if present.

{{ range .Pages.ByParam "author" }}
  <h2><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></h2>
{{ end }}

To sort in descending order:

{{ range (.Pages.ByParam "author").Reverse }}
  <h2><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></h2>
{{ end }}

If the targeted parameter is nested, access the field using dot notation:

{{ range .Pages.ByParam "author.last_name" }}
  <h2><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></h2>
{{ end }}