From MediaWiki.org
Jump to: navigation, search
Translate this page; This page contains changes which are not marked for translation.

Other languages:
català • ‎Deutsch • ‎English • ‎español • ‎suomi • ‎français • ‎italiano • ‎日本語 • ‎한국어 • ‎Nederlands • ‎polski • ‎português • ‎português do Brasil • ‎sicilianu • ‎Tiếng Việt • ‎中文
MediaWiki extensions manual
Crystal Clear action run.png

Release status: stable

Implementation Parser function
Description Introduces parser functions for dealing with page-scoped variables.
Author(s) Rob Adams, Tom Hempel, Xiloynaha, Daniel Werner
Latest version 2.1.0 (2014-04-22)
MediaWiki 1.19+
PHP 5.3+
Database changes No
License Public domain
Hooks used


Translate the Variables extension if it is available at translatewiki.net

Check usage and version matrix; code metrics

The Variables extension allows you to define a variable on a page, use it later in that same page or included templates, change its value, possibly to a value given by an expression in terms of the old value, etc.

It is much like a template, only very lightweight and scoped to only a single page, so you can use many variables on a page without slowing down the wiki with huge numbers of templates. Combine this extension with the ParserFunctions extension for best results.

Assigning a value to a variable[edit | edit source]

#vardefine[edit | edit source]

  • {{#vardefine:variablename|specifiedvalue}}

Assigns the value specifiedvalue to the (already existing or hereby introduced) variable variablename.

  • Example: {{#vardefine:iconwidth|25}} making iconwidth = 25

#vardefineecho[edit | edit source]

  • {{#vardefineecho:variablename|specifiedvalue}}

Works exactly as #vardefine, but the affected value is printed.

  • Example: making iconwidth = {{#vardefineecho:iconwidth|25}}

Retrieving the value of a variable[edit | edit source]

#var[edit | edit source]

The value of the variable variablename is produced by

  • {{#var:variablename}}

If undefined, this produces an empty string; it does not give an error message.

It is possible to define a value for the case that the variable is undefined or void:

  • {{#var:variablename |defaultvalue}}

This is equivalent to:

  • {{#if: {{#var:variablename}} |{{#var:variablename}} |defaultvalue}}

but it is much shorter and better arranged. Before version 2.0 though, the default value always was expanded. From version 2.0 on the default only gets expanded in case it is actually used.

The value can be used in parser functions, etc.

#varexists[edit | edit source]

  • {{#varexists:variablename}} returns 1 if the variable is already defined (also when the value is a void string). If the variable is not defined the return value is void.

#var_final[edit | edit source]

Experimental new function introduced in Variables 2.0. This function will output the final, last value a variable has at the end of the page rendering. Naturally, the value will be inserted after the parser went over the entire wiki markup, so this function can't be used in other functions, expecting the right value is being used. Example:

  • {{#var_final:variablename |default}}

The default value will be used if the variable doesn't exist at the final page rendering stage or if its value is an empty string. The default will be expanded right where the function is used, so the parameter will be expanded, even if it won't be needed.

Examples[edit | edit source]

The ParserFunctions extension must also be installed to use #expr.

Compute x = 2*a + b:

  • {{#vardefine:x|{{#expr:2*{{#var:a}}+{{#var:b}}}} }}

Add one to n:

  • {{#vardefine:n|{{#expr:{{#var:n}}+1}}}}

Installation[edit | edit source]

  • Download and place the file(s) in a directory called Variables in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
require_once "$IP/extensions/Variables/Variables.php";
  • YesY Done - Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

See also[edit | edit source]