<!--
{
  "availability" : [
    "iOS: 2.0.0 -",
    "iPadOS: 2.0.0 -",
    "macCatalyst: 13.0.0 -",
    "macOS: 10.0.0 -",
    "tvOS: 9.0.0 -",
    "visionOS: 1.0.0 -",
    "watchOS: 2.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "Foundation",
  "identifier" : "/documentation/Foundation/NSRegularExpression/stringByReplacingMatches(in:options:range:withTemplate:)",
  "metadataVersion" : "0.1.0",
  "role" : "Instance Method",
  "symbol" : {
    "kind" : "Instance Method",
    "modules" : [
      "Foundation"
    ],
    "preciseIdentifier" : "c:objc(cs)NSRegularExpression(im)stringByReplacingMatchesInString:options:range:withTemplate:"
  },
  "title" : "stringByReplacingMatches(in:options:range:withTemplate:)"
}
-->

# stringByReplacingMatches(in:options:range:withTemplate:)

Returns a new string containing matching regular expressions replaced with the template string.

```
func stringByReplacingMatches(in string: String, options: NSRegularExpression.MatchingOptions = [], range: NSRange, withTemplate templ: String) -> String
```

## Parameters

`string`

The string to search for values within.

`options`

The matching options to use. See [`NSRegularExpression.MatchingOptions`](/documentation/Foundation/NSRegularExpression/MatchingOptions) for possible values.

`range`

The range of the string to search.

`templ`

The substitution template used when replacing matching instances.

## Return Value

A string with matching regular expressions replaced by the template string.

## Discussion

See [`Flag Options`](/documentation/Foundation/NSRegularExpression#Flag-Options) for the format of `templ`.

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)