Jump to content

Help:Magic words

From mediawiki.org
(Redirected from Pagenamee)
PD Note: When you edit this page, you agree to release your contribution under the CC0. See Public Domain Help Pages for more info. PD

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:

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.

Word Description Versions
Table of contents
__NOTOC__ Hides the table of contents (TOC).
__FORCETOC__ 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 Including a section at the end).
1.7
__NONEWSECTIONLINK__ Removes the link beside the "Edit" tab on pages in talk namespaces.
1.15
r47522
Categories
__NOGALLERY__ 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).
1.13
__EXPECTUNUSEDCATEGORY__ Used on a category page, removes the category from Special:UnusedCategories.
1.33
Language conversion
__NOCONTENTCONVERT__
__NOCC__
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.
1.10
r1610
__END__ Explicitly marks the end of the article, to prevent MediaWiki from removing trailing whitespace. Removed in 19213.
1.1 – 1.8
__INDEX__ Tell search engines to index the page (overrides $wgArticleRobotPolicies but not robots.txt). It obeys $wgExemptFromUserRobotsControl variable.
1.14
__NOINDEX__ Tell search engines not to index the page (i.e. do not list in search engines' results). It obeys $wgExemptFromUserRobotsControl variable.
1.14
r37973
__STATICREDIRECT__ 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 ).
1.13
r37928
__EXPECTUNUSEDTEMPLATE__ Used on a template page, removes the page from Special:UnusedTemplates.

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.

1.43
Gerrit change 1064007
From Extensions
Extension Word Description Versions
GlobalUserPage __NOGLOBAL__ 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.
1.28
Disambiguator __DISAMBIG__ Identifies a disambiguation page.
1.21
Wikibase (client) __EXPECTED_UNCONNECTED_PAGE__ 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.
1.37.0
DiscussionTools __ARCHIVEDTALK__ Hides "reply" links from discussions on archived pages.
1.39
Gerrit change 738221
__NOTALK__ Makes a page in a talk namespace not be treated like a talk page.
1.39
Gerrit change 903247
ProofreadPage __EXPECTWITHOUTSCANS__ 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.
1.43.0-wmf.4
Gerrit change 1026897
Wikibase (client) {{NOEXTERNALLANGLINKS}} 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.

Variable Output Description Versions
Year
{{CURRENTYEAR}} 2024 Year
Month
{{CURRENTMONTH}}

{{CURRENTMONTH2}}

12 Month (zero-padded number)
{{CURRENTMONTH1}} 12 Month (unpadded number)
{{CURRENTMONTHNAME}} December Month (name)
{{CURRENTMONTHNAMEGEN}} December Month (genitive form)
{{CURRENTMONTHABBREV}} Dec Month (abbreviation)
1.5
Day
{{CURRENTDAY}} 22 Day of the month (unpadded number)
{{CURRENTDAY2}} 22 Day of the month (zero-padded number)
1.6
{{CURRENTDOW}} 0 Day of the week (unpadded number), 0 (for Sunday) through 6 (for Saturday)
{{CURRENTDAYNAME}} Sunday Day of the week (name)
Time
{{CURRENTTIME}} 19:10 Time (24-hour HH:mm format)
{{CURRENTHOUR}} 19 Hour (24-hour zero-padded number)
Other
{{CURRENTWEEK}} 51 Week (number)
{{CURRENTTIMESTAMP}} 20241222191050 YYYYMMDDHHmmss timestamp
1.7
{{CURRENTDATE}} is not a magic word but it might be a template.

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.

Technical metadata

Variable Output Description Versions
Site
{{SITENAME}} MediaWiki The wiki's site name ($wgSitename ).
{{SERVER}} //www.mediawiki.org Domain URL ($wgServer ).
{{SERVERNAME}} www.mediawiki.org 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 (&lrm; on left-to-right wikis, &rlm; on right-to-left wikis), useful in text with multi-directional text. Since 1.19, it depends on the page content language.
1.7
r14442
{{ARTICLEPATH}} /wiki/$1 Relative article path ($wgArticlePath ).
{{SCRIPTPATH}} /w Relative script path ($wgScriptPath ).
{{STYLEPATH}} /w/skins Relative style path ($wgStylePath ).
1.16
{{CURRENTVERSION}} 1.44.0-wmf.8 (f08e6b3) The wiki's MediaWiki version.
1.7
r14199
{{CONTENTLANGUAGE}}

{{CONTENTLANG}}

en

en

The wiki's default interface language ($wgLanguageCode ).
1.7
r14661
Page
{{PAGEID}} 1748 Returns the page identifier (page ID).
1.20
Gerrit change 9858
{{PAGELANGUAGE}}
{{#language:{{PAGELANGUAGE}}}}
en
English
Returns the language of the current page. The language code that this variable returns can be converted to a language name using {{#language:...}}.
1.29
Gerrit change 330982
{{TRANSLATABLEPAGE}} Help:Magic words 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.
1.41.0-wmf.8
Gerrit change 913677

<translate><!--T:1--> Translated unit. Language: <tvar name=lang>{{TRANSLATIONLANGUAGE}}</tvar>.</translate>

<translate><!--T:2--> Untranslated unit. Language: <tvar name=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.
1.36.0-wmf.8
Gerrit change 603472
{{PROTECTIONLEVEL:action}} 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.
1.15
r45587
{{PROTECTIONEXPIRY:action}} 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.
1.27
Gerrit change 255717
{{CASCADINGSOURCES}} [Expensive] Returns the sources of any cascading protection acting on the current page. Pages will not return their own title unless they transclude themselves.
1.23
Gerrit change 104999
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}} 18 Day edit was made (unpadded number).
1.8
{{REVISIONDAY2}} 18 Day edit was made (zero-padded number).
1.8
{{REVISIONMONTH}} 12 Month edit was made (zero-padded number as of 1.17+, unpadded number in prior versions).
1.8
{{REVISIONMONTH1}} 12 Month edit was made (unpadded number).
1.17
r66200
{{REVISIONYEAR}} 2024 Year edit was made.
1.8
{{REVISIONTIMESTAMP}} 20241218112733 Timestamp as of time of edit.
1.8
{{REVISIONUSER}} Waddie96 The username of the user who made the edit in question, or the user previewing an edit.
1.15
r48149
{{REVISIONSIZE}} 109430 The size (bytes of wikitext) of the viewed revision of the page or preview
1.22
Gerrit change 82650
Affects page content
{{DISPLAYTITLE:title}}
{{DISPLAYTITLE:title|noerror}}
{{DISPLAYTITLE:title|noreplace}}
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.

1.7
1.24
Gerrit change 144870

(for noerror and noreplace)

{{DEFAULTSORT:sortkey}}
{{DEFAULTSORTKEY:sortkey}}
{{DEFAULTCATEGORYSORT:sortkey}}
{{DEFAULTSORT:sortkey|noerror}}
{{DEFAULTSORT:sortkey|noreplace}}
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.
1.10
1.19
r96767

(for noerror and noreplace)

Localization

Variable Output Description Versions
{{USERLANGUAGE}} en 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}}.
1.43
Gerrit change 508295

Statistics

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,774,180 and {{NUMBEROFPAGES:R}} → 1774180).

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.

Variable Output Description Versions
{{NUMBEROFPAGES}} 1,774,180 Number of wiki pages.
1.7
{{NUMBEROFARTICLES}} 63,823 Number of pages in content namespaces that qualify as articles. See Manual:$wgArticleCountMethod for details.
{{NUMBEROFFILES}} 2,761 Number of uploaded files.
1.5
{{NUMBEROFEDITS}} 6,829,270 Number of wiki edits.
1.10
r21319
{{NUMBEROFVIEWS}} Number of page views. Usually useless on a wiki using caching. Removed in Gerrit change 150699.
1.14 – 1.24
r42721
{{NUMBEROFUSERS}} 18,035,211 Number of registered users.
1.7
{{NUMBEROFADMINS}} 139 Number of users in the sysop group .
1.7
{{NUMBEROFACTIVEUSERS}} 925 Number of active users, based on the criteria used in Special:Statistics.
1.15
r47392
{{PAGESINCATEGORY:categoryname}}
{{PAGESINCAT:categoryname}}
159
159
[Expensive] Number of pages (including subcategories and files) in the given category. (Category:Help used for demonstration)
1.13
r32932
{{PAGESINCATEGORY:categoryname|all}}
{{PAGESINCATEGORY:categoryname|pages}}
{{PAGESINCATEGORY:categoryname|subcats}}
{{PAGESINCATEGORY:categoryname|files}}
159
156
3
0
[Expensive] Respectively, the number of
  • all pages
  • ordinary pages (excluding subcategories and files)
  • subcategories or
  • files

in the given category. (Category:Help used for demonstration)

1.20
Gerrit change 12790
{{NUMBERINGROUP:groupname}}
{{NUMINGROUP:groupname}}
23
23
Number of users in a specific group . (bureaucrat used for demonstration)
1.14
r40116
{{PAGESINNS:index}}
{{PAGESINNAMESPACE:index}}
Not enabled [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.

For more complex splitting, use {{#titleparts:}} from the ParserFunctions extension.

1.6
{{SUBJECTPAGENAME}}
{{ARTICLEPAGENAME}}
Help:Magic words
Help:Magic words
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 Warning: If the page title contains any parts that are "." or "..", the magic word returns nothing.
{{PAGENAME:one/./three}}Nothing is returned.
Warning 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.

URL encoded page names

The following are equivalents encoded for use in MediaWiki URLs (i.e. spaces replaced with underscores and some characters HTML escaped using numeric character encoding):

  • {{FULLPAGENAMEE}}
  • {{PAGENAMEE}}
  • {{BASEPAGENAMEE}}
  • {{SUBPAGENAMEE}}
  • {{SUBJECTPAGENAMEE}}
  • {{ARTICLEPAGENAMEE}}
  • {{TALKPAGENAMEE}}
  • {{ROOTPAGENAMEE}}

Note that {{PAGENAME:...}}, {{PAGENAMEE:...}} and {{urlencode:...}} have distinct implementations. See Manual:PAGENAMEE encoding for details.

Namespaces

Variable Output Description Versions
{{NAMESPACE}} Help Name of the page's namespace (except for main space)
{{NAMESPACENUMBER}} 12 ID of the page's namespace
1.20
Gerrit change 4056
{{SUBJECTSPACE}}
{{ARTICLESPACE}}
Help
Help
Name of the associated content namespace
1.7
{{TALKSPACE}} Help talk Name of the associated talk namespace
1.7

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)
  • {{NAMESPACE:Template:Main Page}}Template
  • {{SUBJECTSPACE:Template talk:Main Page}}Template
  • {{ARTICLESPACE:Template talk:Main Page}}Template
  • {{TALKSPACE:Template:Main Page}}Template talk

Parameter must not be a namespace name:

  • {{SUBJECTSPACE:Help talk}} → ' (Empty)

Escaped characters

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> .

Syntax Output Description Versions
{{!}} |

Used to include a vertical bar (pipe).

For historical and technical reasons, this function is not considered an actual escape sequence. Instead of using the vertical bar, the syntax employs an exclamation mark, which visually resembles a vertical bar. See Help:Extension:ParserFunctions#Escaping pipe characters in tables for additional details.

Before this capability was introduced as a magic word, many wikis achieved this effect by creating a template (Template:!) that simply returned | as its content.

1.24
Gerrit change 136234
{{=}} =

Used to include an equal sign.

See Help:Extension:ParserFunctions#Raw equal signs for further explanation.

Before this was added as a magic word, many wikis implemented this by creating Template:= with = as the content.

1.39
Gerrit change 791685


Parser functions

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 .

Technical metadata of another page

Parser function Output
(for page MediaWiki)
Description Versions
{{PAGEID: page name }} 1 [Expensive] Returns the page identifier of the specified page*.
1.23
Gerrit change 76534
{{PAGESIZE:page name}}
{{PAGESIZE: page name |R}}
109,430
109430
[Expensive] Returns the byte size of the specified page. Use "|R" to get raw (unformatted) numbers.
1.13
r33551
{{PROTECTIONLEVEL:action | page name}} sysop [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.
1.21
r44683
{{PROTECTIONEXPIRY: action | page name}} infinity [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.
1.27
Gerrit change 255717
{{CASCADINGSOURCES: page name}} [Expensive] Returns the sources of any cascading protection acting on the specified page. Pages will not return their own title unless they transclude themselves.
1.23
Gerrit change 104999
{{REVISIONID: page name }} 6287429 [Expensive] Unique revision ID of the last revision on the specified page*.
1.23
Gerrit change 76534
{{REVISIONDAY: page name }} 29 [Expensive] Day of edit from the last revision of the specified page* (unpadded number).
1.23
Gerrit change 76534
{{REVISIONDAY2: page name }} 29 [Expensive] Day of edit from the last revision of the specified page* (zero-padded number).
1.23
Gerrit change 76534
{{REVISIONMONTH: page name }} 12 [Expensive] Month of edit from the last revision of the specified page* (zero-padded number as of 1.17+, unpadded number in prior versions).
1.23
Gerrit change 76534
{{REVISIONMONTH1: page name }} 12 [Expensive] Month of edit from the last revision of the specified page* (unpadded number).
1.23
Gerrit change 76534
{{REVISIONYEAR: page name }} 2023 [Expensive] Year of edit from the last revision of the specified page*.
1.23
Gerrit change 76534
{{REVISIONTIMESTAMP: page name }} 20231229181425 [Expensive] Timestamp as of time of edit on the specified page*.
1.23
Gerrit change 76534
{{REVISIONUSER: page name }} Tropicalkitty [Expensive] The username from the last revision on the specified page*.
1.23
Gerrit change 76534
*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}}
{{localurl:MediaWiki}}
→ /wiki/MediaWiki
{{localurl:MediaWiki|printable=yes}}
→ /w/index.php?title=MediaWiki&printable=yes
The relative path to the title.
{{fullurl:page name}}
{{fullurl:page name
|query_string}}

{{fullurl:interwiki:remote page name
|query_string}}
{{fullurl:Category:Top level}}
→ //www.mediawiki.org/wiki/Category:Top_level

{{fullurl:Category:Top level|action=edit}}
→ //www.mediawiki.org/w/index.php?title=Category:Top_level&action=edit
{{fullurl:s:Electra|action=edit}}
https://en.wikisource.org/wiki/Electra?action=edit
{{fullurl:s:es:Electra|action=edit}}
https://en.wikisource.org/wiki/es:Electra?action=edit

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}}
{{canonicalurl:Category:Top level}}
https://www.mediawiki.org/wiki/Category:Top_level

{{canonicalurl:Category:Top level|action=edit}}
https://www.mediawiki.org/w/index.php?title=Category:Top_level&action=edit {{canonicalurl:w:Category:Top level|action=edit}}
https://en.wikipedia.org/wiki/Category:Top_level?action=edit

The absolute path to the title, using the canonical URL. This will also resolve interwiki prefixes.
1.18
{{filepath:file name}}
{{filepath:file name|nowiki}}
{{filepath:file name|thumbnail_size}}
{{filepath:Wiki.png}}
→ //upload.wikimedia.org/wikipedia/mediawiki/b/bc/Wiki.png

{{filepath:Wiki.png|nowiki}}
→ //upload.wikimedia.org/wikipedia/mediawiki/b/bc/Wiki.png
{{filepath:Example.svg|300}}
→ //upload.wikimedia.org/wikipedia/commons/thumb/8/84/Example.svg/300px-Example.svg.png

The parameter nowiki usually removes the link around the filepath (which can't be seen in this example).

A protocol-relative path to the full size or thumbnail (1.18+) of a media file.
1.12
r25854

1.18
r80813
{{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
Encoding
codespace
 none + 
QUERY + 
 WIKI _ 
 PATH%20
1.7
r14273
(or
1.17
r64726

1.17
r64726

1.17
r64726
)
{{anchorencode:string}} {{anchorencode:x y z á é}}
→ x_y_z_á_é
The input encoded for use in URL section anchors (after the “#” symbol in a URL).
1.6
r16279

The following are equivalents encoded for use in MediaWiki URLs (some characters percent-encoded):

  • {{localurle:page name}}
  • {{localurle:page name|query_string}}
  • {{fullurle:page name}}
  • {{fullurle:page name|query_string}}
  • {{fullurle:interwiki:remote page name|query_string}}
  • {{canonicalurle:page name}}
  • {{canonicalurle:page name|query_string}}
  • {{canonicalurle:interwiki:remote page name|query_string}}

Namespaces

{{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.

Content namespaces Talk namespaces
Usage Output Usage Output
{{ns:-2}} / {{ns:Media}} Media {{ns:-1}} / {{ns:Special}} Special
(no talk page)
{{ns:0}} / {{ns:}} {{ns:1}} / {{ns:Talk}} Talk
{{ns:2}} / {{ns:User}} User {{ns:3}} / {{ns:User talk}} User talk
{{ns:4}} / {{ns:Project}} Project
Varies between wikis
{{ns:5}} / {{ns:Project talk}} Project talk
{{ns:6}} / {{ns:File}} or {{ns:Image}} File {{ns:7}} / {{ns:File talk}} or {{ns:Image talk}} File talk
{{ns:8}} / {{ns:MediaWiki}} MediaWiki {{ns:9}} / {{ns:MediaWiki talk}} MediaWiki talk
{{ns:10}} / {{ns:Template}} Template {{ns:11}} / {{ns:Template talk}} Template talk
{{ns:12}} / {{ns:Help}} Help {{ns:13}} / {{ns:Help talk}} Help talk
{{ns:14}} / {{ns:Category}} Category {{ns:15}} / {{ns:Category talk}} Category talk

Don't confuse localised namespaces with custom namespaces.

Formatting

Usage Input → Output Description Version

{{formatnum:unformatted number}}
{{formatnum:formatnum-formatted number|R}}
{{formatnum:unformatted number|NOSEP}}

  • Simple:
    • {{formatnum:987654321.654321}}
      → 987,654,321.654321
    • {{formatnum:987,654,321.654321|R}}
      → 987654321.654321
  • Advanced:
    • {{formatnum:{{formatnum:987654321.654321}}|R}}
      → 987654321.654321 (on any locale)
    • {{formatnum:00001}}
      → 00,001
    • {{formatnum:987654321.654321 |NOSEP}}
      → 987654321.654321
    • Examples with Bangla locale:
      • {{formatnum:987654321.654321}}
        → ৯৮,৭৬,৫৪,৩২১.৬৫৪৩২১
      • {{formatnum:987654321.654321 |NOSEP}}
        → ৯৮৭৬৫৪৩২১.৬৫৪৩২১
      • {{formatnum:৯৮,৭৬,৫৪,৩২১.৬৫৪৩২১ |R}}
        → 987654321.654321

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&nbsp;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 Warning: Leading zeroes are not removed, you can use {{#expr:00001}} instead if you have Extension:ParserFunctions installed.

Warning 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.

1.7

1.13
r32012

{{#dateformat:date}}
{{#formatdate:date}}
{{#dateformat:date|format}}
{{#formatdate:date|format}}

{{#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 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).
1.15
r48249

{{lc:string}}

{{lc:DATA CENTER}} → data center The lowercase input.
1.5

{{lcfirst:string}}

{{lcfirst:DATA center}} → dATA center The input with the very first character lowercase.
1.5

{{uc:string}}

{{uc:text transform}} → TEXT TRANSFORM The uppercase input.
1.5

{{ucfirst:string}}

{{ucfirst:text tRAnSFORM}} → Text tRAnSFORM The input with the very first character uppercase.
1.5

{{padleft:xyz|stringlength}}
{{padleft:xyz|strlen|char}}
{{padleft:xyz|strlen|string}}

{{padleft:xyz|5}} → 00xyz

{{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.

1.8

1.15
r45734

{{padright:xyz|stringlength}}
{{padright:xyz|strlen|char}}
{{padright:xyz|strlen|string}}

{{padright:xyz|5}} → xyz00

{{padright:xyz|5|_}} → xyz__
{{padright:xyz|5|abc}} → xyzab
{{padright:xyz|2}} → xyz
{{padright:|1|xyz}} → x

Identical to padleft but adds padding characters to the right side.
1.8

1.15
r45734

{{bidi:string}}

{{bidi:text transform}} → ‪text transform‬

{{bidi:كتابة عربية}} → ‫كتابة عربية‬

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.

See also: Extension:StringFunctions .

Localization

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).
1.7
r14490

1.18
r91875
(translation)
1.43
Gerrit change 1038880
(with no argument)
{{#bcp47}}
{{#bcp47:language code}}
{{#bcp47:sr-ec}} → sr-Cyrl
{{#bcp47:zh-yue}} → yue
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).
1.43
Gerrit change 1038879
{{#dir}}
{{#dir:language code}}
{{#dir:language code|bcp47}}
{{#dir:en}} → ltr
{{#dir:he}} → rtl
{{#dir:sr-Cyrl|bcp47}} → ltr
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).
1.43
Gerrit change 1032542
{{PLURAL:2|is|are}} {{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=Категория|Категории}} → Категории


{{PLURAL:3|страница|страницы|страниц}} → страницы
{{PLURAL:5|страница|страницы|страниц}} → страниц

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):
  • Form 1: 1, 21, 31, 41, 51, 61, 71, 81, 101, 1001, …
  • Form 2: 0, 5, 6, 7, 8, …, 18, 19, 100, 1000, 10000, 100000, 1000000, …
  • Form 3: 2, 3, 4, 22, 23, 24, 32, 33, 34, 42, 43, 44, 52, 53, 54, 62, 102, 1002, …
{{GRAMMAR:N|noun}} 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}}

(Depends on the named user's gender) A switch for the gender set in Special:Preferences.

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.

1.15
r46247
{{int:message name}} {{int:edit}}Edit
(Depends on user language; try: frja)
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.

{{int:editsectionhint|MediaWiki}} {{int:editsectionhint|MediaWiki}}Edit section: MediaWiki 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.

Miscellaneous

See also