HUGO

  • News
  • Docs
  • Themes
  • Showcase
  • Community
  • GitHub
gohugoio Star
  • About Hugo
    • Overview
    • What is Hugo
    • Hugo features
    • Static site generators
    • Hugo's security model
    • Hugo and the GDPR
    • License
  • Installation
    • Overview
    • macOS
    • Linux
    • Windows
    • BSD
  • Getting started
    • Overview
    • Quick start
    • Basic usage
    • Directory structure
    • Configuration
    • Configure markup
    • Glossary of terms
    • External learning resources
  • Quick reference
    • Overview
    • Emojis
    • Functions
    • Methods
    • Page collections
  • Content management
    • Overview
    • Organization
    • Page bundles
    • Content formats
    • Front matter
    • Build options
    • Page resources
    • Image processing
    • Shortcodes
    • Related content
    • Sections
    • Content types
    • Archetypes
    • Taxonomies
    • Summaries
    • Links and cross references
    • URL management
    • Menus
    • Static files
    • Table of contents
    • Comments
    • Multilingual
    • Markdown attributes
    • Syntax highlighting
    • Diagrams
    • Mathematics
  • Templates
    • Overview
    • Templating
    • Template lookup order
    • Base templates and blocks
    • Single page templates
    • List templates
    • Homepage template
    • Section templates
    • Taxonomy templates
    • Pagination
    • Content view templates
    • Partial templates
    • Shortcode templates
    • Menu templates
    • Data templates
    • RSS templates
    • Sitemap templates
    • Internal templates
    • Custom output formats
    • 404 page
    • Robots.txt
  • Functions
    • Overview
    • cast
    • collections
    • compare
    • crypto
    • data
    • debug
    • diagrams
    • encoding
    • fmt
    • global
    • go template
    • hugo
    • images
    • inflect
    • js
    • lang
    • math
    • openapi3
    • os
    • partials
    • path
    • reflect
    • resources
    • safe
    • strings
    • templates
    • time
    • transform
    • urls
  • Methods
    • Overview
    • Duration
    • Menu
    • Menu entry
    • Page
    • Pages
    • Resource
    • Shortcode
    • Site
    • Taxonomy
    • Time
  • Render hooks
    • Overview
    • Introduction
    • Code blocks
    • Headings
    • Images
    • Links
  • Hugo Modules
    • Overview
    • Configure Hugo modules
    • Use Hugo Modules
    • Theme components
  • Hugo Pipes
    • Overview
    • Introduction
    • Transpile Sass to CSS
    • PostCSS
    • PostProcess
    • JavaScript building
    • Babel
    • Asset minification
    • Concatenating assets
    • Fingerprinting and SRI hashing
    • Resource from string
    • Resource from template
  • CLI
  • Troubleshooting
    • Overview
    • Audit
    • Logging
    • Inspection
    • Deprecation
    • Performance
    • FAQs
  • Developer tools
    • Overview
    • Editor plugins
    • Front-ends
    • Search
    • Migrations
    • Other projects
  • Hosting and deployment
    • Overview
    • Hugo Deploy
    • Deploy with Rclone
    • Deploy with Rsync
    • Host on 21YunBox
    • Host on AWS Amplify
    • Host on Azure Static Web Apps
    • Host on Cloudflare Pages
    • Host on Firebase
    • Host on GitHub Pages
    • Host on GitLab Pages
    • Host on KeyCDN
    • Host on Netlify
    • Host on Render
  • Contribute
    • Overview
    • Development
    • Documentation
    • Themes
  • Maintenance
QUICK REFERENCE

Page collections

A quick reference guide to Hugo’s page collections.

Page

Use these Page methods when rendering lists on section pages, taxonomy pages, term pages, and the home page.

PAGE.Pages
Returns a collection of regular pages within the current section, and section pages of immediate descendant sections.
PAGE.RegularPages
Returns a collection of regular pages within the current section.
PAGE.RegularPagesRecursive
Returns a collection of regular pages within the current section, and regular pages within all descendant sections.
PAGE.Sections
Returns a collection of section pages, one for each immediate descendant section of the given page.

Site

Use these Site methods when rendering lists on any page.

SITE.Pages
Returns a collection of all pages.
SITE.RegularPages
Returns a collection of all regular pages.
SITE.Sections
Returns a collection of first level section pages.

Filter

Use the where function to filter page collections.

Sort

Use these methods to sort page collections.

PAGES.ByDate
Returns the given page collection sorted by date in ascending order.
PAGES.ByExpiryDate
Returns the given page collection sorted by expiration date in ascending order.
PAGES.ByLanguage
Returns the given page collection sorted by language in ascending order.
PAGES.ByLastmod
Returns the given page collection sorted by last modification date in ascending order.
PAGES.ByLength
Returns the given page collection sorted by content length in ascending order.
PAGES.ByLinkTitle
Returns the given page collection sorted by link title in ascending order, falling back to title if link title is not defined.
PAGES.ByParam
Returns the given page collection sorted by the given parameter in ascending order.
PAGES.ByPublishDate
Returns the given page collection sorted by publish date in ascending order.
PAGES.ByTitle
Returns the given page collection sorted by title in ascending order.
PAGES.ByWeight
Returns the given page collection sorted by weight in ascending order.
PAGES.Reverse
Returns the given page collection in reverse order.

Group

Use these methods to group page collections.

PAGES.GroupBy
Returns the given page collection grouped by the given field in ascending order.
PAGES.GroupByDate
Returns the given page collection grouped by date in descending order.
PAGES.GroupByExpiryDate
Returns the given page collection grouped by expiration date in descending order.
PAGES.GroupByLastmod
Returns the given page collection grouped by last modification date in descending order.
PAGES.GroupByParam
Returns the given page collection grouped by the given parameter in ascending order.
PAGES.GroupByParamDate
Returns the given page collection grouped by the given date parameter in descending order.
PAGES.GroupByPublishDate
Returns the given page collection grouped by publish date in descending order.
PAGES.Reverse
Returns the given page collection in reverse order.

See also

  • Methods
  • Code block render hooks
  • Heading render hooks
  • Image processing
  • Image render hooks

On this page

  • Page
  • Site
  • Filter
  • Sort
  • Group
Last updated: February 3, 2024: Replace links to variable pages with links to method pages (126c323d)
Improve this page
By the Hugo Authors
Hugo Logo
  • File an Issue
  • Get Help
  • @GoHugoIO
  • @spf13
  • @bepsays

Netlify badge

 

Hugo Sponsors

 

The Hugo logos are copyright © Steve Francia 2013–2024.

The Hugo Gopher is based on an original work by Renée French.

  • News
  • Docs
  • Themes
  • Showcase
  • Community
  • GitHub
  • About Hugo
  • Installation
  • Getting started
  • Quick reference
  • Content management
  • Templates
  • Functions
  • Methods
  • Render hooks
  • Hugo Modules
  • Hugo Pipes
  • CLI
  • Troubleshooting
  • Developer tools
  • Hosting and deployment
  • Contribute
  • Maintenance