hugo/docs/content/en/methods/_common/next-prev-on-page-vs-next-prev-on-pages.md
Bjørn Erik Pedersen 5fd1e74903
Merge commit '9b0050e9aabe4be65c78ccf292a348f309d50ccd' as 'docs'
```
git subtree add --prefix=docs/ https://github.com/gohugoio/hugoDocs.git master --squash
```

Closes #11925
2024-01-27 10:48:57 +01:00

1.6 KiB

The Next and Prev methods on a Pages object are more flexible than the Next and Prev methods on a Page object.

Page collection Custom sort order
PAGES.Next and PAGES.Prev locally defined ✔️
PAGE.Next and PAGE.Prev globally defined
locally defined
Build the page collection every time you call PAGES.Next and PAGES.Prev. Navigation between pages is relative to the current page's position within the local collection, independent of the global collection.

With a local collection, the navigation sort order is the same as the collection sort order.

globally defined
Build the page collection once, on a list page. Navigation between pages is relative to the current page's position within the global collection.

With a global collection, the navigation sort order is fixed, using Hugo's default sort order. In order of precedence:

  1. Page weight
  2. Page date (descending)
  3. Page linkTitle, falling back to page title
  4. Page file path if the page is backed by a file

For example, with a global collection sorted by title, the navigation sort order will use Hugo's default sort order. This is probably not what you want or expect. For this reason, the Next and Prev methods on a Pages object are generally a better choice.