mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
aa5ac36a3e
39a7fac34 Add .hugo_build.lock to .gitignore 920c716a4 fix a typo: to -> two (#1545) 6f0ba9593 Remove godocref from front matter (#1543) 8ec3d5948 remove link to wercker (#1544) b56008719 Delete deployment-with-wercker.md (#1542) e33d29b02 Fix broken links (#1538) 29e9d4c21 Sort commenting systems (#1541) 0b7ea60a7 Delete the news page "HTTP/2 Server Push in Hugo" 6e1515857 Fix quick-start.md (#1525) 62168ab35 Update comments.md (#1535) d92191512 Small typo (#1539) 129c8834a Correct the PostCSS noMap default value (#1534) 6a5b29fcc Add example to index function (#1536) e3dd8c507 Update output-formats.md 0c9321ca0 Remove reference to using LiveReload in production environment 4072d6776 Mod testing 09fabf7d6 Fix typo (#1524) 2fce813c8 Fix grammatical error in quick-start.md (#1523) 45230ab4a Hugo Mod testing 2dd4cd9e7 Update index.md 2c3ed62fd netlify: Bump to 0.88.1 648e2a007 Merge branch 'tempv0.88.1' f216eade1 releaser: Add release notes to /docs for release of 0.88.1 8a7b64d4b Fix typographical errors in 0.88.0 release notes a4bf86300 Release 0.88 738bb8f38 releaser: Add release notes to /docs for release of 0.88.0 8fcf2c55d highlight: Remove some pygments references f2b173de2 HTTPS link c88881c8e Adding link to nginx documentation 6b0a74fe0 Fix typos in docs (#1516) 498b8f0f1 Fix typos in time.Format (#1515) 28723fad6 Fix taxonomy and term examples (#1514) 3ffd00e12 Update front-matter.md 7cc1da82e Fix grammar in 0.86.1 release notes (#1510) 0009c51c3 Update docs helper 7e2f430f4 Update index.md 7857eae7e releaser: Add release notes to /docs for release of 0.87.0 1f08b684b releaser: Add release notes to /docs for release of 0.87.0 36a9e701c docs: Adjust config docs 0f588438e docs: Regen CLI docs 1b4682cd8 docs: Regen docs helper bc8bbaae9 Merge commit 'bd77f6e1c99e04a476f0b1bb4e44569134e02399' into release-0.87.0 6f2480643 docs: Adjust time zone docs git-subtree-dir: docs git-subtree-split: 39a7fac343c289906db644c96079fdcc0298582f
118 lines
4.2 KiB
Markdown
118 lines
4.2 KiB
Markdown
---
|
||
title: apply
|
||
description: Given a map, array, or slice, `apply` returns a new slice with a function applied over it.
|
||
date: 2017-02-01
|
||
publishdate: 2017-02-01
|
||
lastmod: 2017-02-01
|
||
categories: [functions]
|
||
menu:
|
||
docs:
|
||
parent: "functions"
|
||
keywords: [advanced]
|
||
signature: ["apply COLLECTION FUNCTION [PARAM...]"]
|
||
workson: []
|
||
hugoversion:
|
||
relatedfuncs: []
|
||
deprecated: false
|
||
draft: false
|
||
aliases: []
|
||
---
|
||
|
||
{{< todo >}}
|
||
POTENTIAL NEW CONTENT: see apply/sequence discussion: https://discourse.gohugo.io/t/apply-printf-on-a-sequence/5722;
|
||
{{< /todo >}}
|
||
|
||
`apply` expects at least three parameters, depending on the function being applied.
|
||
|
||
1. The first parameter is the sequence to operate on.
|
||
2. The second parameter is the name of the function as a string, which must be the name of a valid [Hugo function][functions].
|
||
3. After that, the parameters to the applied function are provided, with the string `"."` standing in for each element of the sequence the function is to be applied against.
|
||
|
||
Here is an example of a content file with `names:` as a front matter field:
|
||
|
||
```
|
||
+++
|
||
names: [ "Derek Perkins", "Joe Bergevin", "Tanner Linsley" ]
|
||
+++
|
||
```
|
||
|
||
You can then use `apply` as follows:
|
||
|
||
```
|
||
{{ apply .Params.names "urlize" "." }}
|
||
```
|
||
|
||
Which will result in the following:
|
||
|
||
```
|
||
"derek-perkins", "joe-bergevin", "tanner-linsley"
|
||
```
|
||
|
||
This is *roughly* equivalent to using the following with [range][]:
|
||
|
||
```
|
||
{{ range .Params.names }}{{ . | urlize }}{{ end }}
|
||
```
|
||
|
||
However, it is not possible to provide the output of a range to the [`delimit` function][delimit], so you need to `apply` it.
|
||
|
||
If you have `post-tag-list.html` and `post-tag-link.html` as [partials][], you *could* use the following snippets, respectively:
|
||
|
||
{{< code file="layouts/partials/post-tag-list.html" copy="false" >}}
|
||
{{ with .Params.tags }}
|
||
<div class="tags-list">
|
||
Tags:
|
||
{{ $len := len . }}
|
||
{{ if eq $len 1 }}
|
||
{{ partial "post-tag-link" (index . 0) }}
|
||
{{ else }}
|
||
{{ $last := sub $len 1 }}
|
||
{{ range first $last . }}
|
||
{{ partial "post-tag-link" . }},
|
||
{{ end }}
|
||
{{ partial "post-tag-link" (index . $last) }}
|
||
{{ end }}
|
||
</div>
|
||
{{ end }}
|
||
{{< /code >}}
|
||
|
||
{{< code file="layouts/partials/post-tag-link.html" copy="false" >}}
|
||
<a class="post-tag post-tag-{{ . | urlize }}" href="/tags/{{ . | urlize }}">{{ . }}</a>
|
||
{{< /code >}}
|
||
|
||
This works, but the complexity of `post-tag-list.html` is fairly high. The Hugo template needs to perform special behavior for the case where there’s only one tag, and it has to treat the last tag as special. Additionally, the tag list will be rendered something like `Tags: tag1 , tag2 , tag3` because of the way that the HTML is generated and then interpreted by a browser.
|
||
|
||
This first version of `layouts/partials/post-tag-list.html` separates all of the operations for ease of reading. The combined and DRYer version is shown next:
|
||
|
||
```
|
||
{{ with .Params.tags }}
|
||
<div class="tags-list">
|
||
Tags:
|
||
{{ $sort := sort . }}
|
||
{{ $links := apply $sort "partial" "post-tag-link" "." }}
|
||
{{ $clean := apply $links "chomp" "." }}
|
||
{{ delimit $clean ", " }}
|
||
</div>
|
||
{{ end }}
|
||
```
|
||
|
||
Now in the completed version, you can sort the tags, convert the tags to links with `layouts/partials/post-tag-link.html`, [chomp][] off stray newlines, and join the tags together in a delimited list for presentation. Here is an even DRYer version of the preceding example:
|
||
|
||
{{< code file="layouts/partials/post-tag-list.html" download="post-tag-list.html" >}}
|
||
{{ with .Params.tags }}
|
||
<div class="tags-list">
|
||
Tags:
|
||
{{ delimit (apply (apply (sort .) "partial" "post-tag-link" ".") "chomp" ".") ", " }}
|
||
</div>
|
||
{{ end }}
|
||
{{< /code >}}
|
||
|
||
{{% note %}}
|
||
`apply` does not work when receiving the sequence as an argument through a pipeline.
|
||
{{% /note %}}
|
||
|
||
[chomp]: /functions/chomp/ "See documentation for the chomp function"
|
||
[delimit]: /functions/delimit/ "See documentation for the delimit function"
|
||
[functions]: /functions/ "See the full list of Hugo functions to see what can be passed as an argument to the apply function."
|
||
[partials]: /templates/partials/
|
||
[range]: /functions/range/ "Learn the importance of the range function, a fundamental keyword in both Hugo templates and the Go programming language."
|