1.7 KiB
| title | description | categories | menu | keywords | signature | relatedfuncs | aliases | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| replaceRE | Returns a string, replacing all occurrences of a regular expression with a replacement pattern. |
|
|
|
|
|
By default, the replaceRE function replaces all matches. You can limit the number of matches with an optional LIMIT paramater.
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.
The syntax of the regular expression is the same general syntax used by Perl, Python, and other languages. More precisely, it is the syntax accepted by RE2 except for \C.
This example replaces two or more consecutive hyphens with a single hyphen:
{{ $s := "a-b--c---d" }}
{{ replaceRE `(-{2,})` "-" $s }} → a-b-c-d
To limit the number of replacements to one:
{{ $s := "a-b--c---d" }}
{{ replaceRE `(-{2,})` "-" $s 1 }} → a-b-c---d
You can use $1, $2, etc. within the replacement string to insert the groups captured within the regular expression:
{{ $s := "http://gohugo.io/docs" }}
{{ replaceRE "^https?://([^/]+).*" "$1" $s }} → gohugo.io
{{% note %}} You can write and test your regular expression using regex101.com. Be sure to select the Go flavor before you begin. {{% /note %}}