Template:MultiReplace/doc

This is a documentation subpage for Template:MultiReplace.
It may contain usage information, categories and other content that is not part of the original template page.

This template is used on approximately 235,000 pages.
To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them.

This template uses Lua:

Module:MultiReplace

Replaces matches of multiple patterns in a given string with given replacements. For each replacement instance, the pattern matching at the lowest position is chosen. If there are multiple such patterns, then the one specified earliest in the pattern list is chosen.

Usage

{{MultiReplace|input|plain=yes (optional)|pattern1| replacement1|pattern2|replacement2... }}

If plain=yes is specified, then the patterns and replacements are treated as plain text, otherwise as Lua Unicode patterns.

An equals sign in a pattern will trigger an Unpaired argument error. Use {{=}}, which expands to an equals sign that will not be interpreted.