Help:ParserFunctions

Other languages: Deutsch (de) English (en) Español (es) Français (fr) Italiano (it) 日本語 (ja) 한국어 (ko) Nederlands (nl) Polski (pl) Português (pt) Русский (ru) Slovenščina (sl) Tiếng Việt (vi) 中文 (zh) עברית (he) العربية (ar) +/-

MediaWiki Handbook: Contents, Readers, Editors, Moderators, System admins +/-
View this page using:
old preprocessor
new preprocessor
diff
Shortcut:
WM:PF

The MediaWiki extension ParserFunctions is a collection of parser functions (note the difference between the name of the collection, and the general term). These parser functions have a hash character in front of the function name, so they typically have the syntax:

{{ #functionnameargument 1 | argument 2 | argument 3... }}

Please note that ParserFunctions are unavailable in some MediaWiki installations, check out Special:Version below Parser hooks, individual functions such as expr and switch are listed below Parser function hooks.

ParserFunctions
Type: Parser Extension
Version
Version: N/A
Maturity: Stable
MediaWiki: > 1.6.8
Last Updated: 2006-11-21
Description
A collection of parser functions such as branching instructions and expression handler and time calculation unit.
MediaWiki extensions

Contents

Functions

The extension defines nine functions: expr, if, ifeq, ifexist, ifexpr, switch, time, rel2abs, and titleparts.


#expr:

  • syntax: {{ #exprexpression }}

The expr function computes mathematical expressions based on permutations of numbers (or variables/parameters that translate to numbers) and operators. It does not recognize strings (use ifeq below instead). The accuracy and format of numeric results varies with the server's operating system.

Operators are listed below. In a complex expression, operators are evaluated from left to right with the following precedence (explained in more detail in Help:Calculation):

  1. grouping (parentheses);
  2. unary (+/- signs and NOT);
  3. multiplicative (*, /, div, mod);
  4. additive (+ and -);
  5. round;
  6. comparative (=, !=, <, >, etc.);
  7. logical AND;
  8. logical OR.

When evaluating as boolean, "0" is considered false and any other non-space value is true (boolean true is represented as "1").

Decimal numbers use "." as a decimal point (formatnum: can be used to change the decimal point to a comma for the appropriate locales). Scientific notation with E plus exponent is not yet supported on input for expressions, but used on output (see Help:Calculation).

Operator Operation Example Result
none {{ #expr123456789012345 }} 123456789012340
{{ #expr0.000001 }} 1.0E-6
Arithmetic
+ Unary positive sign {{ #expr+30 * +7 }} 210
- Unary negative sign {{ #expr-30 * -7 }} 210
* Multiplication {{ #expr30 * 7 }} 210
/
div
Division {{ #expr30 / 7 }}
{{ #expr30 div 7 }}
4.2857142857143
4.2857142857143
+ Addition {{ #expr30 + 7 }} 37
- Subtraction {{ #expr30 - 7 }} 23
Logic
not Unary NOT
logical NOT
{{ #exprnot 0 * 7 }}
{{ #exprnot 30 + 7 }}
7
7
and Logical AND

{{ #expr4 < 5 and 4 mod 2 }}

0
or Logical OR

{{ #expr4 < 5 or 4 mod 2 }}

1
Comparison
= Equality (numerical & logical) {{ #expr30 = 7 }} 0
<>
!=
Inequality, logical exclusive or {{ #expr30 <> 7 }}
{{ #expr1 != 0 }}
1
1
< Less than

{{ #expr30 < 7 }}

0
> Greater than

{{ #expr30 > 7 }}

1
<= Less than or equal to

{{ #expr30 <= 7 }}

0
>= Greater than or equal to

{{ #expr30 >= 7 }}

1
Other
( ) Grouping operators {{ #expr(30 + 7) * 7  }} 259
mod "Modulo" truncates the numbers to whole numbers, divides the left number by the right, and returns the remainder that could not be divided.
Note: div and mod are different from all programming languages.
{{ #expr30 mod 7 }}
{{ #expr-8 mod -3 }}
{{ #expr8 mod 2.7 }}
2
-2
0
round Rounds off the number on the left to the power of 1/10 given on the right. {{ #expr30 / 7 round 4 }}
{{ #expr30 / 7 round 1 }}
{{ #expr1911 round -2 }}
{{ #expr-2.5 round 0 }}
4.2857
4.3
1900
-3

#if:

  • syntax:
    {{ #if<condition string> | <code if true> }}
    {{ #if<condition string> | <code if true> | <code if false> }}

The if function is an if-then-else construct. The condition is always true unless it is empty or whitespace-only. The code in the second argument is parsed if the condition is true, and the third argument is parsed if the condition is false (either or both may be blank, and the code-if-false argument can be omitted entirely).

The condition is evaluated as text, so mathematical expressions will always evaluate as true; to use expressions as conditions, see #ifexpr. It is not possible to distinguish between an undefined parameter in a template and a blank one (it is possible with #ifexpr).

Examples:

  • {{ #iffoo | do if true | do if false }} = do if true
  • {{ #if0 | do if true | do if false }} = do if true
  • {{ #if | do if true | do if false }} = do if false

#ifeq:

  • syntax:
    {{ #ifeq<text 1> | <text 2> | <code if equal> }}
    {{ #ifeq<text 1> | <text 2> | <code if equal> | <code if not equal> }}

The ifeq function compares two strings or numbers, and returns the second argument if they are equal and the third argument if not equal (either or both may be blank, and the code-if-not-equal argument can be omitted entirely).

Comparison of strings is case-sensitive (for example, A != a). If both strings can be interpreted numerically, they will be compared numerically (for example, 01 = 1); To force a string-based comparison, add non-numerical characters (such as quotes ") to both compared arguments.

It is possible to distinguish between undefined and empty template parameters by comparing default values (if the parameter is defined, it will overwrite the default value even if blank):

  • {{ #ifeq{{{parameter|default}}} | default | parameter not defined | parameter defined }} = parameter not defined

Issues:

  • Text between <nowiki> tags is temporarily replaced by a unique code. This affects comparisons: {{ #ifeq<nowiki>abc</nowiki> | <nowiki>abc</nowiki> | equal | not equal }} returns "not equal".

#ifexist:

{{#ifexist:}} returns one of two results based on whether or not a particular page exists.

{{ #ifexist<page name> | <wikitext if page exists> | <wikitext if page does not exist>  }}


The usual case-sensitivity applies: if a page exists then also a non-canonical name for that page gives a positive result. E.g. on Meta:

{{ #ifexistBugs|Foo|RFC 3092 }} gives RFC 3092, because Bugs exists
{{ #ifexistbugs|Foo|RFC 3092 }} gives RFC 3092, because bugs is in canonical form the existing Bugs
{{ #ifexistBUGS|Foo|RFC 3092 }} gives RFC 3092 because BUGS does not exist
{{ #ifexistm:Help:Calculation|Yes|Oops }} gives Oops although m:Help:Calculation exists, because of the interwiki prefix.

The first parameter is the title to check for, the second is the positive result, and the third, the negative result. If the parameter passed does not produce a valid title object, then the result is negative.

template:exists ( talk edit history links ) gives the same result, except that the result is positive for an interwiki link. You can also handle an interwiki link differently with template:if interwiki link ( talk edit history links ).

{{#ifexist:}} doesn't handle relative paths (like '../foo'), for that, use it in combination of {{#rel2abs:}}.

The page where {{#ifexist:foo}} appears is listed on Special:Whatlinkshere/foo (as a page which links to foo), see below.

On Wikimedia wikis there is a maximum for the number of distinct pages for which #ifexist is called on a page. A call of #ifexist after a transclusion of the same page does not require an extra database query and is therefore not counted. A call beyond the maximum returns "false". The html-source of each page shows the counted number of calls, as well as the maximum. The maximum is currently 500, and it has been announced that this will be lowered to 100. [1].

{{#ifexist:}} always returns the false condition with Special pages:

{{ #ifexistSpecial:Version|'''works'''|'''doesn't work''' }} gives doesn't work

#ifexpr:

{{#ifexpr:}} evaluates a mathematical expression (see #expr) and returns one of two strings depending on the result.

{{ #ifexpr<expression> | <then text> | <else text>  }}


If the expression evaluates to zero, then the else text is returned, otherwise the then text is returned. Expression syntax is the same as for expr.

Example:

{{ #ifexpr 10 > 9 | yes | no }} yes -- Because 10 is greater than 9.
At the moment the else text is also returned for an empty expression:
{{ #ifexpr{{ns:0}}|Toast| '''or else''' }} gives or else
Omitting both then text and else text gives no output except possibly an error message; this can be used to check the correctness of an expression, or to check the wording of the error message (emulated assertions, forced errors):
{{ #ifexpr1/{{#ifeq: {{ns: 4 }} | Meta | 1 | 0 }} }} Division by zero -- no result, hence "1/{{#ifeq: {{ns:4}}|Meta|1|0}}" is a correct expression
{{ #ifexpr1/{{#ifeq: {{ns: 0 }} | Meta | 1 | 0 }} }} Division by zero
{{ #if{{#ifexpr: 1=2 }} | wrong | correct }} correct -- "1=2" is a correct Boolean expression (not to be confused with one with the value 1, representing "true")
{{ #if{{#ifexpr: 1E2 }} | wrong | correct }} wrong -- "1E2" not allowed in expressions
{{ #if{{#ifexpr: 1/0 }} | wrong | correct }} wrong -- "1/0" not allowed
{{ #if{{#ifexpr: a=b }} | wrong | correct }} wrong ("a=b" not allowed, to compare strings use #ifeq)

Example of an application: {{ #if: {{#ifexpr: {{PAGENAME}} }} || action if PAGENAME is a number (or correct numeric expression) }}

For another application, see also template:evalns ( talk edit history links ).

#switch:

switch compares a single value against multiple others, returning a string if a match is found. The syntax is basically:

{{#switch: <comparison value>
 | <value1> = <result1>
 | <value2> = <result2>
 | ...
 | <valuen> = <resultn>
 | <default result>
}}

switch will search through each value passed until a match is found with the comparison value. When found, the result for that value is returned (the text string after the equal sign). If no match is found, but the last item has no equal sign in it, it will be returned as the default result. If your default result must have an equal sign, you may use #default:

{{#switch: <comparison value>
 | <value> = <result>
 | #default = <default result>
}}

Note that it's also possible to have "fall through" for values (reducing the need to duplicate results). For example:

{{#switch: <comparison value>
| <value1>
| <value2>
| <value3> = <result1, 2, 3>
| ...
| <valuen> = <resultn>
| <default result>
}}

Note how value1 and value2 contain no equal sign. If they're matched, they are given the result for value3 (that is, whatever is in result3).

As for #ifeq: the comparison is numerical where possible:
{{ #switch+07 | 7 = Yes | 007 = Bond | No  }} gives Yes
{{ #switch"+07"|"7"= Yes |"007"= Bond | No  }} gives No
The matched value can be empty, therefore the following constructs are equivalent:
{{ #if{{ns:0}} | not empty | empty  }} gives empty
{{ #switch{{ns:0}}|=empty|not empty  }} gives empty

Comparison of strings is case-sensitive:

{{ #switchA | a=lower | A=UPPER  }} gives UPPER
{{ #switchA | a=lower | UPPER  }} gives UPPER
{{ #switcha | a=lower | UPPER  }} gives lower

This is not to be confused with the fact that parser function names are case-insensitive:

{{ #swItchA | a=lower | UPPER  }} gives UPPER

To have the #switch statement be case-insensitive, use the construct {{lc:}} or {{uc:}}

{{ #switch{{lc:A}} | a=lower | A=UPPER  }} gives lower
{{ #switch{{lc:A}} | a=lower | UPPER  }} gives lower
{{ #switch{{lc:a}} | a=lower | UPPER  }} gives lower

This is usually used in templates, when you want to have case-insensitivity on in param values:

{{#switch: {{lc: {{{1| B }}} }}
| a
| b
| c = '''''abc''' or '''ABC'''''
| A
| B
| C = ''Memory corruption due to cosmic rays''
| #default = N/A
}}

gives abc or ABC

#switch may be used instead of #ifeq:

{{ #switcha | a=true | false  }} gives true
{{ #ifeqa | a | true | false  }} gives true

#time:

{{#time:}} is a time and date formatting function (for dates from 1 Jan 1970 only!). The syntax is:

{{ #timeformat }}
{{ #timeformat | time }}

If the time is not specified, the time at which the article is converted to HTML is used. Note that due to caching, this may be up to a week different to the time at which the article is viewed. Manual updates may be required, this can be achieved by saving the page without making any changes (a "null edit") or viewed with action=purge in search string of URL or viewed by a user whose option is "Disable page caching".

The format parameter is a format string similar to the one used by PHP's date.

The following format codes have the same meaning as in PHP. Significant differences from PHP's behaviour, apart from internationalisation (i.e. language and locale differences), should be considered an error of ParserFunctions and should be reported. All numeric format codes return numbers formatted according to the local language, use the xn code described below to override this.

Code Description Example output Current output
Year:
Y The 4-digit year. e.g. 2006 2018
y The 2-digit year. 00 to 99, e.g. 06 for year 2006. 18
Month:
n The month number, not zero-padded. 1 to 12 12
m The month number, zero-padded. 01 to 12 12
M An abbreviation of the month name. Often internationalised. Jan to Dec Dec
F The full month name. Often internationalised. January December
Week:
W ISO 8601 week number (ISO years have full weeks from monday to sunday, and ISO week number 1 always contains January 4 or the first thursday of the civil year), zero-padded. 01 to 52 or 53 (depends on year) 50
Day:
j The day of the month, not zero-padded. 1 to 31 10
d The day of the month, zero-padded. 01 to 31 10
z The day of the year (starting from 0) 0 to 364, or 365 on a leap year 343
D An abbreviation for the day of the week. Rarely internationalised. Mon to Sun Mon
l The full weekday name. Rarely internationalised. Monday to Sunday Monday
N ISO 8601 day of the week (according to the ISO 8601 week). 1 (for Monday) through 7 (for Sunday) 1
w number of the day of the week (according to the American week). 0 (for Sunday) through 6 (for Saturday) 1
Hour:
a am (between 01:00:00 and 12:59:59 on the same day) or pm, with lowercase (used with the 12-hour format). am or pm pm
A Same as with code a above, but with uppercase. AM or PM PM
g 12-hour format of the hour without leading zeros (one or two digits, used with am/pm or AM/PM). 1 to 12 11
h 12-hour format of the hour, with leading padding zero (two digits, used with am/pm or AM/PM). 01 to 12 11
G 24-hour format of the hour, without leading padding zero (one or two digits). 0 to 23 23
H 24-hour format of the hour, with leading padding zero (two digits). 00 to 23 23
Minutes and seconds:
i The minute, with leading padding zero (two digits). 00 to 59 25
s The second, with leading padding zero (two digits). 00 to 59 44
U Seconds since January 1 1970 00:00:00 GMT. 0 to infinite 1544484344
Miscellaneous:
L Whether it's a leap year. 1 if it is a leap year, 0 otherwise. 0
t Number of days in the month. 28 to 31 31
c ISO 8601 formatted date, same as {{#time:Y-m-dTH:i:s{{#time:+H:i|+0 hours}}}}. fixed length string 2018-12-10T23:25:44+00:00
r RFC 2822 formatted date, same as {{#time:D, j M Y H:i:s {{#time:+H:i|+0 hours}}}}. variable length string Mon, 10 Dec 2018 23:25:44 +0000

The following format codes are extensions to the PHP syntax:

Code Description
xn Format the next numeric code as a raw ASCII number. For example, in the Hindi language, {{ #timeH, xnH }} produces ०६, 06.
xN Toggle a permanent raw number formatting flag. Like xn, except it lasts until the end of the string or until the same code appears again.
xr Format the next numeric code as a roman numeral. Only works for numbers up to 3000.
xg Output the genitive form of the month name, for languages which make such a distinction between genitive and nominative.
xx A literal "x"
xij The day of the month in Iranian calendar.
xiF The full month name in Iranian calendar
xin The month number in Iranian calendar
xiY The full year in Iranian calendar
xjj The day of the month in Hebrew calendar
xjF The full month name in Hebrew calendar
xjx Genitive form of the month name in Hebrew calendar
xjn The month number in Hebrew calendar
xjY The full year in Hebrew calendar
xkY The full year in Thai solar calendar

Any unrecognised character will be passed through to the output unmodified. There are also two quoting conventions which can be used to output literal characters.

  • Characters enclosed in double quotes will be considered literal (with the quotes themselves removed). Unmatched quotes will be considered literal quotes. Example:
    • {{ #time"The month is" F }} → The month is December
    • {{ #timei's" }} → 25'44"
  • Backslash escaping as in PHP's date() is supported. \H produces a literal H, \" produces a literal ".

More format codes may be added in the future, as demanded by the users of this extension. This may come in the form of either a more complete implementation of PHP's format codes, or additional "x" codes.

The format of the time parameter is identical to the one used by PHP's function strtotime(). It supports both absolute and relative dates, such as "December 11" and/or "+10 hours", which can be used for timezone translation. See also the GNU tar manual for more information.

Examples

  • {{ #timel j F Y | 20070304 }} gives "Sunday 4 March 2007"
  • {{ #timel j F Y | 2007-3-4 }} gives "Sunday 4 March 2007"
  • {{ #timel j F Y | 4 March 2007 }} gives "Sunday 4 March 2007"
  • {{ #timel j F Y | -32 days }} gives "Thursday 8 November 2018" (32 days ago)
  • {{ #timeH:i | +6 hours }} gives "05:25" (6 hours later than UTC)
  • {{ #timeH:i | 8:15 +6 hours }} gives "19:15"
  • {{ #timem/Y | -17 months }} gives "07/2017" (17 months ago)

In combination with user-specified date formatting:

  • {{ #timel [[j F]] [[Y]] | 4 March 2007 }} gives "Sunday 4 March 2007"
  • {{ #timel [[Y-m-d]] | 4 March 2007 }} gives "Sunday 2007-03-04"

Both give the user-specified format; the two are different if no preference has been specified.

Range

The range of proper functioning is 01 January 1970 00:00:01 through 19 January 2038 03:14:07, or 1 through <math>2^{31}-1</math> seconds after the start of 1970 (the Year 2038 problem). For arbitrary dates that may exceed this range, use date computing templates such as template:dowa ( talk edit history links ) instead.

Dates before 1901 give an error message, dates between 1901 and 1970 even give (perhaps depending on the server) a wrong result (!):

  • "{{#time:c|5 April 1967}}" gives "1970-01-01T00:00:00+00:00" [2]
  • "{{#time:c|5 April 1867}}" gives "1970-01-01T00:00:00+00:00" [3]

Incomplete dates

  • "{{#time:c|2007}}" gives "2018-12-11T01:07:00+00:00" [4] (not a year but a time: today, 20:07)
  • "{{#time:c|1997}}" gives "1997-12-10T23:25:44+00:00" [5] (19:97 is not a valid time, therefore interpreted as year, giving the current date and time in that year)
  • "{{#time:c|1967}}" gives "1970-01-01T00:00:00+00:00" [6] (19:67 is not a valid time, therefore interpreted as year; this gives a date that is out of range which is changed to the start of the valid range)
  • "{{#time:c|April 2007}}" gives "2007-04-01T04:00:00+00:00" [7] (start of the month)
  • "{{#time:c|5 April}}" gives "2018-04-05T04:00:00+00:00" [8] (specified date of the current year)

February 29

Caution should be taken with February 29, as {{#time:j|February 29}} will vary with the year. For example

  • {{ #timej|February 29 2006 }} gives 1
  • {{ #timej|February 29 2008 }} gives 29

Timezones

Give UTC for a specified time, expressed in time zone UTC-3:

  • "{{#time:H:i:s|7:00:00 -0300}}" gives "10:00:00" [9]
  • "{{#time:H:i:s|7:00:00 -3}}" gives "10:00:00" [10]

Give the UTC 3 hours ago:

  • "{{#time:H:i:s|-3 hours}}" gives "20:25:45" [11]

Give the UTC 3 hours before a specified time expressed as UTC:

  • "{{#time:H:i:s|7:00:00 -3 hours}}" gives "09:00:00" [12]

Give the UTC 3 hours before a specified time expressed in time zone UTC-3:

  • "{{#time:H:i:s|7:00:00 -3 -3 hours}}" gives "07:00:00" [13]

Thus "-0300" and "-3" add 3 hours, while "-3 hours" subtracts them.


#rel2abs:

{{#rel2abs:}} converts a relative path to an absolute path.

{{ #rel2abspath }}
{{ #rel2abspath | base path }}

A relative path is a path starting with '/', './', '../'. or is containing '/../' or '/.' or is simply the strings '..' or '.'.
If a base path is given, is should be defined in an absolute syntax.

Example:

  • If standing in Help:Foo/bar and is calling {{ #rel2abs../baz }}, the result will be {{ #rel2abs: ../baz | Help:Foo/bar }}
  • If standing in Help:Foo and is calling {{ #rel2abs../baz }}, the result will be {{ #rel2abs: ../baz | Help:Foo }}
  • If standing in Help:Foo and is calling {{ #rel2abs../../baz }}, the result will be {{ #rel2abs: ../../baz | Help:Foo }}
  • If calling {{ #rel2abs../baz | Help:Bar/foo }}, the result will be {{ #rel2abs: ../baz | Help:Bar/foo }}
  • If calling {{ #rel2absHelp:Foo/bar/../baz }}, the result will be {{ #rel2abs: Help:Foo/bar/../baz }}

There is no checks if the path do exist, for that you might use {{#ifexist:}} in combination:

{{ #ifexist{{#rel2abs: .. }} | '..' exist | '..' does not exist }} gives '..' does not exist
{{ #ifexist{{#rel2abs: . }} | '.' exist | '.' does not exist }} gives '.' does not exist


#titleparts:

{{ #titleparts: pagename | n_of_segments | starting_from }}
returns n_of_segments slash-separated segments of pagename, starting from the specified starting segment.

  • if starting_from is omitted, it is considered to be equal 1
  • namespace part of pagename is converted into localized namespace name

Examples with one numeric parameter:

  • "{{#titleparts:Help:Link/a/b|0|}}" gives "{{#titleparts:Help:Link/a/b|0|}}" [14]
  • "{{#titleparts:Help:Link/a/b|1|}}" gives "{{#titleparts:Help:Link/a/b|1|}}" [15]
  • "{{#titleparts:Help:Link/a/b|2|}}" gives "{{#titleparts:Help:Link/a/b|2|}}" [16]
  • "{{#titleparts:Help:Link/a/b|3|}}" gives "{{#titleparts:Help:Link/a/b|3|}}" [17]
  • "{{#titleparts:Help:Link/a/b|4|}}" gives "{{#titleparts:Help:Link/a/b|4|}}" [18]

Examples with two numeric parameters:

  • "{{#titleparts:Help:Link/a/b|2|2}}" gives "{{#titleparts:Help:Link/a/b|2|2}}" [19]
This gives two parts of the title, starting at the second part. Likewise:
  • "{{#titleparts:Help:Link/a/b|1|2}}" gives "{{#titleparts:Help:Link/a/b|1|2}}" [20]
  • "{{#titleparts:Help:Link/a/b|1|3}}" gives "{{#titleparts:Help:Link/a/b|1|3}}" [21]

Examples with negative parameters (which means "counting from the right"):

  • "{{#titleparts:Help:Link/a/b|-1|}}" gives "{{#titleparts:Help:Link/a/b|-1|}}" [22]
  • {{#titleparts:Help:Link/a/b|1|-1|}} gives {{#titleparts:Help:Link/a/b|1|-1|}} [23]


Introduced in r22711, fixed to allow negative parameters in r28708. See also bug 6067.


#iferror:

{{#iferror:expression|error|success}} returns error if the expression contains a <strong class="error"> as generated by #expr, #ifexpr, #time, #rel2abs, and some other MediaWiki situations (such as recursive depth and template loop checks). This is most useful in catching bad input passed to such parserfunctions. For example:

  • {{#iferror:{{#expr:1+1}}|bad input|valid expression}} gives {{#iferror:2|bad input|valid expression}}
  • {{#iferror:{{#expr:1+Z}}|bad input|valid expression}} gives {{#iferror:Expression error: unrecognised word "z"|bad input|valid expression}}

The last two parameters are also optional. If the success parameter is omitted, then the expression is returned on success. If the error parameter is also omitted, then no output is generated on error, and expression is returned on success.

  • {{#iferror:{{#expr:1+1}}|bad input}} gives {{#iferror:2|bad input}}
  • {{#iferror:{{#expr:1+Z}}|bad input}} gives {{#iferror:Expression error: unrecognised word "z"|bad input}}
  • {{#iferror:{{#expr:1+1}}}} gives {{#iferror:2}}
  • {{#iferror:{{#expr:1+Z}}}} gives {{#iferror:Expression error: unrecognised word "z"}}

Thus:

  • {{#iferror:wikitext|alternative}} means "render wikitext if it is correct, and otherwise alternative".
  • {{#iferror:wikitext}} means "render wikitext if it is correct".
Note: this functionality replaces a bug in the older preprocessor allowing #switch to catch expression errors.

See also: r29774, r29775, r29877.

Caveats

Like other parser functions the parser functions in this extension are affected by 5678 in a predictable way. Summary: undefined parameters can be overwritten by corresponding parameters, for details see 5678 and Substitution. Substitution is the only case where this is critical with respect to parameter defaults. It doesn't affect defined parameters.

Substitution

Applying "subst:" to a parser function works, provided that there is no space between "subst:" and "#". For details see Help:Substitution. Note that unless a technique like optional substitution is used, substituting a template which uses a parser function does not replace that parser function with its result. This is often undesirable.

See also the previous section.

Tables

Currently wiki pipe table syntax doesn't work inside conditionals, but there are some workarounds.

  • Hide the pipe from parser functions by putting it in a template, e.g. template:! ( talk edit history links ).
  • Use html style table syntax instead of wiki style table syntax. NB: $wgUserHtml must be true (this has since been removed, and thus should not need to be set to 'true' - check if it is relevant for your version). This may not work without setting $wgUseTidy=true;.
  • See also Help:Table, completely empty rows or columns are not displayed. Empty cells could be also transformed into dummy &nbsp; cells on pages not affected by 5569.

Note that "|" and "=" were always tricky within templates, this is no new issue.

If all else fails, try setting $wgUseTidy=true; in your LocalSettings.php.

useTidy

If you decide to use this, you will need to download the HTML tidy programme from http://tidy.sourceforge.net/.

Expressions

  • div is not integer division and is redundant, use / (slash) for real divisions.
  • mod uses PHP's % operator, which is different from modulo-operators in all other programming languages, see also template:mod ( talk edit history links ) and 6068.
  • mod sometimes returns wrong results for the same input values, see 6356 and /MOD10000. Update: values less than 1E+12 are apparently not affected.
  • Valid #expr: results like 1.0E-7 are not yet supported as #expr: input:
    {{#expr:1.0E-7}} yields Expression error: unrecognised word "e".
  • Under certain conditions round 0 results in -0 instead of 0. For an expression x using 0+(x) fixes this oddity.

Newlines and spaces

Newlines and spaces are stripped from the start and end of parameters of all parser functions. In cases where these matter, e.g. in wikitable syntax, for conditionals use template:if ( talk edit history links ) as a workaround.

See also Help:Newlines and spaces.

Code execution

Oddly, the page to which #ifexist is applied (i.e. the page whose existence is the condition) is registered as link target of a link from the page with #ifexist. (See bug #12019.)

See also interpretation of a parser function as a templatehttp://neurocommons.org/page/Help:Parser_function#Interpretation_of_a_parser_function_as_a_template.

Installation

Download all 4 of these files and put them in a new directory called ParserFunctions in your extensions directory.

If you don't have php5 use these files instead (older revision):

Then put the following at the end of your LocalSettings.php:

require_once( "$IP/extensions/ParserFunctions/ParserFunctions.php" );

If you get errors such as "Warning: require_once(/extensions/ParserFunctions/ParserFunctions.php) [function.require-once]: failed to open stream:", you should substitute the line for:

require_once( 'extensions/ParserFunctions/ParserFunctions.php' );

You can also browse the code tree here:

Troubleshooting

The Current version of ParserFunctions requires php5 to function.

INSTALLATION WARNING: MediaWiki: 1.9.1, PHP: 5.1.2-Debian-0.1~sarge1 (apache2handler) function ctype_alpha not available, had to add the following to Expr.php

if ( !function_exists('ctype_alpha') ) {
   function ctype_alpha($string) {
       //if ( !preg_match('|[^\pL]|', $string) )
       /* Warning: preg_match() [function.preg-match]: Compilation failed: PCRE does not support 
       \L, \l, \N, \P, \p, \U, \u, or \X at offset 3 in 
       /.../extensions/ParserFunctions/Expr.php on line 6
       */
       /* alternative: */ // 
       if ( !preg_match('|[^A-Za-z]|', $string) )
           return true;
       else
           return false;
   }
}

If you are using Gentoo Linux's portage system to install php, be sure to have the "ctype" USE flag set for dev-lang/php to avoid the above error.

Bugs

In version 1.6 and 1.7 if a user has the Cite.php extension already installed, an error is created when running ParserFunctions, "Unknown datatype in hooks for ParserClearState", a simple fix has been found by editing Cite.php. ]

1.11.0

I found that the files above didn't work and that I needed the latest from the svn trunk</br> http://svn.wikimedia.org/svnroot/mediawiki/trunk/extensions/ParserFunctions/

1.8 and up

All the ParserFunctions work under 1.8 and up, also in the localised forms.

1.7

All the ParserFunctions work under 1.7, but only in English. However, the extension may cause problems when used together with the Cite extension; cf. [24]. For the #time parser functions to work, you must also download SprintfDateCompat.php to the extensions/ParserFunctions directory.

1.6

When including the ParserFunctions in 1.6, some notices may be shown. Removing the following line (line 10) in ParserFunctions.php fixes the problem:

$wgHooks['LanguageGetMagic'][]       = 'wfParserFunctionsLanguageGetMagic';

Or alternatively adding the default language to the header function on line 169 may solve the problem:

function wfParserFunctionsLanguageGetMagic( &$magicWords, $langCode='en' ) {

For the #time parser functions to work, you must also download SprintfDateCompat.php to the extensions/ParserFunctions directory. But actually that won't fix the problem.

If you're not planning to support #time, you may find removing this line helps avoid an error in the ParserClearState call chain:

$wgHooks['ParserClearState'][] = array( &$wgExtParserFunctions, 'clearState' );

Most ParserFunctions (except #if, which does not work at all) work just as well on MediaWiki 1.6, but the syntax of ParserFunctions is without the '#' character. If you want to use the '#' character, find this section of ParserFunctions.php:

 $wgParser->setFunctionHook( 'expr', array( &$wgExtParserFunctions, 'expr' ) );
 $wgParser->setFunctionHook( 'if', array( &$wgExtParserFunctions, 'ifHook' ) );
 $wgParser->setFunctionHook( 'ifeq', array( &$wgExtParserFunctions, 'ifeq' ) );
 $wgParser->setFunctionHook( 'ifexpr', array( &$wgExtParserFunctions, 'ifexpr' ) );
 $wgParser->setFunctionHook( 'switch', array( &$wgExtParserFunctions, 'switchHook' ) );
 $wgParser->setFunctionHook( 'ifexist', array( &$wgExtParserFunctions, 'ifexist' ) );

Then, replace it with this:

 $wgParser->setFunctionHook( '#expr', array( &$wgExtParserFunctions, 'expr' ) );
 $wgParser->setFunctionHook( '#if', array( &$wgExtParserFunctions, 'ifHook' ) );
 $wgParser->setFunctionHook( '#ifeq', array( &$wgExtParserFunctions, 'ifeq' ) );
 $wgParser->setFunctionHook( '#ifexpr', array( &$wgExtParserFunctions, 'ifexpr' ) );
 $wgParser->setFunctionHook( '#switch', array( &$wgExtParserFunctions, 'switchHook' ) );
 $wgParser->setFunctionHook( '#ifexist', array( &$wgExtParserFunctions, 'ifexist' ) );

A simple fix for #if in this version -

Replace:

 function ifHook( &$parser, $test = '', $then = '', $else = '' ) {
  if ($test !== '') {

on line 57 with:

 function ifHook( &$parser, $test = '', $then = '', $else = '' ) {
  if ( (string)$test !== '' ){

Although the above fix doesn't appear to work on PHP 4.3.9

If you find some template responses are being unexpectedly wrapped in <pre></pre>

I saw this problem in 1.6.10 using the workarounds here and worked around it by making sure all results from ParserFunction callbacks were trimmed. If a result had a leading space character, then that portion of the template would be wrapped in pre tags. Couldn't figure out what part of the parser was doing this. But force trimming might be a potential workaround based on your needs.

Alteration and localization

The file ParserFunctions.i18n.php contains the localization for the parserfunctions. Adding more may be done by editing it according to the following guidelines.

In the latest MediaWiki versions, a new case for the language code should be added to function efParserFunctionsWords, for example:

        $words['fr'] = array(
	    'expr'       => array( 0, 'calcul',        'expr' ),
            'if'         => array( 0, 'si',            'if' ),
            'ifeq'       => array( 0, 'si-similaire',  'ifeq' ),
            'ifexpr'     => array( 0, 'si-calcul',     'ifexpr' ),
            'switch'     => array( 0, 'achemine',      'switch' ),
	    'default'    => array( 0, '#default' ); // same
            'ifexist'    => array( 0, 'si-existe',     'ifexist' ),
	    'time'       => array( 0, 'temps',         'time' ),
	    'rel2abs'    => array( 0, 'rel-a-abso',    'rel2abs' ),
	    'titleparts' => array( 0, 'part-titre',    'titleparts' ),
        );
  • Please note that every hook established in function wfSetupParserFunctions must have an associated magic-words statement for it to work. Failure to associate a magic word may result in PHP warning messages (see bug #10166).

This method may not work on older version. Alternatively, hooks may be established in function wfSetupParserFunctions, as follows.

// fr
$wgParser->setFunctionHook( '#calcul', array( &$wgExtParserFunctions, 'expr' ) );
$wgParser->setFunctionHook( '#si', array( &$wgExtParserFunctions, 'ifHook' ) );
$wgParser->setFunctionHook( '#si-similaire', array( &$wgExtParserFunctions, 'ifeq' ) );
$wgParser->setFunctionHook( '#si-calcul', array( &$wgExtParserFunctions, 'ifexpr' ) );
$wgParser->setFunctionHook( '#achemine', array( &$wgExtParserFunctions, 'switchHook' ) );
$wgParser->setFunctionHook( '#si-existe', array( &$wgExtParserFunctions, 'ifexist' ) );	
$wgParser->setFunctionHook( '#temps', array( &$wgExtParserFunctions, 'time' ) );	
  • Tested on MediaWiki 1.6.10

See also


Links to other help pages

Help contents | search (all help pages)
Meta | Wikinews | Wikipedia | Wikiquote | Wikiversity | Wiktionary | commons: | mw: | b: | s:
Versions of this help page (for other languages see below)
Meta | Wikinews | Wikipediahttp://en.wikipedia.org/page/Help:ParserFunctions | Wikiquote | Wiktionary
Links to this page from Meta (int) Meta (ext) Wikipedia MediaWiki
Reading
Go | Search | Stop words | URL | Namespace | Page name | Section
Backlinks | Link | Piped link | Interwiki link | Redirect | Category | Image page
Logging in and preferences
Logging in | Preferences | User style
Editing
Advanced editing | Editing FAQ | Edit toolbar | Export | Import
Editing shortcuts
Tracking changes
Recent changes (enhanced) | Related changes | Watching pages | Diff
Page history | Edit summary | User contributions | Minor edit | Patrolled edit
Style & formatting
Wikitext examples | Reference card
HTML in wikitext | HTML elements
List | Table | Sorting
Mathematical symbols on English Wikipedia
Special input and output
Inputbox | Special characters | Displaying a formula | Images and other uploaded files | EasyTimeline
Advanced functioning
Template | Advanced templates | Parser function | ParserFunctions | Parameter default | Variable | Magic word | System message | Substitution
Array | Calculation
Page management
Starting a new page | Renaming (moving) a page | Maintenance | Merging and moving pages | Protecting pages
Resolving disputes | Deleting a page
Special pages
Talk page | Testing | Sandbox
Lists of resources
Lists of Categories | Copyrights | Infobox
Redirect | Reference Desk | Shortcuts | Stub types