Debian Codegraph @

docs/content/en/methods/pages/ByLanguage.md

raw
1 ---
2 title: ByLanguage
3 description: Returns the given page collection sorted by language.
4 categories: []
5 keywords: []
6 params:
7 functions_and_methods:
8 returnType: page.Pages
9 signatures: [PAGES.ByLanguage]
10 ---
11
12 When sorting by language, Hugo orders the page collection using the following priority:
13
14 1. Language weight (ascending)
15 1. Date (descending)
16 1. LinkTitle (ascending)
17
18 This method is rarely, if ever, needed. Page collections that already contain multiple languages, such as those returned by the [`Rotate`][], [`Translations`][], or [`AllTranslations`][] methods on a `Page` object, are already sorted by language weight.
19
20 This contrived example aggregates pages from all sites and then sorts them by language:
21
22 ```go-html-template
23 {{ $p := slice }}
24 {{ range hugo.Sites }}
25 {{ range .Pages }}
26 {{ $p = $p | append . }}
27 {{ end }}
28 {{ end }}
29
30 {{ range $p.ByLanguage }}
31 <h2><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></h2>
32 {{ end }}
33 ```
34
35 To sort in descending order:
36
37 ```go-html-template
38 {{ range $p.ByLanguage.Reverse }}
39 <h2><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></h2>
40 {{ end }}
41 ```
42
43 [`AllTranslations`]: /methods/page/alltranslations/
44 [`Rotate`]: /methods/page/rotate/
45 [`Translations`]: /methods/page/translations/