Help:Extension:ParserFunctions

The extension provides eleven additional parser functions to supplement the "magic words", which are already present in MediaWiki. All the parser functions provided by this extension take the form:
 *  

#expr
This function evaluates a mathematical expression and returns the calculated value.


 *  

The available operators are listed to the right, in order of precedence. See for more details of the function of each operator. The accuracy and format of the result returned will vary depending on the operating system of the server running the wiki, and the number format of the site language.

When evaluating using, zero evaluates to false and any nonzero value, positive or negative, evaluates to true:


 *   → 
 *   → 

An empty input expression returns an empty string. Invalid expressions return one of several error messages, which can be caught using the #iferror function:


 *   →  
 *  </tt> → 
 *  </tt> → 

#if

 *  </tt>

This function tests whether the first parameter is 'non-empty'. It evaluates to false if the test string is empty or contains only whitespace characters (spaces, newlines, etc).


 *  </tt> → 
 *  </tt> → 
 *  </tt> → 
 *  </tt> → 

The test string is always interpreted as pure text, so mathematical expressions are not evaluated:


 *  </tt> → 
 *  </tt> → 

Either or both the return values may be omitted:


 *  </tt> →  
 *  </tt> →  
 *  </tt> →  

See Help:Parser functions in templates for more examples of this parser function.

#ifeq
This parser function compares two strings and determines whether they are identical.


 *  </tt>

If both strings are valid numerical values, the strings are compared numerically:


 *  </tt> → 
 *  </tt> → 
 *  </tt> → 
 * <tt> </tt> → 

Otherwise the comparison is made as text; this comparison is case sensitive:


 * <tt> </tt> → 
 * <tt> </tt> → 
 * <tt> </tt> →   (compare to similar example above, without the quotes)
 * <tt> </tt> →    (compare to similar example above, with <tt>#expr</tt>)

As a practical example, given an existing template <tt>Template:Size</tt> used to set standard short and long sizes, defined as:

the following ensue:


 * <tt> </tt> → 20
 * <tt> </tt> → 40
 * <tt> </tt> → 40

#iferror
This function takes an input string and returns one of two results; the function evaluates to <tt>true</tt> if the input string contains an HTML object with <tt>class="error"</tt>, as generated by other parser functions such as <tt>#expr</tt>, <tt>#time</tt> and <tt>#rel2abs</tt>, template errors such as loops and recursions, and other "failsoft" parser errors.


 * <tt> </tt>

One or both of the return strings can be omitted. If the <tt>correct</tt> string is omitted, the <tt>test string</tt> is returned if it is not erroneous. If the <tt>error</tt> string is also omitted, an empty string is returned on an error:


 * <tt> </tt> → 
 * <tt> </tt> → 
 * <tt> </tt> → 
 * <tt> </tt> → 
 * <tt> </tt> → 
 * <tt> </tt> → &zwnj;
 * <tt> </tt> → 

#ifexpr
This function evaluates a mathematical expression and returns one of two strings depending on the boolean value of the result:


 * <tt> </tt>

The <tt>expression</tt> input is evaluated exactly as for <tt>#expr</tt> above, with the same operators being available. The output is then evaluated as a boolean expression.

An empty input expression evaluates to false:


 * <tt> </tt> → 

As mentioned above, zero evaluates to false and any nonzero value evaluates to true, so this function is equivalent to one using <tt>#ifeq</tt> and <tt>#expr</tt> only:


 * <tt> </tt>

except for an empty or wrong input expression (an error message is treated as an ordinary string; it is not equal to zero, so we get <tt>value if true</tt>).

Either or both the return values may be omitted; no output is given when the appropriate branch is left empty:


 * <tt> </tt> → 
 * <tt> </tt> →  
 * <tt> </tt> →  
 * <tt> </tt> →  
 * <tt> </tt> →  
 * <tt> </tt> →  

#ifexist
This function takes an input string, interprets it as a page title, and returns one of two values depending on whether or not the page exists on the local wiki.


 * <tt> </tt>

The function evaluates to <tt>true</tt> if the page exists, whether it contains content, is visibly blank (contains meta-data such as category links or magic words, but no visible content), is blank, or is a redirect. Only pages that are redlinked evaluate to false, including if the page used to exist but has been deleted.


 * <tt> </tt> → 
 * <tt> </tt> → 

The function evaluates to true for system messages that have been customised, and for special pages that are defined by the software.


 * <tt> </tt> → 
 * <tt> </tt> →
 * <tt> </tt> →

<tt>#ifexist:</tt> is considered an "expensive parser function"; only a limited number of which can be included on any one page (including functions inside transcluded templates). When this limit is exceeded, the page is categorised into Category:, and any further <tt>#ifexist:</tt> functions automatically return false, whether the target page exists or not.

If a page checks a target using <tt>#ifexist:</tt>, then that page will appear in the list for the target page. So if the code <tt> </tt> were included live on this page, /Foo will list.

On wikis using a shared media repository, <tt>#ifexist:</tt> can be used to check if a file has been uploaded to the repository, but not to the wiki itself:
 * <tt> </tt>  → 
 * <tt> </tt> → 
 * <tt> </tt> → 

If a local description page has been created for the file, the result is exists for all of the above.

#rel2abs
This function converts a relative file path into an absolute filepath.


 * <tt> </tt>
 * <tt> </tt>

Within the <tt>path</tt> input, the following syntax is valid:
 * → the current level
 * → "go up one level"
 * → "go down one level into the subdirectory /foo"

If the <tt>base path</tt> is not specified, the full page name of the page will be used instead:


 * <tt> </tt> → '''
 * <tt> </tt> → '''
 * <tt> </tt> → '''
 * <tt> </tt> → '''

Invalid syntax, such as <tt>/.</tt> or <tt>/./</tt>, is ignored. Since no more than two consecutive full stops are permitted, sequences such as these can be used to separate successive statements:


 * <tt> </tt> → '''
 * <tt> </tt> → '''
 * <tt> </tt> → '''
 * <tt> </tt> → '''

#switch
This function compares one input value against several test cases, returning an associated string if a match is found.

Example:


 * <tt> </tt> →   


 * 1) switch allows an editor to add information in one template and this information will be visible in several other templates which all have different formatting.

