---
name: "Regex.replace"
section: "3kaya"
platform: "linux"
package: "kaya"
version: "0.4.4-6.2"
release: "Debian 8 (Jessie)"
platforms: ["linux"]
url: "https://new.carta.tech/Regex.replace"
---

# Regex.replace(3kaya)

Replace a compiled pattern with a string.

## NAME

Regex::replace - Replace a compiled pattern with a string.

## SYNOPSIS

**Void replace(** *Regex keyre, String new, var String str, \[ReplaceFlags\] fl=createArray(1)* **)**

## ARGUMENTS

**keyre** A compiled regular expression

**new** The string to replace matches with

**str** The string to search for matches (will be edited in place).

**fl** A list of **Regex.ReplaceFlags (3kaya)** options. This parameter may be omitted and defaults to the empty list.

## DESCRIPTION

Replace the first match (or all matches if **fl**  contains **Global**  ) of **key**  with **new**  in the String **str**

**new**  may contain back references into the pattern, $1, $2, etc, which stand for sub-matches.

## AUTHORS

Kaya standard library by Edwin Brady, Chris Morris and others (kaya@kayalang.org). For further information see http://kayalang.org/

## LICENSE

The Kaya standard library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License (version 2.1 or any later version) as published by the Free Software Foundation.

## RELATED

**Regex.compile (3kaya)**

**Regex.replace\_1 (3kaya)**