2019-10-21 04:22:28 -04:00
---
2023-10-20 03:42:39 -04:00
title: collections.Sort
2023-05-22 10:43:12 -04:00
description: Sorts slices, maps, and page collections.
2023-12-04 09:14:18 -05:00
categories: []
2023-10-20 03:42:39 -04:00
keywords: []
2023-12-04 09:14:18 -05:00
action:
2023-10-20 03:42:39 -04:00
aliases: [sort]
returnType: any
signatures: ['collections.Sort COLLECTION [KEY] [ORDER]']
2023-12-04 09:14:18 -05:00
related:
2023-10-20 03:42:39 -04:00
- collections.Reverse
- collections.Shuffle
- collections.Sort
- collections.Uniq
aliases: [/functions/sort]
2019-10-21 04:22:28 -04:00
---
2023-05-22 10:43:12 -04:00
The `KEY` is optional when sorting slices in ascending order, otherwise it is required. When sorting slices, use the literal `value` in place of the `KEY` . See examples below.
2019-10-21 04:22:28 -04:00
2023-05-22 10:43:12 -04:00
The `ORDER` may be either `asc` (ascending) or `desc` (descending). The default sort order is ascending.
## Sort a slice
The examples below assume this site configuration:
2023-12-04 09:14:18 -05:00
{{< code-toggle file = hugo > }}
2023-05-22 10:43:12 -04:00
[params]
grades = ['b','a','c']
{{< / code-toggle > }}
### Ascending order {#slice-ascending-order}
Sort slice elements in ascending order using either of these constructs:
2023-12-04 09:14:18 -05:00
```go-html-template
2023-05-22 10:43:12 -04:00
{{ sort site.Params.grades }} → [a b c]
{{ sort site.Params.grades "value" "asc" }} → [a b c]
2023-12-04 09:14:18 -05:00
```
2023-05-22 10:43:12 -04:00
In the examples above, `value` is the `KEY` representing the value of the slice element.
### Descending order {#slice-descending-order}
Sort slice elements in descending order:
2023-12-04 09:14:18 -05:00
```go-html-template
2023-05-22 10:43:12 -04:00
{{ sort site.Params.grades "value" "desc" }} → [c b a]
2023-12-04 09:14:18 -05:00
```
2023-05-22 10:43:12 -04:00
In the example above, `value` is the `KEY` representing the value of the slice element.
2019-10-21 04:22:28 -04:00
2023-05-22 10:43:12 -04:00
## Sort a map
The examples below assume this site configuration:
2023-12-04 09:14:18 -05:00
{{< code-toggle file = hugo > }}
2023-05-22 10:43:12 -04:00
[params.authors.a]
firstName = "Marius"
lastName = "Pontmercy"
[params.authors.b]
firstName = "Victor"
lastName = "Hugo"
[params.authors.c]
firstName = "Jean"
lastName = "Valjean"
{{< / code-toggle > }}
{{% note %}}
When sorting maps, the `KEY` argument must be lowercase.
{{% /note %}}
### Ascending order {#map-ascending-order}
Sort map objects in ascending order using either of these constructs:
2023-12-04 09:14:18 -05:00
```go-html-template
2023-05-22 10:43:12 -04:00
{{ range sort site.Params.authors "firstname" }}
{{ .firstName }}
{{ end }}
{{ range sort site.Params.authors "firstname" "asc" }}
{{ .firstName }}
{{ end }}
2023-12-04 09:14:18 -05:00
```
2023-05-22 10:43:12 -04:00
These produce:
```text
Jean Marius Victor
2019-10-21 04:22:28 -04:00
```
2023-05-22 10:43:12 -04:00
### Descending order {#map-descending-order}
Sort map objects in descending order:
2023-12-04 09:14:18 -05:00
```go-html-template
2023-05-22 10:43:12 -04:00
{{ range sort site.Params.authors "firstname" "desc" }}
{{ .firstName }}
{{ end }}
2023-12-04 09:14:18 -05:00
```
2023-05-22 10:43:12 -04:00
This produces:
```text
Victor Marius Jean
2019-10-21 04:22:28 -04:00
```
2023-05-22 10:43:12 -04:00
## Sort a page collection
2019-10-21 04:22:28 -04:00
2023-12-04 09:14:18 -05:00
{{% note %}}
Although you can use the `sort` function to sort a page collection, Hugo provides [sorting and grouping methods] as well.
2019-10-21 04:22:28 -04:00
2023-12-04 09:14:18 -05:00
[sorting and grouping methods]: /methods/pages
{{% /note %}}
2019-10-21 04:22:28 -04:00
2023-05-22 10:43:12 -04:00
In this contrived example, sort the site's regular pages by `.Type` in descending order:
2019-10-21 04:22:28 -04:00
2023-12-04 09:14:18 -05:00
```go-html-template
2023-05-22 10:43:12 -04:00
{{ range sort site.RegularPages "Type" "desc" }}
2023-12-04 09:14:18 -05:00
< h2 > < a href = "{{ .RelPermalink }}" > {{ .LinkTitle }}< / a > < / h2 >
2023-05-22 10:43:12 -04:00
{{ end }}
2023-12-04 09:14:18 -05:00
```