Default
The <tt>default result</tt> is returned if no <tt>case</tt> string matches the <tt>comparison string</tt>:


 * <tt> </tt> →   

In this syntax, the default result must be the last parameter and must not contain a raw equals sign.


 * <tt> </tt> →   
 * <tt> </tt> →   

Alternatively, the default result may be explicitly declared with a <tt>case</tt> string of "<tt>#default</tt>".

Default results declared in this way may be placed anywhere within the function:


 * <tt> </tt> →   

If the <tt>default</tt> parameter is omitted and no match is made, no <tt>result</tt> is returned:


 * <tt> </tt> →   

Grouping results
It is possible to have 'fall through' values, where several <tt>case</tt> strings return the same <tt>result</tt> string. This minimizes duplication.

Here cases 2, 3 and 4 all return <tt>result2</tt>; cases 6 and 7 both return <tt>result4</tt>

Comparison behaviour
As with <tt>#ifeq</tt>, the comparison is made numerically if both the comparison string and the case string being tested are numeric; or as a case-sensitive string otherwise:


 * <tt> </tt> → 
 * <tt> </tt> → 


 * <tt> </tt> → 
 * <tt> </tt> → 

A <tt>case</tt> string may be empty:
 * <tt> </tt> → 

Once a match is found, subsequent <tt>cases</tt> are ignored:
 * <tt> </tt> → 

Raw equal signs
"Case" strings cannot contain raw equals signs. To work around this, create a template = containing a single equals sign: <tt>=</tt>.

Example:


 * <tt> </tt> → 

For a simple real life example of the use of this function, check. Two complex examples can be found at and Template:BOTREQ.

#time
This parser function takes a date and/or time (in the Gregorian calendar) and formats it according to the syntax given. A date/time object can be specified; the default is the value of the magic word <tt> </tt> – that is, the time the page was last rendered into HTML.


 * <tt> </tt>
 * <tt> </tt>

