TheCloud/hugoDocs
1
0
Fork 0
mirror of https://github.com/gohugoio/hugoDocs.git synced 2025-09-16 19:07:46 -04:00
Code Issues Packages Projects Releases Wiki Activity

Clarify the append function

Browse Source
This commit is contained in:
Joe Mooring 2023-08-25 12:43:32 -07:00 committed by GitHub
parent a135e52a02
commit a5dc978454
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 75 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

88
content/en/functions/append.md
View File

@ -1,37 +1,99 @@
--- ---
title: append title: append
description: "`append` appends one or more values to a slice and returns the resulting slice." description: Appends one or more elements to a slice and returns the resulting slice.
categories: [functions] categories: [functions]
menu: menu:
docs: docs:
parent: functions parent: functions
keywords: [collections] keywords: [collections]
signature: ["COLLECTION | append VALUE [VALUE]...", "COLLECTION | append COLLECTION"] signature: ["COLLECTION | append ELEMENT [ELEMENT]...", "COLLECTION | append COLLECTION"]
relatedfuncs: [last,first,where,slice] relatedfuncs: [last,first,where,slice]
--- ---
An example appending single values: This function appends all elements, excluding the last, to the last element. This allows [pipe](/getting-started/glossary/#pipeline) constructs as shown below.
Append a single element to a slice:
```go-html-template ```go-html-template
{{ $s := slice "a" "b" "c" }} {{ $s := slice "a" "b" }}
{{ $s = $s | append "d" "e" }} {{ $s }} → [a b]
{{/* $s now contains a []string with elements "a", "b", "c", "d", and "e" */}}
{{ $s = $s | append "c" }}
{{ $s }} → [a b c]
``` ```
The same example appending a slice to a slice: Append two elements to a slice:
```go-html-template ```go-html-template
{{ $s := slice "a" "b" "c" }} {{ $s := slice "a" "b" }}
{{ $s }} → [a b]
{{ $s = $s | append "c" "d" }}
{{ $s }} → [a b c d]
```
Append two elements, as a slice, to a slice. This produces the same result as the previous example:
```go-html-template
{{ $s := slice "a" "b" }}
{{ $s }} → [a b]
{{ $s = $s | append (slice "c" "d") }}
{{ $s }} → [a b c d]
```
Start with an empty slice:
```go-html-template
{{ $s := slice }}
{{ $s }} → []
{{ $s = $s | append "a" }}
{{ $s }} → [a]
{{ $s = $s | append "b" "c" }}
{{ $s }} → [a b c]
{{ $s = $s | append (slice "d" "e") }} {{ $s = $s | append (slice "d" "e") }}
{{ $s }} → [a b c d e]
``` ```
If a slice contains other slices, further slices will be appended as values: If you start with a slice of a slice:
```go-html-template ```go-html-template
{{ $s := slice (slice "a" "b") (slice "c" "d") }} {{ $s := slice (slice "a" "b") }}
{{ $s = $s | append (slice "e" "f") (slice "g" "h") }} {{ $s }} → [[a b]]
{{/* $s now contains a [][]string containing four slices: ["a" "b"], ["c" "d"], ["e" "f"], and ["g" "h"] */}}
{{ $s = $s | append (slice "c" "d") }}
{{ $s }} → [[a b] [c d]]
``` ```
The `append` function works for all types, including `Pages`. To create a slice of slices, starting with an empty slice:
```go-html-template
{{ $s := slice }}
{{ $s }} → []
{{ $s = $s | append (slice (slice "a" "b")) }}
{{ $s }} → [[a b]]
{{ $s = $s | append (slice "c" "d") }}
{{ $s }} → [[a b] [c d]]
```
Although the elements in the examples above are strings, you can use the `append` function with any data type, include Pages. For example, on the home page of a corporate site, to display links to the two most recent press releases followed by links to the four most recent articles:
```go-html-template
{{ $p := where site.RegularPages "Type" "press-releases" | first 2 }}
{{ $p = $p | append (where site.RegularPages "Type" "articles" | first 4) }}
{{ with $p }}
<ul>
{{ range $p }}
<li><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></li>
{{ end }}
</ul>
{{ end }}
```