Extension:RegexFunctions

From MediaWiki.org
Jump to navigation Jump to search

Other languages:
English • ‎dansk • ‎日本語
MediaWiki extensions manual
Crystal Clear action run.svg
RegexFunctions
Release status: beta
Implementation Parser function
Description Regular expression based parser functions
Author(s) Ryan Schmidt (Skizzerztalk)
Latest version 1.5.0 (2017-10-30)
MediaWiki 1.23+
License Public domain
Download
Usage
Changelog
Parameters
  • $wgRegexFunctionsPerPage
  • $wgRegexFunctionsAllowModifiers
  • $wgRegexFunctionsAllowE
  • $wgRegexFunctionsAllowOptions
  • $wgRegexFunctionsLimit
  • $wgRegexFunctionsDisable
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.

Usage

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

#rmatch:
{{#rmatch:string|pattern|return|notfound|offset}}
string (required): The text the function uses for the matching.
pattern (required): The regular expression to use on the text.
return (required): What to return if the match was successful. $# and \# contain the captured text, and $$# and \\# contain the offsets of that text. Use ${#}# or \{#}# if you want a group followed by another number.
notfound (optional): What to return if the match was not successful. Defaults to an empty string.
offset (optional): The offset in bytes to start the match at. Defaults to 0 (the beginning of the text).
#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).
#rreplace:
{{#rreplace:string|pattern|replace}}
string (required): The text the function will replace.
pattern (required): The regular expression to use on the text.
replace (required): The text to replace the matched text with. Both $# and \# will call the capturing groups, use ${#}# or \{#}# if you want a group followed by another number.

Pattern help

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

Installation

  • Download and place the file(s) in a directory called RegexFunctions in your extensions/ folder.

Configuration

$wgRegexFunctionsPerPage
How many functions are allowed per page. Default is 10, but it is recommended that it is set above 3 for usability.
$wgRegexFunctionsAllowModifiers
Allows modifiers (e.g./i for case insensitivity). Does not enable the /e modifier in the rreplace function, see the next variable for that. Defaults to true.
$wgRegexFunctionsAllowModifiers
Allows modifiers (e.g./i for case insensitivity). Does not enable the /e modifier in the rreplace function, see the next variable for that. Defaults to true.
$wgRegexFunctionsAllowE
Allows the /e modifier in rreplace, which treats the 'replace' text as PHP code. Don't enable this unless you trust all of your users, as it opens up XSS vectors and other security concerns. Defaults to false.
$wgRegexFunctionsAllowOptions
Allows internal options (e.g. (?U) for ungreedy) inside of the regex itself. Defaults to true.
$wgRegexFunctionsLimit
Limit for the number of pieces in the rsplit function and replaces in the rreplace function. -1 is unlimited. Defaults to -1.
$wgRegexFunctionsDisable
Array of functions you want to disable. Defaults to an empty array.

Changelog

Version 1.5.0
Removed backwards compatible I18n shim.
Version 1.4.3
Fixed critical security issue (patch by User:Pastakhov).
Version 1.4.2
Fixed issue in PHP 5.3 about pass-by-reference stuff in the rreplace function.
Version 1.4.1
Fixed issue where disabling rmatch disabled every function, and it was otherwise impossible to disable rsplit and rreplace.
Version 1.4.0
Moved to new message declaration style, nothing changed frontend-wise
Version 1.3.0
Sanitation process should no longer misinterpret things as internal options.
Version 1.2.0
Pattern goes through a sanitation process before being passed onto one of the preg_* functions.
Version 1.1.0
Localization updates
Version 1.0.0
Initial Release, defines three functions: rmatch, rsplit, and rreplace

See also

  • 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.