Extension:Variables
![]() Release status: stable |
|
---|---|
Implementation | Parser function |
Description | Introduces parser functions for dealing with page-scoped variables. |
Author(s) |
|
Maintainer(s) | MGChecker |
Latest version | 2.5.1 (2019-07-11) |
MediaWiki | 1.29+ |
PHP | 5.5+ |
Database changes | No |
Composer | mediawiki/variables |
License | ISC License |
Download | README RELEASE-NOTES |
|
|
Quarterly downloads | 161 (Ranked 66th) |
Public wikis using | 1,808 (Ranked 201st) |
Translate the Variables extension if it is available at translatewiki.net | |
Vagrant role | variables |
Issues | Open tasks · Report a bug |
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.
#var_final
parser function is shown as deprecated in MediaWiki 1.35 or above, due to changes in the parser. However, it will continue to work in this versions. See task T276627 and task T236809 for further information.Assigning a value to a variableEdit
#vardefine
Edit
{{#vardefine:variablename|specifiedvalue}}
Assigns the value specifiedvalue to the (already existing or hereby introduced) variable variablename.
- Example:
{{#vardefine:iconwidth|25}}
makingiconwidth = 25
#vardefineecho
Edit
{{#vardefineecho:variablename|specifiedvalue}}
Works exactly as #vardefine
, but the affected value is printed.
- Example: making
iconwidth = {{#vardefineecho:iconwidth|25}}
Retrieving the value of a variableEdit
#var
Edit
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 get a default 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
{{#varexists:variablename }}
returns 1 if the variable is already defined. If the variable is not defined the return value is void.
It supports a second and a third parameter to replace these values.
{{#varexists:variablename | if-value | else-value }}
This is equivalent to:
{{#if: {{#varexists: variablename }} | if-value | else-value }}
but it is much shorter and better arranged. Before version 2.5 though, both were always expanded. From version 2.5 on the if and else values only get expanded when their cases are actually entered.
#var_final
Edit
Experimental 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 | defaultvalue}}
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.
ExamplesEdit
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}}}}
InstallationEdit
- Download and place the file(s) in a directory called
Variables
in yourextensions/
folder. - Add the following code at the bottom of your
LocalSettings.php
:wfLoadExtension( 'Variables' );
- Configure as required
- Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
To users running MediaWiki 1.30 or earlier:
The instructions above describe the new way of installing this extension using wfLoadExtension()
.
If you need to install this extension on these earlier versions (MediaWiki 1.30 and earlier), instead of wfLoadExtension( 'Variables' );
, you need to use:
require_once "$IP/extensions/Variables/Variables.php";
ConfigurationEdit
This extension provides two configuration parameters:
$egVariablesAreVolatile
- Allows to disable the parser frame being marked as volatile by the extension, i.e. disable template caching.
- Default:
true;
$egVariablesDisabledFunctions
- Allows to disable specified parser functions provided by this extension.
- Default:
[];
- Example:
[ 'var_final', 'vardefineecho' ];
CompatibilityEdit
The recommended version of the Variables extension for recent MediaWiki releases is listed below. Older versions of the extensions might work as well, but aren't tested for new MediaWiki releases.
1.19 | 1.20 | 1.21 | 1.22 | 1.23 | 1.24 | 1.25 | 1.26 | 1.27 | 1.28 | 1.29 | 1.30 | 1.31 | 1.32 | 1.33 | 1.34 | master | |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2.x | 2.1.x | 2.2.x | 2.5.x, master |
AlternativesEdit
As this extension will not be enabled for wikis run by the Wikimedia Foundation (WMF), here are some alternatives:[1][2][3][4]
- If you use Variables as cache for expensive operations, you can transform the section where you need them into a template and pass the required information as template parameters instead. This will work until you reach the expansion depth limit, which can be increased if necessary.
- If you use Variables to do more complex template operations than possible with simple Extension:ParserFunctions , and if you have sufficient permissions on the server, you can use Scribunto's Lua functionality instead. You may not be able to install Scribunto on shared hosting. Note that this does not add support for global Variables. However, Extension:VariablesLua adds a Scribunto interface for the Variables store.
- Don't use variables, instead duplicate the information you need as a variable. If that information is acquired by an expensive template call, performance may suffer. This will work until you reach the node count limit.
- If you require variables just for autonumbering, you could look into Extension:NumerAlpha .
See alsoEdit
- Extension:PhpTags
- Extension:MyVariables - Creates new variables in the MediaWiki sense
- Extension:Loops — Provides parser functions for performing loops
- Extension:Arrays — Create an array and provide array functions (such as search, split, and sort) and set operations (such as intersect, union and diff)
- Extension:HashTables — New parser functions for handling hash tables in MediaWiki
ReferencesEdit
- ↑ 1.0 1.1 phab:T9865
- ↑ 2.0 2.1 phab:T65324
- ↑ 3.0 3.1 phab:T113859
- ↑ 4.0 4.1 phab:T151192
This extension is included in the following packages and/or wiki farms: This is not an authoritative list. Some wiki farms/hosts may contain this extension even if they are not listed here. Always check with your wiki farms/hosts or bundle to confirm. |