Extension:ReplaceSet

From MediaWiki.org
Jump to navigation Jump to search
MediaWiki extensions manual
Crystal Clear action run.svg
ReplaceSet
Release status: stable
Implementation Parser function
Description Allows for multiple patterns of text, either plain or RegExp based to be replaced using a parser function.
Author(s) Daniel Friesen (Dantmantalk)
Latest version 1.6.0 (2018-03-09)
MediaWiki 1.25+
PHP 5.4+
Database changes No
License GNU General Public License 2.0 or later
Download
Example sandbox.semantic-mediawiki.org
Hooks used
ParserFirstCallInit
Translate the ReplaceSet extension if it is available at translatewiki.net
Check usage and version matrix.

The ReplaceSet extension allows for patterns of text, either plain or RegExp based to be replaced. The idea is to allow many patterns to be replaced simply without overloading the Parser with dozens of ParserFunctions and allow for simple replace based syntaxes to be built such as linking certain words in a Card lore.

ReplaceSet is coded to make full use of pcre's performance. All the replacement patterns are passed together at once to pcre instead of looping over each one and doing replacements separate, this avoids shuffling between pcre and php.

Usage[edit]

{{#replaceset: text to replace | regex pattern or string to be replaced = replacement | ... }}

Regex patterns are wrapped in !pattern! #pattern# (pattern) [pattern] or {pattern}, and may be followed with any of the flags "imsxADU" (see php's documentation on pcre modifiers for what they individually do). Patterns that do not use any of those will be considered plaintext replacements such as "|A=B|" (replace all occurrences of "A" with "B").

If you need to use an = or an | within the pattern or text you want to replace you can wrap the pattern inside of a nowiki. ie: {{#replaceset:A=B|<nowiki>=</nowiki>=&}}

Example[edit]

{{#replaceset:Text to replace|/(\w+)/i="\1"|to=2}}

Would produce "Text" "2" "replace".

Installation[edit]

  • Download and place the file(s) in a directory called ReplaceSet in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    wfLoadExtension( 'ReplaceSet' );
    
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

To users running MediaWiki 1.30 or earlier:

The instructions above describe the new way of installing this extension using wfLoadExtension() If you need to install this extension on these earlier versions (MediaWiki 1.30 and earlier), instead of wfLoadExtension( 'ReplaceSet' );, you need to use:

require_once "$IP/extensions/ReplaceSet/ReplaceSet.php";

Configuration[edit]

{{#replaceset}} has two configurable limitations:

$egReplaceSetCallLimit
A limit to the number of times #replaceset may be used in a page. This is set to 25 by default.
$egReplaceSetPregLimit
A limit passed to preg limiting the number of replacements within the text to replace that will be made. This is set to 50 by default.

See also[edit]


Other languages: English  • 日本語