The list of accepted formatting codes is given in the table to the right. Any character in the formatting string that is not recognised is passed through unaltered; this applies also to blank spaces (the system does not need them for interpreting the codes). There are also two ways to escape characters within the formatting string: In addition, the digraph <tt>xx</tt> is interpreted as a single literal "x".
 * 1) A backslash followed by a formatting character is interpreted as a single literal character
 * 2) characters enclosed in double quotes are considered literal characters, and the quotes are removed


 * <tt> </tt> → 
 * <tt> </tt> → 
 * <tt> </tt> → 
 * <tt> </tt> → 
 * <tt> </tt> → 

The <tt>date/time object</tt> can be in any format accepted by PHP's strtotime function. Both absolute (eg <tt>20 December 2000</tt>) and relative (eg <tt>+20 hours</tt>) times are accepted.

<tt> </tt> → '''

<tt> </tt> → '''

<tt> </tt> → '''

If you've calculated a Unix timestamp, you may use it in date calculations by pre-pending an <tt>@</tt> symbol.

<tt> </tt> → '''

<tt> </tt> → '''

Full or partial absolute dates can be specified; the function will 'fill in' parts of the date that are not specified using the current values:


 * <tt> </tt> → '''

With MediaWiki r86805 - Code Review, a four-digit number is always interpreted as a year, never as hours and minutes:

<tt> </tt> → '''

A six-digit number is interpreted as hours, minutes and seconds if possible, but otherwise as an error (not, for instance, a year and month):

<tt> </tt> → ''' Input is treated as a time rather than a year+month code.

<tt> </tt> → ''' Although 19:60:09 is not a valid time, 196009 is not interpreted as September 1960.

The function performs a certain amount of date mathematics:


 * <tt> </tt> → '''
 * <tt> </tt> → '''
 * <tt> </tt> → '''
 * <tt> </tt> → '''

The total length of the format strings of the calls of  is limited to 6000 characters.

#timel
This function is identical to <tt> </tt>, except that it uses the local time of the wiki (as set in ) when no date is given.


 * <tt> </tt> → 
 * <tt> </tt> → 
 * <tt> </tt> → 
 * <tt> </tt> → 

#titleparts
This function separates a pagetitle into segments based on slashes, then returns some of those segments as output.


 * <tt> </tt>

If the <tt>number of segments</tt> parameter is not specified, it defaults to "0", which returns all the segments. If the <tt>first segment</tt> parameter is not specified or is "0", it defaults to "1":


 * <tt> </tt> → 
 * <tt> </tt> → 
 * <tt> </tt> → 
 * <tt> </tt> → 

Negative values are accepted for both values. Negative values for <tt>number of segments</tt> effectively 'strips' segments from the end of the string. Negative values for <tt>first segment</tt> translates to "add this value to the total number of segments", loosely equivalent to "count from the right":


 * <tt> </tt> → 
 * <tt> </tt> →  
 * <tt> </tt> →   Strips one segment from the end of the string, then returns the second segment and beyond

The string is split a maximum of 25 times; further slashes are ignored. The string is also limited to 255 characters, as it is treated as a page title:


 * <tt> </tt> → 

You can use #titleparts as a small "string parser & converter", but consider that it returns the first substring capitalized. If lower case is needed, use lc: function to control output.


 * <tt> </tt> → 
 * <tt> </tt> → 
 * <tt> </tt> → 

Substitution
Parser functions can be substituted by prefixing the hash character with <tt>subst:</tt>:


 * <tt> </tt> → the code <tt>    </tt> will be inserted in the wikitext since the page  exists.

Tables
Parser functions will mangle wikitable syntax, treating all the raw pipe characters as parameter divisors. To avoid this, most wikis create the template    :! with its contents only a raw pipe character. This 'hides' the pipe from the MediaWiki parser, ensuring that it is not considered until after all the templates and variables on a page have been expanded. Alternatively, raw HTML table syntax can be used, although this is less intuitive and more error-prone.

Stripping whitespace
Whitespace, including newlines, tabs, and spaces, is stripped from the beginning and end of all the parameters of these parser functions. If this is not desirable, comparison of strings can be done after putting them in quotation marks.





For preventing trimming then- and else-parts, see m:Template:If.