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
  • Content management
    • Overview
    • Organization
    • Page bundles
    • Content formats
    • Diagrams
    • 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
    • Syntax highlighting
    • 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
    • Local file templates
    • Internal templates
    • Render hooks
    • 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
  • Quick reference
    • Overview
    • Emojis
    • Functions
    • Methods
    • Page collections
  • Variables
    • Overview
    • File variables
    • Git variables
    • Menu entry variables
    • Page variables
    • Pages variables
    • Shortcode variables
    • Site variables
    • Taxonomy variables
  • 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
VARIABLES

Pages variables

Use these methods with a collection of Page objects.

We are making an effort to unify our terminology, and to use these terms consistently throughout the documentation.

Historically, we have inconsistently referred to the items on this page as functions, parameters, variables, or methods. They are not functions, parameters, or variables; they are methods.

This page will remain in place as readers become familiar with the unified terminology. See the methods section for a list of methods by object, or the methods quick reference guide.

All methods

Use any of these methods with page collections in your templates.

.ByDate
Returns the given page collection sorted by date in ascending order.
.ByExpiryDate
Returns the given page collection sorted by expiration date in ascending order.
.ByLanguage
Returns the given page collection sorted by language in ascending order.
.ByLastmod
Returns the given page collection sorted by last modification date in ascending order.
.ByLength
Returns the given page collection sorted by content length in ascending order.
.ByLinkTitle
Returns the given page collection sorted by link title in ascending order, falling back to title if link title is not defined.
.ByParam
Returns the given page collection sorted by the given parameter in ascending order.
.ByPublishDate
Returns the given page collection sorted by publish date in ascending order.
.ByTitle
Returns the given page collection sorted by title in ascending order.
.ByWeight
Returns the given page collection sorted by weight in ascending order.
.GroupBy
Returns the given page collection grouped by the given field in ascending order.
.GroupByDate
Returns the given page collection grouped by date in descending order.
.GroupByExpiryDate
Returns the given page collection grouped by expiration date in descending order.
.GroupByLastmod
Returns the given page collection grouped by last modification date in descending order.
.GroupByParam
Returns the given page collection grouped by the given parameter in ascending order.
.GroupByParamDate
Returns the given page collection grouped by the given date parameter in descending order.
.GroupByPublishDate
Returns the given page collection grouped by publish date in descending order.
.Len
Returns the number of pages in the given page collection.
.Limit
Returns the first N pages from the given page collection.
.Next
Returns the next page in a local page collection, relative to the given page.
.Prev
Returns the previous page in a local page collection, relative to the given page.
.Related
Returns a collection of pages related to the given page.
.Reverse
Returns the given page collection in reverse order.

Sort by

Use these methods to sort page collections.

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

Group by

Use these methods to group page collections.

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

Navigation

Use these methods to create navigation links between pages.

.Next
Returns the next page in a local page collection, relative to the given page.
.Prev
Returns the previous page in a local page collection, relative to the given page.

See also

  • Page variables
  • Site variables

On this page

  • All methods
  • Sort by
  • Group by
  • Navigation
Last updated: November 4, 2023: Miscellaneous updates (80b2241f)
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
  • Content management
  • Templates
  • Functions
  • Methods
  • Quick reference
  • Variables
  • Hugo Modules
  • Hugo Pipes
  • CLI
  • Troubleshooting
  • Developer tools
  • Hosting and deployment
  • Contribute
  • Maintenance