mirror/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2025-08-21 21:35:28 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge commit '5e078383a787e8b5ec3ba73f05ea4130840afbe2'

Browse Source
This commit is contained in:
Bjørn Erik Pedersen
2019-02-01 09:01:04 +01:00
parent ddc6d4e30f 5e078383a7
commit ddc15ed41b
79 changed files with 6251 additions and 391 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
docs/content/en/functions/where.md
View File

@@ -20,10 +20,14 @@ toc: true
needsexample: true
---
`where` filters an array to only the elements containing a matching value for a given field.
`where` filters an array to only the elements containing a matching
value for a given field.
It works in a similar manner to the [`where` keyword in
SQL][wherekeyword].
```go-html-template
{{ range where .Pages "Section" "post" }}
{{ range where .Pages "Section" "foo" }}
{{ .Content }}
{{ end }}
```
@@ -45,7 +49,7 @@ series: golang
It can also be used with the logical operators `!=`, `>=`, `in`, etc. Without an operator, `where` compares a given field with a matching value equivalent to `=`.
```go-html-template
{{ range where .Pages "Section" "!=" "post" }}
{{ range where .Pages "Section" "!=" "foo" }}
{{ .Content }}
{{ end }}
```
@@ -101,10 +105,14 @@ You can also put the returned value of the `where` clauses into a variable:
## Use `where` with `first`
The following grabs the first five content files in `post` using the [default ordering](/templates/lists/) for lists (i.e., `weight => date`):
Using `first` and [`where`][wherefunction] together can be very
powerful. Below snippet gets a list of posts only from [**main
sections**](#mainsections), sorts it using the [default
ordering](/templates/lists/) for lists (i.e., `weight => date`), and
then ranges through only the first 5 posts in that list:
{{< code file="where-with-first.html" >}}
{{ range first 5 (where .Pages "Section" "post") }}
{{< code file="first-and-where-together.html" >}}
{{ range first 5 (where site.RegularPages "Type" "in" site.Params.mainSections) }}
{{ .Content }}
{{ end }}
{{< /code >}}
@@ -134,21 +142,27 @@ Only the following operators are available for `nil`
{{ end }}
```
## Portable `where` filters
## Portable `where` filters -- `site.Params.mainSections` {#mainsections}
This is especially important for themes, but to list the most relevant pages on the front page or similar, you can use `.Site.Params.mainSections` list.
**This is especially important for themes.**
This will, by default, list pages from the _section with the most pages_.
To list the most relevant pages on the front page or similar, you
should use the `site.Params.mainSections` list instead of comparing
section names to hard-coded values like `"posts"` or `"post"`.
```go-html-template
{{ $pages := where .Site.RegularPages "Type" "in" .Site.Params.mainSections }}
{{ $pages := where site.RegularPages "Type" "in" site.Params.mainSections }}
```
If the user has not set this config parameter in their site config, it
will default to the _section with the most pages_.
The user can override the default in `config.toml`:
```toml
[params]
mainSections = ["blog", "docs"]
mainSections = ["blog", "docs"]
```
[intersect]: /functions/intersect/
[wherekeyword]: https://www.techonthenet.com/sql/where.php