Skip to content

Commit

Permalink
docs: Update where function operators
Browse files Browse the repository at this point in the history
Related to #11281
  • Loading branch information
jmooring authored and bep committed Jul 29, 2023
1 parent a50356b commit 036e260
Showing 1 changed file with 29 additions and 1 deletion.
30 changes: 29 additions & 1 deletion docs/content/en/functions/where.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,14 +73,16 @@ The following logical operators are available with `where`:
`intersect`
: `true` if a given field value that is a slice/array of strings or integers contains elements in common with the matching value; it follows the same rules as the [`intersect` function][intersect].

`like`
: `true` if a given field value matches a regular expression. Use the `like` operator to compare `string` values. Returns `false` when comparing other data types to the regular expression.

## Use `where` with boolean values
When using booleans you should not put quotation marks.
```go-html-template
{{ range where .Pages "Draft" true }}
<p>{{ .Title }}</p>
{{ end }}
```


## Use `where` with `intersect`

Expand All @@ -102,6 +104,32 @@ You can also put the returned value of the `where` clauses into a variable:
{{ end }}
{{< /code >}}

## Use `where` with `like`

This example matches pages where the "foo" parameter begins with "ab":

```go-html-template
{{ range where site.RegularPages "Params.foo" "like" "^ab" }}
<h2><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></h2>
{{ end }}
```

When specifying the regular expression, use a raw [string literal] (backticks) instead of an interpreted string literal (double quotes) to simplify the syntax. With an interpreted string literal you must escape backslashes.

[string literal]: https://go.dev/ref/spec#String_literals

This function uses the [RE2] regular expression library. See the [RE2 syntax documentation] for details. Note that the RE2 `\C` escape sequence is not supported.

[RE2]: https://github.com/google/re2/
[RE2 syntax documentation]: https://github.com/google/re2/wiki/Syntax/

{{% note %}}
The RE2 syntax is a subset of that accepted by [PCRE], roughly speaking, and with various [caveats].

[caveats]: https://swtch.com/~rsc/regexp/regexp3.html#caveats
[PCRE]: https://www.pcre.org/
{{% /note %}}

## Use `where` with `first`

Using `first` and `where` together can be very
Expand Down

0 comments on commit 036e260

Please sign in to comment.