47 lines
1.3 KiB
Plaintext
47 lines
1.3 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: regex_replace - Functions - Configuration Language
|
|
sidebar_title: regex_replace
|
|
description: |-
|
|
The regex_replace function searches a given string for another given substring,
|
|
and replaces all occurrences with a given replacement string. The substring
|
|
argument can be a valid regular expression or a string.
|
|
---
|
|
|
|
# `regex_replace` Function
|
|
|
|
`regex_replace` searches a given string for another given substring, and
|
|
replaces each occurrence with a given replacement string. The substring
|
|
argument can be a valid regular expression or a string.
|
|
|
|
```hcl
|
|
regex_replace(string, substring, replacement)
|
|
```
|
|
|
|
`substring` should not be wrapped in forward slashes, it is always treated as a
|
|
regular expression. The `replacement` string can incorporate captured strings
|
|
from the input by using an `$n` or `${n}` sequence, where `n` is the index or
|
|
name of a capture group.
|
|
|
|
## Examples
|
|
|
|
```shell-session
|
|
> regex_replace("hello world", "world", "everybody")
|
|
hello everybody
|
|
|
|
|
|
> regex_replace("hello world", "w.*d", "everybody")
|
|
hello everybody
|
|
|
|
> regex_replace("-ab-axxb-", "a(x*)b", "$1W)
|
|
---
|
|
|
|
> regex_replace("-ab-axxb-", "a(x*)b", "${1}W")
|
|
-W-xxW-
|
|
```
|
|
|
|
## Related Functions
|
|
|
|
- [`replace`](/docs/from-1.5/functions/string/replace) searches a given string for another given
|
|
substring, and replaces all occurrences with a given replacement string.
|