hugo/content/en/functions/strings/ReplaceRE.md
Bjørn Erik Pedersen 9b0050e9aa Squashed 'docs/' content from commit 5c085a37b
git-subtree-dir: docs
git-subtree-split: 5c085a37b297bf12f59efeaae591418ec025c10d
2024-01-27 10:48:33 +01:00

1.3 KiB

title description categories keywords action aliases
strings.ReplaceRE Returns a copy of INPUT, replacing all occurrences of a regular expression with a replacement pattern.
aliases related returnType signatures
replaceRE
functions/strings/FindRE
functions/strings/FindRESubmatch
functions/strings/Replace
string
strings.ReplaceRE PATTERN REPLACEMENT INPUT [LIMIT]
/functions/replacere

{{% include "functions/_common/regular-expressions.md" %}}

{{ $s := "a-b--c---d" }}
{{ replaceRE `(-{2,})` "-" $s }} → a-b-c-d

Limit the number of replacements using the LIMIT argument:

{{ $s := "a-b--c---d" }}
{{ replaceRE `(-{2,})` "-" $s 1 }} → a-b-c---d

Use $1, $2, etc. within the replacement string to insert the content of each capturing group 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 %}}