Extension:RegexFunctions

Other languages:
English • ‎Türkçe • ‎dansk • ‎français • ‎中文 • ‎日本語
MediaWiki extensions manual
OOjs UI icon advanced.svg
RegexFunctions
Release status: beta
Implementation Parser function
Description Regular expression based parser functions
Author(s) Ryan Schmidt (Skizzerztalk)
Latest version 2.0.0 (2020-03-18)
MediaWiki 1.31+
License Public domain
Download
Usage
Translate the RegexFunctions extension if it is available at translatewiki.net
Check usage and version matrix.

The RegexFunctions extension provides regular expression based parser functions.

UsageEdit

As of now, this extension defines three parser functions: rmatch, rsplit, and rreplace :

#rmatch:
{{#rmatch:string|pattern|then|else}}
string (required) - The text the function uses for the matching.
pattern (required) - The regular expression to use on the text.
then (optional) - What to return if the match was successful. $# and \# contain the captured text. Use ${#}# if you want a group followed by another number.
else (optional) - What to return if the match was not successful. Defaults to an empty string.
#rsplit:
{{#rsplit:string|pattern|piece}}
string (required) - The text the function will split.
pattern (required) - The regular expression to use on the text. No text is captured.
piece (optional) - The piece to return. Defaults to 0 (the first piece). Negative numbers return pieces starting from the end. For example, -1 is the last piece.
#rreplace:
{{#rreplace:string|pattern|replacement}}
string (required) - The text the function will replace.
pattern (required) - The regular expression to use on the text.
replacement (required) - The text to replace the matched text with. $# and \# contain the captured text. Use ${#}# if you want a group followed by another number.

Except for the string parameter, every parameter can be specified either by name or position. For example, {{#rmatch:some string|pattern=^.+$|then=success|else=failure}}. If your wiki's content language is not English, both the English names as well as a translated name may be usable. In addition, every function supports the following named parameters which allow you to modify the behavior of the regex:

  • multiline - If non-empty, ^ and $ match the start and end of each line, rather than the start and end of the entire string.
  • caseless - If non-empty, the pattern is case-insensitive.
  • ungreedy - If non-empty, * and + do not match greedily whereas *? and +? match greedily.
  • extended - If non-empty, the regex can contain spaces and inline comments. See the PHP documentation in the pattern help section for more information.
  • dotall - If non-empty, . matches all characters, including newlines. Normally it does not match newlines.

For example, {{#rmatch:XxXxX|x+|$0|caseless=1}} would result in the output XxXxX because x+ matches both uppercase and lowercase X's when the caseless modifier is set.

Pattern helpEdit

For help on constructing the syntax, please read [1] for general help and [2] for an overview of the modifiers.

Delimiters are not required on the pattern in general and should be omitted for readability where possible, but are required if you would like to specify the single-letter modifiers after the pattern. In this event, the delimiters must be forward slashes (no other delimiter type is supported).

InstallationEdit

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

See alsoEdit

  • ReplaceSet - an excellent substitute for using nested #replace commands when you need to perform a sequence of replaces on a single text string.
  • StringFunctions - some helpful string operations.
  • Regex Fun - just another regex extension with more functionality but without any customization variables for limitations.
  • Extension:RegexParserFunctions