Note: When you edit this page, you agree to release your contribution under the CC0. See Public Domain Help Pages for more info.
Magic words are strings of text that MediaWiki associates with a return value or function, such as time, site details, or page names. This page explains only the standard magic words; for a technical reference, see Manual:Magic words.
There are three general types of magic words:
Behavior switches: these are usually written as uppercase words surrounded by double underscores, e.g.__FOO__.
Variables: these are uppercase words surrounded by double braces, e.g.{{FOO}}. As such, they look a lot like templates.
Variables and parser functions can use subst:, just like templates. Page-dependent magic words will affect or return data about the current page (by default), even if the word is added through a transcluded template or included system message.
Behavior switches
A behavior switch controls the layout or behavior of the page (if supported by the skin) and can often be used to specify desired omissions and inclusions in the content. Notably some of these are not supported by the Minerva skin.
Forces the table of contents to appear at its normal position (before the first header, overriding __NOTOC__). This will not work in skins that present table of contents outside the article content e.g. Vector 2022 skin.
__TOC__
Places a table of contents at the word's current position (overriding __NOTOC__). If this is used multiple times, the table of contents will appear at the first word's position. This will not work in skins that present table of contents outside the article content e.g. Vector 2022 skin.
Editing
__NOEDITSECTION__
Hides the section edit links beside headings. This is especially useful where a heading is created from within a template: the normal wiki section-edit would in this case edit the template code, which is usually not what the user intends. Use of this in a template will extend the effect to that template, the pages it's included on, and any other templates included on the same page. A workaround is possible.
__NEWSECTIONLINK__
Adds a link beside the "Edit" tab for adding a new section on a non-talk page (see Adding a section to the end).
≥ 1.7
__NONEWSECTIONLINK__
Removes the link beside the "Edit" tab on pages in talk namespaces.
Used on a category page, replaces thumbnails in the category view with normal links.
≥ 1.7
__HIDDENCAT__
Used on a category page, hides the category from the lists of categories in its members and subcategories (there is an option in the user preferences to show them).
On wikis with language variants, don't perform any content language conversion in article display; for example, only show Chinese (zh) instead of variants like zh_cn, zh_tw, zh_sg, or zh_hk.
__NOTITLECONVERT__ __NOTC__
On wikis with language variants, don't perform language conversion on the title (all other content is converted).
Other
__START__
No effect. Was used to point where database message starts after comment that should not be transcluded. Removed in r1695 and completely removed in r24784.
On redirect pages, don't allow MediaWiki to automatically update the link when someone moves a page and checks "Update any redirects that point to the original title" (which requires $wgFixDoubleRedirects).
If this switch is not intended to be transcluded with the template's contents, it should be used inside <noinclude>...</noinclude> (or on a template documentation page inside <includeonly>...</includeonly>), similarly to template categories. See Help:Templates.
If the switch is intended to remove from the report all pages that transclude a given template (for example, a notice that is transcluded on testcases or sandbox subpages), put the switch inside <includeonly>...</includeonly> tags within the template page.
Disables the global user page. If present on the central user page, will prevent it from being displayed on remote wikis, and it also determines whether a link to a user page on remote wiki should be red or blue.
Some wiki pages do not fit the scope of Wikidata items, such as discussion archives, template subpages, etc. To prevent a wiki page from being listed in Special:UnconnectedPages, use this magic word anywhere on the page. Pages that don't meet Wikidata's notability criteria should not receive a Wikidata item.
Some wikisource content pages consist of lists (such as a list of editions or translations of the same work) and therefore did not have scans. To prevent these pages from being listed in Special:PagesWithoutScans, insert this magic word into the page.
A magic word and a parser function which when invoked, will disable the Wikibase extension for a specific page, or used with parameters can suppress specific interlanguage links produced by the extension. When active, only interlanguage links present in the wikitext are used.
Variables
Variables return information about the current page, wiki, or date. Their syntax is similar to templates. Variables marked as "[expensive]" are tracked by the software, and the number that can be included on a page is limited.
If a template name conflicts with a variable, the variable will be used (so to transclude the template Template:PAGENAME you would need to write {{Template:PAGENAME}}).
In some cases, adding parameters will force the parser to invoke a template; for example, {{CURRENTDAYNAME|x}} transcludes Template:CURRENTDAYNAME, not the variable.
Date and time
The following variables return the current date and time in UTC.
Due to MediaWiki and browser caching, these variables frequently show when the page was cached rather than the current time.
The use of those variables cause pages to be cached for a more limited number of seconds. This is configured in MagicWordFactory.
The date and time magic words are formatted in the wiki content language. Since 1.19, they depend on the page content language.
The following variables do the same as the preceding ones but using the site's server config or $wgLocaltimezone.
{{LOCALYEAR}}
{{LOCALMONTH}}
{{LOCALMONTH1}}
{{LOCALMONTH2}}
{{LOCALMONTHNAME}}
{{LOCALMONTHNAMEGEN}}
{{LOCALMONTHABBREV}}
{{LOCALDAY}}
{{LOCALDAY2}}
{{LOCALDOW}}
{{LOCALDAYNAME}}
{{LOCALTIME}}
{{LOCALHOUR}}
{{LOCALWEEK}}
{{LOCALTIMESTAMP}}
For more thorough time formatting, or to output the current year and week with better compliance with ISO-8601, you may want to install Extension:ParserFunctions to use the #time parser function.
Subdomain and domain name (no longer dependent on $wgServerName as of version 1.17).
{{DIRMARK}}
{{DIRECTIONMARK}}
Outputs a Unicode directional mark that matches the wiki's default language's direction (‎ on left-to-right wikis, ‏ on right-to-left wikis), useful in text with multi-directional text. Since 1.19, it depends on the page content language.
Returns the title of the translation page (the page other languages are translated from) if a page is translatable (including translated pages), and nothing if the page is not translatable.
<translate><!--T:1--> Translated unit. Language: <tvarname=lang>{{TRANSLATIONLANGUAGE}}</tvar>.</translate>
<translate><!--T:2--> Untranslated unit. Language: <tvarname=lang>{{TRANSLATIONLANGUAGE}}</tvar>.</translate>
Translated unit. Language: en.
Not translated unit. Language: en.
Must be used in a translated page, inside <translate> tags. Returns the language code of the current translation unit. In a translation page, if the unit has been translated, then it returns translation language. Else, it returns source language. The language code that this variable returns can be converted to a language name using {{#language:...}}. Should only be used by translation admins.
Outputs the protection level (e.g. "autoconfirmed", "sysop") for a given action (e.g. "edit", "move") on the current page. Returns an empty string if not protected.
Outputs the protection expiry (e.g. "20160418155030", "infinity") for a given action (e.g. "edit", "move") on the current page. Returns "infinity" if not protected.
[Expensive] Returns the sources of any cascading protection acting on the current page. Pages will not return their own title unless they transclude themselves.
Viewed revision of current page (latest revision or selected older revision)
{{REVISIONID}}
-
Unique revision ID. It is always empty in preview, thus one can show an error message only in preview. May be disabled in miser mode (all WMF wikis) returning - instead when not in preview.
≥ 1.5
{{REVISIONDAY}}
27
Day edit was made (unpadded number).
≥ 1.8
{{REVISIONDAY2}}
27
Day edit was made (zero-padded number).
≥ 1.8
{{REVISIONMONTH}}
10
Month edit was made (zero-padded number as of 1.17+, unpadded number in prior versions).
Format the display title of the current page, which is what is typically shown in a page's title header. Unless $wgRestrictDisplayTitle is set to false, the value must be equivalent to the default title: only capitalization changes to certain parts of the title (not all) and replacing spaces with underscores are allowed. It can be disabled or enabled by $wgAllowDisplayTitle.
It can take a second argument of noerror or noreplace to suppress error messages when multiple displaytitles are used on one page or to make this displaytitle do nothing if a displaytitle was already specified earlier in the page.
Used for categorizing pages, sets a default category sort key. For example if you put {{DEFAULTSORT:Smith, John}} at the end of John Smith, the page would be sorted under "S" by default in categories. It can take a second argument of noerror or noreplace to suppress error messages when multiple defaultsortkeys are used on one page or to make this defaultsort do nothing if a defaultsort was already specified earlier in the page.
User's language. (If $wgParserEnableUserLanguage is enabled, it is disabled by default.) Note: Currently not supported by Parsoid Page View. If using Parsoid Page View or if $wgParserEnableUserLanguage is disabled, the magic word will return the same result as {{PAGELANGUAGE}}.
Numbers returned by these variables normally contain separators (commas, dots or spaces, depending on the local language) but can return raw numbers with the ":R" flag (for example, {{NUMBEROFPAGES}} → 1,755,727 and {{NUMBEROFPAGES:R}} → 1755727).
Use "|R" for magic words that require a parameter like PAGESINCATEGORY (for example {{PAGESINCATEGORY:Help}} and {{PAGESINCATEGORY:Help|R}}, or {{PAGESINCATEGORY:Help|subcats}} and {{PAGESINCATEGORY:Help|subcats|R}}).
Also applicable to {{PAGESIZE:page name}} hereinbefore.
The number magic words are formatted in the wiki content language. Since 1.19, it depends on the page content language.
[Expensive] Number of pages in the given namespace (replace index with the relevant namespace index). For instance, {{PAGESINNAMESPACE:14}} will output the number of category pages. {{PAGESINNS:0}} differs from {{NUMBEROFARTICLES}} in that the former includes redirects and disambiguation pages. Disabled by default, enable with $wgAllowSlowParserFunctions.
≥ 1.7
Page names
Variable
For current page
Description
Versions
{{FULLPAGENAME}}
Help:Magic words
Namespace and full page title (including all subpage levels).
≥ 1.6
{{PAGENAME}}
Magic words
Full page title (including all subpage levels) without the namespace.
{{BASEPAGENAME}}
Magic words
Page title of the page in the immediately superior subpage level without the namespace. Would return Title/Foo on page Help:Title/Foo/Bar.
≥ 1.7
{{ROOTPAGENAME}}
Magic words
Name of the root of the current page. Would return Title on page Help:Title/Foo/Bar.
≥ 1.22
{{SUBPAGENAME}}
Magic words
The subpage title. Would return Bar on page Help:Title/Foo/Bar.
If no subpage exists the value of {{PAGENAME}} is returned.
Full page name of the associated subject (e.g. article or file). Useful on talk pages.
≥ 1.7
{{TALKPAGENAME}}
Help talk:Magic words
Full page name of the associated talk page.
≥ 1.7
None of these are affected by changes to the display title using {{DISPLAYTITLE:xxxx}}; the values returned are the original page title.
The {{BASEPAGENAME}} and {{SUBPAGENAME}} magic words only work in namespaces that have subpages enabled. See $wgNamespacesWithSubpages for information on enabling subpages.
As of 1.15+, these can all take a parameter, allowing specification of the page to be operated on, instead of just the current page:
{{PAGENAME:Template:Main Page}} → Main Page
Warning:
If the page title contains any parts that are "." or "..", the magic word returns nothing.
{{PAGENAME:one/./three}} → Nothing is returned.
Warning:
Page titles containing certain characters, such as apostrophes ' or asterisks *, may produce unexpected results when handled with these magic words, e.g. {{PAGESINCATEGORY:{{PAGENAME}}}}. See bugs T16779, T18474, T37628, T37746. One simple way to fix this is wrapping the pagename in {{#titleparts:}} from the ParserFunctions extension.
The following are equivalents encoded for use in MediaWiki URLs (spaces replaced with underscores and some characters percent-encoded):
{{NAMESPACEE}}
{{SUBJECTSPACEE}}
{{ARTICLESPACEE}}
{{TALKSPACEE}}
As of 1.15+, these can take a full-page-name parameter and will return the requested namespace associated with that page, instead of with the current page:
{{NAMESPACENUMBER:MediaWiki}} → 0
{{NAMESPACE:MediaWiki}} → (Pages in main space will return empty)
MediaWiki interprets certain characters as markup separators in certain contexts, notably:
template invocations
tables
function calls.
To prevent an immediate interpretation (so that the character can be displayed literally or later interpreted as a separator), Template:Character can be used as an escape sequence, but only the following characters (replacements) are supported.
This form can be clearer or at least shorter than using the equivalent <nowiki>character</nowiki>.
For historical/technical reasons, this is not an escape sequence properly speaking. The syntax uses a resembling character, the exclamation mark, instead of the vertical bar.
Parser functions are very similar to variables but take one or more parameters (technically, any magic word that takes a parameter is a parser function), and the name is sometimes prefixed with a hash to distinguish them from templates.
This page only describes parser functions that are integral to the MediaWiki software. Other parser functions may be added by MediaWiki extensions such as the Extension:ParserFunctions. For those see Help:Extension:ParserFunctions.
[Expensive] Outputs the protection level (e.g. "autoconfirmed", "sysop") for a given action (e.g. "edit", "move") on the specified page. Returns an empty string if not protected.
[Expensive] Outputs the protection expiry (e.g. "20160418155030", "infinity") for a given action (e.g. "edit", "move") on the specified page. Returns "infinity" if not protected.
[Expensive] Returns the sources of any cascading protection acting on the specified page. Pages will not return their own title unless they transclude themselves.
*When the given param is equal to the current title of the parser, the parser function will yield the previous versions on preview and on substitution, that includes empty strings when used on page creation but using the values from the viewed version for page view, including viewing old revisions. In this case it is a non-expensive parser function.
URL data
Parser function
Input → Output
Description
Versions
{{localurl:page name}} {{localurl:page name |query_string}}
A protocol-relative path to the title, which depends on the $wgServer configuration setting for the local wiki (and so may or may not start with http(s)://). This will also resolve interwiki prefixes. Note: Unbracketed (plain) protocol-relative links are not automagically linked.
≥ 1.5
{{canonicalurl:page name}} {{canonicalurl:page name |query_string}} {{canonicalurl:interwiki:remote page name |query_string}}
{{urlencode:string}} or {{urlencode:string|QUERY}} {{urlencode:string|WIKI}} {{urlencode:string|PATH}}
{{urlencode:x:y/z á é}} or {{urlencode:x:y/z á é|QUERY}} → x%3Ay%2Fz+%C3%A1+%C3%A9 {{urlencode:x:y/z á é|WIKI}} → x:y/z_%C3%A1_%C3%A9 {{urlencode:x:y/z á é|PATH}} → x%3Ay%2Fz%20%C3%A1%20%C3%A9
Note that the default changed from |WIKI to |QUERY in 1.17; this may break templates that rely on this function.
The input encoded for use in URLs. Note that there is no urldecode function like there is in the obsolete Extension:StringFunctions
{{ns:}} returns the current localized name for the namespace with that index, canonical name, or local alias.
Thus {{ns:6}}, {{ns:File}}, and {{ns:Image}} (an old name for the File namespace) all return "File".
On a wiki where the content language is French, {{ns:Fichier}} is also valid, but {{ns:Datei}} (the localisation of "File" in German) is not.
The main namespace has no name, i.e. {{ns:0}} returns an empty string.
For explicitly referring to the main namespace, {{int:Blanknamespace}} can be used, resulting in "(Main)".
{{nse:}} is the equivalent encoded for MediaWiki URLs. It does the same, but it replaces spaces with underscores, making it usable in external links.
Unsupported: {{formatnum:{{formatnum:987.654.321}}}} → 987 654 321 (e.g. with Italian locale)
Examples of wrong input (unreliable output), with or without |R: {{formatnum:987,654.321|R}} (the least broken) {{formatnum:987.654,321|R}} {{formatnum:987 654,321|R}} {{formatnum:987 654,321|R}}
Takes an unformatted number (Arabic, no group separators and . as decimal separator) and outputs it in the localized digit script and formatted with decimal and decimal group separators, according to the page language.
The |R parameter can be used to reverse the behavior, for use in mathematical situations: it's reliable and should be used only to deformat numbers which are known to be formatted exactly as formatnum formats them with the wiki's locale.
The NOSEP ("no separators") parameter means that no group / decimal separators are changed; formatnum will only transform the digits themselves in languages which don't use the Hindu–Arabic numeral system. NOSEP can also prevent non-standard digit groupings you wouldn't expect.
Warning:
Leading zeroes are not removed, you can use {{#expr:00001}} instead if you have Extension:ParserFunctions installed.
Warning:
If you don't input numbers in the exact format required, don't expect any reliable output, especially on non-English wikis.
If you really need to format (according the wiki's locale) a number in unknown input format, you could try and use formatnum two times (but not if it can have a decimal group, or its separator will be eaten or the number won't be formatted). Be aware that this is more a hack than a regular way to proceed, thus the output may be not reliable.
{{#dateformat:25 dec 2009|ymd}}
→ 2009 December 25 (your pref), 2009 December 25 (default) {{#formatdate:dec 25,2009|dmy}}
→ 25 December 2009 (your pref), 25 December 2009 (default) {{#dateformat:2009-12-25|mdy}}
→ December 25, 2009 (your pref), December 25, 2009 (default) {{#formatdate:2009 dec 25|ISO 8601}}
→ 2009-12-25 (your pref), 2009-12-25 (default) {{#dateformat:25 decEmber|mdy}}
→ December 25 (your pref), December 25 (default) Note: In the examples above, "your pref" refers to your date preference on the current MediaWiki wiki only.
Formats an unlinked date based on user "date format" preference, and adds metadata tagging it as a formatted date. For logged-out users and those who have not set a date format in their preferences, dates can be given a default: mdy, dmy, ymd, ISO 8601 (all case sensitive). If only the month and day are given, only mdy and dmy are valid. If a format is not specified or is invalid, the input format is used as a default. If the supplied date is not recognized as a valid date (specifically, if it contains any metadata such as from a nested use of these or similar templates), it is rendered unchanged, and no (additional) metadata is generated.
Warning:
Although the ISO 8601 standard requires that dates be in the Gregorian calendar, the ISO parameter in this function will still format dates that fall outside the usual Gregorian range (e.g. dates prior to 1583). Also, the magic word cannot properly convert between negative years (used with ISO 8601) and years BC or years BCE (used in general writing).
{{padleft:xyz|5|_}} → __xyz {{padleft:xyz|5|abc}} → abxyz {{padleft:xyz|2}} → xyz {{padleft:|1|xyz}} → x
(first character of the string)
Inserts a string of padding characters (character chosen in third parameter; default "0") of a specified length (second parameter) next to a chosen base character or variable (first parameter). The final digits or characters in the base replace the final characters in the padding; i.e. {{padleft:44|3|0}} produces 044. The padding string may be truncated if its length does not evenly divide the required number of characters.
Only the first character of the third parameter is used in versions up to 1.12, but by version 1.15, all the characters are used.
Bug (fixed in r45734): multibyte characters are interpreted as two characters, which can skew width. These also cannot be used as padding characters.
Wraps the text in a script-appropriate directionality marker (either left-to-right (U+202A) or right-to-left (U+202B)) and a pop directionality formatting character (U+202C), to ensure directionality safety when using a mix of scripts in running text.
Here are the magic words which are used as main localisation tools. Other magic words will often depend on the wiki's locale and configuration or on the chosen language: see in particular #Date and time, and #Formatting. More magic words are added by the Extension:Translate.
The usage of these magic words can be very complex, and the documentation is currently incomplete; there's some more info on PLURAL, GRAMMAR, GENDER.
Usage
Input → Output
Description
Version
{{#language}} {{#language:language code}} {{#language:language code|target language code}}
{{#language:ar}} → العربية {{#language:ar|en}} → Arabic
The full name of the language for the given language code: native name (language autonym) by default, name translated in target language if a target language code is specified. Extension:CLDR must be installed for the translation to work. If no argument is given, returns the name of the target language (for articles, the content language; for messages, the user language).
The IETF BCP-47 language tag for the given language code. If no argument is given, returns the tag of the target language (for articles, the content language; for messages, the user language).
The directionality for the given language code, either rtl or ltr. If the optional second argument is bcp47, then the first argument is interpreted as a BCP-47 language tag. If no argument is given, returns the directionality of the target language (for articles, the content language; for messages, the user language).
{{PLURAL:0|is|are}} → are {{PLURAL:1*1|is|are}} → is {{PLURAL:21 mod 10|is|are}} → are {{PLURAL:{{#expr:21 mod 10}}|is|are}} → is {{PLURAL:1|is|are}} → is {{PLURAL:2|is|are}} → are {{PLURAL:-1|is|are}} → is {{PLURAL:-2|is|are}} → are {{PLURAL:0.5|is|are}} → are {{PLURAL:1.5|is|are}} → are {{PLURAL:-0.5|is|are}} → are {{PLURAL:-1.5|is|are}} → are (For Russian) {{PLURAL:5|1=Категория|Категории}} → Категории
Outputs a plural form appropriate for the given language. For English, the singular form (second parameter) is used if the absolute value of the first parameter is an expression equalling one; and the the plural form (third parameter) is used otherwise. See further documentation on translatewiki.net
Some language codes (ab, av, ba, bxr, ce, crh_cyrl, cv, inh, koi, krc, kv, lbe, lez, mhr, mrj, myv, ru, sl, tt_cyrl, tyv, udm, xal) used 3 plural forms (updated 01.2014):
Outputs the correct inflected form of the given word described by the inflection code after the colon. Grammar transformations are used for inflected languages like Polish. See also $wgGrammarForms, and grammar documentation on translatewiki.net.
≥ 1.7
{{GENDER:username|text for every gender}}
{{GENDER:Username|male text|female text|text for unspecified}} {{GENDER:|male text|female text|text for unspecified}} {{GENDER:.|male text|female text|text for unspecified}}
Note: The first example is basically a no-op Note: If 3rd parameter is omitted and user hasn't defined their gender, then text if user is male is returned. A blank username field ({{GENDER:|) means the current user, but can be used only in interface messages (MediaWiki namespace).
A dot username (.) means the default user gender on this wiki.
{{int:edit}} → Edit (Depends on user language; try: fr • ja)
Internationalizes (translates) the given interface (MediaWiki namespace) message into the user language. For msgnw and other transclusion magic words, see the Transclusion modifiers section.
Note that this can damage / confuse cache consistency in MediaWiki 1.17 and earlier, see T16404.
You may also use parameters with translations. Parameters are designated in messages with: $1, $2, $3, etc. For example, here is the message for editsectionhint: Edit section: $1 In this example, MediaWiki replaces $1.
Transclusion modifiers
{{Page name|optional params}} usually transcludes another page, by default from the Template:namespace.
These magic words modify that behavior.
Usage
Description
Version
{{:xyz}}
A bare colon is not a template modifier but the prefix for the main namespace. Since transclusion defaults to the Template namespace, you would use for example, {{:UTC}} (vs. {{UTC}}) to include the text of the main namespace article UTC rather than Template:UTC.
{{int:xyz}}
Same as {{MediaWiki:xyz}}, except standard message translation is applied depending on subpages and content/user/uselang language. Another difference is: this doesn't appear under "Templates used on this page:". Rendered as ⧼xyz⧽ if MediaWiki:xyz doesn't exist. See also Help:System message.
{{msg:xyz}} {{raw:xyz}}
Even if there is a magic word named "xyz", use template:xyz unless the template doesn't exist (equivalent to {{template:xyz}}). Normally, magic words have priority when there is a conflict.
{{raw:xyz}}
If $wgEnableScaryTranscluding is enabled, and this is an interwiki transclusion, include the raw wikitext instead of the html from the foreign wiki.
{{#tag:ref|Citation on Magic words. |name = "multiple"}}
→
[1]
Alias for XML-style MediaWiki parser tags or extension tags. It allows a pre-save transform of wiki code and Extension:ParserFunctions within tags before the tag is processed. It also prevents parsing of tags in conditional paths that aren't executed (like in #if statements). Content between tags is passed as the first parameter, and any attributes for the tags can be passed as subsequent parameters. This example:
You must write {{#tag:tagname||attribute1=value1|attribute2=value2}} to pass an empty content. No leading or trailing space of the text content are permitted between the pipe characters || before attribute1.
Warning:
For the <inputbox> tag, do NOT separate the parameters with pipes -- this won't work. You need to supply everything as the first parameter, with individual lines separated by breaks and not pipes, as you do when using the inputbox tag normally with <inputbox></inputbox>.
Warning: