 |
This help page is a how-to guide.
It details processes or procedures of some aspect(s) of Wikipedia's norms and practices. It is not one of Wikipedia's policies or guidelines, and may reflect varying levels of consensus and vetting. |
Magic words (including parser functions, variables and behavior switches) are features of wiki markup that give instructions to Wikipedia's underlying MediaWiki software. For example, magic words can suppress or position the table of contents, disable indexing by external search engines, and produce output dynamically based on the current page or on user-defined conditional logic. Some of these features are especially useful for templates.
This page is a quick reference for magic words. For more information, refer to the main MediaWiki documentation:
In general, there are three types of magic words.
__NOTOC__. They will change the behavior of a page, rather than return a value.{{#ifexpr:Y|Yes|No}}, wrapped in double braces. They will take a value and return a value.{{PAGENAME}}. A variable will be wrapped in double braces and will return a value in its place.The software generally interprets magic words in the following way:
<nowiki> tags remove this magic so a magic word can itself be displayed (documented), e.g. <nowiki>{{#magic:}}</nowiki>or{{#magic:<nowiki/>}}.Magic words compared to templates:
#(pound or hash), but template names will not start with a #, and probably not end in a :(colon), or be all-uppercase.{{#magic: p1 | p2 | p3}}, the name is #magicand it is followed by an unspaced :and a required input parameter, p1. With a template, p1is optional and it is preceded by a |(pipe) instead of a :, e.g. {{template|p1}}.Most magic words can be used in any needed locations on a page; see MOS:ORDER for guidance on where to place magic words that are behavior switches.
| Switch | Description |
|---|---|
| __TOC__ | Places the page's table of contents (TOC) at the word's position. This magic word does not work in skins that present the table of contents outside the article content e.g. the default Vector 2022 skin. |
| __FORCETOC__ | Forces the TOC to appear in its default position, even when there are fewer than four headings. Can be used anywhere on a page. This magic word does not work in skins that present the table of contents outside the article content e.g. the default Vector 2022 skin. |
| __NOTOC__ | Suppresses the appearance of the page's TOC. Can be used anywhere on a page. |
| __NOEDITSECTION__ | Hides the "edit" links normally beside all headings on the page. To hide the edit link beside a particular heading, specify the heading using e.g. an HTML tag such as <h2>heading</h2> rather than with the usual wiki equals-signs syntax (e.g. == heading == ).
|
| __ARCHIVEDTALK__ | Hides the "Reply" button |
| __NEWSECTIONLINK__ | On non-talk pages, adds a "New section" link as a means to add a new section to the page. |
| __NONEWSECTIONLINK__ | Removes the "New section" link (the add-new-section link) on talk pages. |
| __NOGALLERY__ | Replaces thumbnails on a category page with normal links. |
| __HIDDENCAT__ | Makes a category hidden when included on that category's page. |
| __INDEX__ | Instructs search engines to index the page. |
| __NOINDEX__ | Instructs search engines not to index the page. See Wikipedia:Controlling search engine indexing. |
| __STATICREDIRECT__ | Prevents the link on a redirection page from being updated automatically when the page to which it redirects is moved (and "Update any redirects that point to the original title" is selected). |
| __DISAMBIG__ | Marks a page as a disambiguation page, adds it to Special:DisambiguationPages and places inward links in Special:DisambiguationPageLinks. (See mw:Extension:Disambiguator.) |
| {{DISPLAYTITLE:title}} | Used to amend the displayed form of the page's title. |
| {{DEFAULTSORT:sortkey}} | Sets the default key (the index) under which the page is categorised. Functionality is documented at Help:Category § Default sort key, and guidelines are at Wikipedia:Categorization § Sort keys. |
| {{NOEXTERNALLANGLINKS}} | (equivalent to {{NOEXTERNALLANGLINKS:*}} ) Suppresses the automated inclusion of Wikidata interlanguage links on the lefthand side of the page. Links to particular rather than all languages may be suppressed by using {{NOEXTERNALLANGLINKS:list}}, where listapipe-delimited list of language codes (e.g. {{NOEXTERNALLANGLINKS:fr|es|ja}} to suppress the French ("fr"), Spanish ("es") and Japanese ("ja") interlanguage links). |
| Page name variable | Output | Description |
|---|---|---|
| {{FULLPAGENAME}} | Help:Magic words | Canonical page name. Title line. Title unless letter-case is altered with {{DISPLAYTITLE}}.[a]
|
| {{PAGENAME}} | Magic words | Title line excluding namespace. |
| {{BASEPAGENAME}} | Magic words | Title of parent page, excluding namespace. |
| {{ROOTPAGENAME}} | Magic words | Title of topmost parent (before all subpages), excluding namespace. |
| {{SUBPAGENAME}} | Magic words | On a subpage, rightmost portion of current title; higher subpagenames show as backlinks. |
| {{ARTICLEPAGENAME}} | Help:Magic words | Title of the subject page associated with the current page. These are useful on talk pages (but see note about Category talk pages). |
| {{SUBJECTPAGENAME}} | Help:Magic words | |
| {{TALKPAGENAME}} | Help talk:Magic words | Title of the talk page associated with the current page. Useful on subject pages. |
| {{NAMESPACENUMBER}} | 12 | Number of the current page's namespace. |
| {{NAMESPACE}} | Help | Namespace of the title. |
| {{ARTICLESPACE}} | Help | On a talk page, the namespace part of the title of the associated subject page. |
| {{SUBJECTSPACE}} | Help | |
| {{TALKSPACE}} | Help talk | Namespace of the talk page associated with the current page. |
{{FULLPAGENAMEE}}, |
Help:Magic_words, |
Adding an E to the end of the above variables, renders the above encoded for use in MediaWiki URLs (i.e. with underscores replacing spaces). |
| {{SHORTDESC}} | Only works on the English Wikipedia, where it displays a short description below the article title on mobile platforms. See Wikipedia:Short description. |
Note: The magic words above can also take a parameter, in order to parse values on a page other than the current page. A colon (:) is used to pass the parameter, rather than a pipe (|) that is used in templates, like {{MAGICWORD:value}}. For example, {{TALKPAGENAME:Wikipedia:MOS}} returns Wikipedia talk:MOS on any page.
Note: In the "Category" and "Category talk" namespaces, to wikilink (some) page name variables may require prefixing a colon to avoid unwanted categorization.
For more details on parser functions that relate to page names and namespaces, see: meta:Help:Page name § Variables and parser functions.
| Site variable | Output | Description |
|---|---|---|
| {{SITENAME}} | Wikipedia | Site name ($wgSitename). |
| {{SERVER}} | //en.wikipedia.org | Domain URL ($wgServer). |
| {{SERVERNAME}} | en.wikipedia.org | Subdomain and domain name. |
| {{ARTICLEPATH}} | /wiki/$1 | Relative article path ($wgArticlePath). |
| {{SCRIPTPATH}} | /w | Relative script path ($wgScriptPath). |
| {{STYLEPATH}} | /w/skins | Relative style path ($wgStylePath). |
| {{CURRENTVERSION}} | 1.43.0-wmf.8 (f95d369) | Returns current MediaWiki version. |
| Universal time | Local-website time | ||
|---|---|---|---|
| Variable | Output | Variable | Output |
| {{CURRENTYEAR}} | 2024 | {{LOCALYEAR}} | 2024 |
| {{CURRENTMONTH}} | 06 | {{LOCALMONTH}} | 06 |
| {{CURRENTMONTHNAME}} | June | {{LOCALMONTHNAME}} | June |
| {{CURRENTMONTHABBREV}} | Jun | {{LOCALMONTHABBREV}} | Jun |
| {{CURRENTDAY}}[b] | 11 | {{LOCALDAY}}[b] | 11 |
| {{CURRENTDAY2}}[b] | 11 | {{LOCALDAY2}}[b] | 11 |
| {{CURRENTDOW}} | 2 | {{LOCALDOW}} | 2 |
| {{CURRENTDAYNAME}} | Tuesday | {{LOCALDAYNAME}} | Tuesday |
| {{CURRENTTIME}} | 23:33 | {{LOCALTIME}} | 23:33 |
| {{CURRENTHOUR}} | 23 | {{LOCALHOUR}} | 23 |
| {{CURRENTWEEK}} | 24 | {{LOCALWEEK}} | 24 |
| {{CURRENTTIMESTAMP}}[c] | 20240611233300 | {{LOCALTIMESTAMP}}[c] | 20240611233300 |
| Variable | Output |
|---|---|
| {{REVISIONDAY}}[b] | 7 |
| {{REVISIONDAY2}}[b] | 07 |
| {{REVISIONMONTH}} | 06 |
| {{REVISIONYEAR}} | 2024 |
| {{REVISIONTIMESTAMP}}[c] | 20240607070030 |
| {{REVISIONUSER}}[d] | Nickps |
| {{NUMBEROFPAGES}} | 60,847,738 |
|---|---|
| {{NUMBEROFARTICLES}} | 6,834,263 |
| {{NUMBEROFFILES}} | 918,293 |
| {{NUMBEROFEDITS}} | 1,223,816,115 |
| {{NUMBEROFUSERS}} | 47,532,074 |
| {{NUMBEROFADMINS}} | 856 |
| {{NUMBEROFACTIVEUSERS}} | 117,529 |
| Function | Description |
|---|---|
| {{PAGEID}} | Unique page identifier number (for example, this page's ID is 3235121). |
| {{PAGESIZE:fullpagename}}[e] | Size of named page in bytes (for example, this page is 35,183 bytes). |
| {{PROTECTIONLEVEL:action|fullpagename}} | Protection level assigned to action ("edit", "move", etc.) on named page (this page's protection level for "edit" is autoconfirmed). |
| {{PROTECTIONEXPIRY:action|fullpagename}} | Protection expiry assigned to action ("edit", "move", etc.) on named page (this page's protection expiry is infinity). |
| {{PENDINGCHANGELEVEL:fullpagename}} | Protection level for pending changes on the named page (this page, which doesn't have one, is ). |
| {{PAGESINCATEGORY:categoryname}} | Number of pages in the category named categoryname. Each subcategory is counted as one item. |
| {{NUMBERINGROUP:groupname}} | Number of users in the user group named groupname. |
Page IDs can be associated with articles via wikilinks (i.e. Special:Redirect/page/3235121goes to this page).
To output numbers without comma separators (for example, as "123456789" rather than "123,456,789"), append the parameter |R.
| Function | Description |
|---|---|
| {{lc:string}} | Converts all characters in string to lower case. |
| {{lcfirst:string}} | Converts first character of string to lower case. |
| {{uc:string}} | Converts all characters in string to upper case. |
| {{ucfirst:string}} | Converts first character of string to upper case. |
| {{formatnum:unformatted_number}} {{formatnum:formatted_num |R}} |
Adds comma separators to an unformatted_number (e.g. 123456789 becomes 123,456,789). To remove such formatting, use {{formatnum:formatted_number|R}} (i.e. {{formatnum:7,654,321|R}}, for example, produces 7654321). |
| {{#dateformat:date|format}} {{#formatdate:date|format}} |
Formats a date according to user preferences; a default can be given as an optional case-sensitive second parameter for users without date preference; can convert a date from an existing format to any of dmy, mdy, ymd, or ISO 8601 formats, with the user's preference overriding the specified format.
|
| {{padleft:xyz|stringlength}} {{padright:xyz|stringlength}} {{padleft:xyz|length|padstr}} {{padright:xyz|length|padstr}} |
Pad with zeroes '0' to the right or left, to fill the given length; an alternative padding string can be given as a third parameter; the repeated padding string (padstr) will be truncated if its length does not evenly divide the required number of characters. |
| {{plural:N|singular|plural}} | Outputs singularifN is equal to 1, otherwise outputs plural. See the documentation at mediawiki.org for more details. |
| {{#time:format|object}} {{#timel:format|object}} {{#time:d F Y|date|langcode}} |
Used to format dates and times, for ISO format, dots or English month names. #timel is based on local time as defined for each wiki; for English Wikipedia, this is identical to #time. The optional 3rd parameter is the output language code (French, German, Swedish: fr, de, sv, etc.). Example Finnish: {{#time:d F Y|June 30, 2016|fi}} shows: 30 kesäkuu 2016 (June). ISO to German: {{#time:d. M Y|1987-10-31|de}} shows: 31. Okt. 1987. For format codes, see: mw:Help:Extension:ParserFunctions##time. Use the format {{#time: H:i, j F Y (e)|...}} to match the format used by timestamps in signatures. |
| {{gender:user|m_out|f_out|u_out}} | Outputs m_out, f_outoru_out according to whether the gender specified in user 's preferences is, respectively, male, female or unspecified. Other parameter permutations are available, see mw:Help:Magic words#gender and translatewiki:Gender. |
| {{#tag:tagname|content with magic}} | Only way to evaluate magic words inside a tag, in order to generate <tagname>magic</tagname>. Also handles tag attributes. Details at mw:Help:Magic words#tag.
|
| Function | Description |
|---|---|
| {{localurl:fullpagename |query}} | Relative path to page name. The query parameter is optional. |
| {{fullurl:fullpagename |query}} | Absolute path, without protocol prefix (i.e. without " http: " etc.), to page name. The query parameter is optional. |
| {{canonicalurl:fullpagename |query}} | Absolute path, including protocol prefix, to page name. The query parameter is optional. |
| {{filepath:filename}} | Absolute path to the media file filename. |
| {{urlencode:string}} | Encodes string for use in URL query strings; {{urlencode:test string}}, for example, produces: test+string. To encode string for use in URL paths or MediaWiki page names, append, respectively, |PATHor|WIKI (to produce "test%20string" or "test_string").
|
| {{anchorencode:string}} | Input encoded for use in MediaWiki URL section anchors. |
| {{ns:n}} | Returns the name of the namespace whose index is the number n. For MediaWiki URLs, use {{nse:}}. |
| {{#rel2abs:path}} | Converts a relative file path to an absolute path. |
| {{#titleparts:fullpagename|number|first segment}} | Splits the fullpagename (title) into that number of segments. |
| Function | Description |
|---|---|
| {{#expr:expression}} | Evaluates expression (see m:Help:Calculation). |
| {{#if:string |result1 |result2}} | Outputs result2ifstringisempty, otherwise outputs result1. |
| {{#ifeq:string1|string2 |result1 |result2}} | Outputs result1ifstring1 and string2 are equal (alphabetically or numerically), otherwise outputs result2. |
| {{#iferror:test_string |result1 |result2}} | Outputs result1iftest_string generates a parsing error, otherwise outputs result2. |
| {{#ifexpr:expression |result1 |result2}} | Outputs result1ifexpression is true, otherwise outputs result2. |
| {{#ifexist:pagetitle |result1 |result2}}[e] | Outputs result1 if the page [[pagetitle]] exists, otherwise outputs result2. Note that underscores are needed for spaces in namespaces. |
| {{#switch:string |c1=r1 |c2=r2 ... |default}} | Outputs r1ifstringisc1, r2ifstringisc2, etc., otherwise outputs default (if provided). |
If, in these conditional functions, empty unnamed parameters are to be parsed as empty rather than as text (i.e. as empty rather than as the text "{{{1}}}", "{{{2}}}", etc.), they will require trailing pipes (i.e. {{{1|}}}, {{{2|}}}, etc., rather than {{{1}}}, {{{2}}}, etc.).
| Function | Description |
|---|---|
| {{#babel:code1|code2|...}} | Render userboxes telling your language skills. Improves upon {{Babel}} (an alternative). |
| {{#categorytree:category|...}} | List pages in a category, recursively. |
| {{#coordinates:arg1|arg2|...}} | Save the GeoData coordinates of the subject to the page's database. Used in {{coord}}. |
| {{#invoke:module|function|arg1|...}} | Use Scribunto to transclude a lua template, e.g. function replaceinmodule String. |
| {{#language:code1|code2}} | Print the name represented by the language code, e.g. en → English. Print in language 2 if given, e.g. {{#language:en|zh}} prints 英语 |
| {{#lst:}}, {{#lsth:}}, {{#lstx:}} | Three ways to transclude a section of a page. |
| {{#mentor:Username}} | Display the currently assigned mentor for target Username, if set. |
| {{#property:arg1|arg2|...}} | Include a property (Wikidata) from a named entity, instead of the default on the page. |
| {{#related:...}} | Links to similar topics, to engage readers. (Beta feature.) |
| {{#section:}}, {{#section-h:}}, {{#section-x:}} | Aliases for {{#lst:}}, {{#lsth}}, {{#lstx}} (above). |
| {{#statements:arg1|...}} | Display the value of any statement (Wikidata) included in an item. |
| {{#target:fullpagename}} | Send a message to a list of talk pages on the fullpagename, using the MassMessage function. |
| {{int:pagename}} | Transcludeaninterface message, i.e. a pagename in MediaWiki namespace |
| {{!}} | Used to include a pipe character as part of a template argument or table cell contents. Before this was added as a magic word, many wikis implemented this by creating Template:! with | as the content.
|
| {{=}} | Used to include an equal sign as part of a template argument or table cell contents. Before this was added as a magic word, many wikis implemented this by creating Template:= with = as the content.
|
Magic words can sometimes behave weirdly when substituted or nested. It's possible to subst some magic words (so that the page stops being updated if the value of the word changes). Here are some examples of how this works:
 ?
|
Code | Output |
|---|---|---|
 N
|
{{PAGESIZE}}
|
0 |
 Y
|
{{PAGESIZE:Help:Magic words}}
|
35,183 |
| Y
|
{{subst:PAGESIZE:Help:Magic words}}
|
35,183 |
| Y
|
{{PAGESIZE:{{FULLPAGENAME}}}}
|
35,183 |
| N
|
{{subst:PAGESIZE:{{FULLPAGENAME}}}}
|
0 |
| Y
|
{{PAGESIZE:{{subst:FULLPAGENAME}}}}
|
35,183 |
| Y
|
{{subst:PAGESIZE:{{subst:FULLPAGENAME}}}}
|
35,183 |
Syntax highlighter Wiki syntax highlighting{{#ifexist:}} expression while allowing redirects to be identified and parsed differently|
| |
|---|---|
Get personal technical help at the Teahouse, help desk, village pump (technical), talk pagesorIRC. | |
| General technical help |
|
| Special page-related |
|
| Wikitext |
|
| Links and diffs |
|
| Media files: images, videos and sounds |
|
| Other graphics |
|
| Templates and Lua modules |
|
| Data structure |
|
| HTML and CSS |
|
| Customisation and tools |
|
| Automated editing |
|
| |
