View source for Help:Magic Words

'''Magic words''' are strings of codes which associates with a return value or function, such as time, site details, or page names. This page is about usage of standard magic words.

Basically there are three types of magic words:
*'''[[Help:Magic Words#Behaviour_Switches|Behavior Switches]]'''. These are uppercase words surrounded by double underscores (eg __FOO__)
*'''[[Help:Magic Words#Variables|Variables]]'''. These are uppercase words surrounded by double braces (eg <nowiki>{{FOO}}</nowiki>).
*'''[[Help:Magic Words#Parser_Functions|Parametric or Parser Functions]]'''. These take parameters and are either of the form <nowiki>{{foo:...}}</nowiki> or <nowiki>{{#foo:...}}</nowiki>.

__TOC__

==Behaviour Switches==
A behaviour switch controls the layout or behaviour of the page and can often be used to specify desired omissions and inclusions in the content.

{|class="wikitable" border="1"

|-
! Word
!Description

|-
|colspan="3"| '''Table of contents'''
|-
| <nowiki>__NOTOC__</nowiki>
| Hides the table of contents (TOC).

|-
|<nowiki>__FORCETOC__</nowiki>
| Forces the table of content to appear at its normal position (above the first header).

|-
| <nowiki>__TOC__</nowiki>
| Places a table of contents at the word's current position (overriding <nowiki>__NOTOC__</nowiki>). If this is used multiple times, the table of contents will appear at the first word's position.

|-
|colspan="3"| '''Editing'''
|-
| <nowiki>__NOEDITSECTION__</nowiki>
| Hides the section edit links beside headings.

|-
| <nowiki>__NEWSECTIONLINK__</nowiki>
| Adds a link beside the "edit" tab for adding a new section on a non-talk page.

|-
| <nowiki>__NONEWSECTIONLINK__</nowiki>
| Removes the link beside the "edit" tab on pages in talk namespaces.

|-
|colspan="3"| '''Categories'''
|-
| <nowiki>__NOGALLERY__</nowiki>
| Used on a category page, replaces thumbnails in the category view with normal links.

|-
| <nowiki>__HIDDENCAT__</nowiki>
| Used on a category page, hides the category from the lists of categories in its members and parent categories (there is an option in the [[Help:Preferences|user preferences]] to show them).

|-
| colspan="3"| '''Language conversion'''
|-
| <nowiki>__NOCONTENTCONVERT__</nowiki><br /><nowiki>__NOCC__</nowiki>
| On wikis with language variants, don't perform any content language conversion (character and phase) in article display; for example, only show Chinese (zh) instead of variants like zh_cn, zh_tw, zh_sg, or zh_hk.

|-
| <nowiki>__NOTITLECONVERT__</nowiki><br /><nowiki>__NOTC__</nowiki>
| On wikis with language variants, don't perform language conversion on the title (all other content is converted).

|-
|colspan="3"| '''Other'''
|-
| <nowiki>__START__</nowiki>
| No effect.

|-
| <nowiki>__END__</nowiki>
| Explicitly marks the end of the article, to prevent MediaWiki from removing trailing whitespace.

|-
|  <nowiki>__INDEX__</nowiki>
| Tell search engines to index the page.

|- 
|  <nowiki>__NOINDEX__</nowiki>
| Tell search engines not to index the page (ie, do not list in search engines' results).

|-
|  <nowiki>__STATICREDIRECT__</nowiki>
| On redirect pages, don't allow wiki to automatically update the link when someone moves a page and checks "Update any redirects that point to the original title".

|}


==Variables== 

Variables return information about the current page, wiki, or date. Their syntax is similar to [[Help:Templates|templates]]. If a template name conflicts with a variable, the variable will be used (so to transclude the template [[{{ns:10}}:PAGENAME]] you would need to write <code><tt><nowiki>{{</nowiki>{{ns:10}}:PAGENAME<nowiki>}}</nowiki></tt></code>). In some cases, adding parameters will force the parser to treat a variable as a template; for example, <code><tt><nowiki>{{CURRENTDAYNAME|x}}</nowiki></tt></code> transcludes [[{{ns:10}}:CURRENTDAYNAME]].

===Date & time===
The following variables return the current date and time according to the user's timezone [[Special:Preferences|preferences]], defaulting to the UTC timezone.

Due to MediaWiki and browser caching, these variables frequently show when the page was ''cached'' rather than the current time.

{| {{prettytable}}
|-
!{{Hl2}}| Variable
!{{Hl2}}| Output
!{{Hl2}}| Description
!{{Hl2}}| Versions
|-
|{{Hl3}} colspan="4"| '''Year'''
|-
| <tt><nowiki>{{CURRENTYEAR}}</nowiki></tt>
| {{CURRENTYEAR}}
| Year
|
|-
|{{Hl3}} colspan="4"| '''Month'''
|-
| <tt><nowiki>{{CURRENTMONTH}}</nowiki></tt> 
| {{CURRENTMONTH}}
| Month (zero-padded number)
|
|-
| <tt><nowiki>{{CURRENTMONTHNAME}}</nowiki></tt>
| {{CURRENTMONTHNAME}}
| Month (name)
|
|-
| <tt><nowiki>{{CURRENTMONTHNAMEGEN}}</nowiki></tt>
| {{CURRENTMONTHNAMEGEN}}
| Month ([http://en.wikipedia.org/wiki/genitive genitive form])
|
|-
| <tt><nowiki>{{CURRENTMONTHABBREV}}</nowiki></tt>
| {{CURRENTMONTHABBREV}}
| Month (abbreviation)
| 1.5+
|-
|{{Hl3}} colspan="4"| '''Day'''
|-
| <tt><nowiki>{{CURRENTDAY}}</nowiki></tt>
| {{CURRENTDAY}}
| Day of the month (unpadded number)
|
|-
| <tt><nowiki>{{CURRENTDAY2}}</nowiki></tt>
| {{CURRENTDAY2}}
| Day of the month (zero-padded number)
| 1.6+
|-
| <tt><nowiki>{{CURRENTDOW}}</nowiki></tt>
| {{CURRENTDOW}}
| Day of the week (unpadded number)
|
|-
| <tt><nowiki>{{CURRENTDAYNAME}}</nowiki></tt>
| {{CURRENTDAYNAME}}
| Day of the week (name)
|
|-
|{{Hl3}} colspan="4"| '''Time'''
|-
| <tt><nowiki>{{CURRENTTIME}}</nowiki></tt>
| {{CURRENTTIME}}
| Time (24-hour HH:mm format)
|
|-
| <tt><nowiki>{{CURRENTHOUR}}</nowiki></tt>
| {{CURRENTHOUR}}
| Hour (24-hour zero-padded number)
|
|-
|{{Hl3}} colspan="4"| '''Other'''
|-
| <tt><nowiki>{{CURRENTWEEK}}</nowiki></tt>
| {{CURRENTWEEK}}
| Week (number)
|
|-
| <tt><nowiki>{{CURRENTTIMESTAMP}}</nowiki></tt>
| {{CURRENTTIMESTAMP}}
| YYYYMMDDHHmmss timestamp
| 1.7+
|}

The following variables do the same as the above, but using the site's local timezone instead of user preferences and UTC:
* <tt><nowiki>{{LOCALYEAR}}</nowiki></tt>
* <tt><nowiki>{{LOCALMONTH}}</nowiki></tt>
* <tt><nowiki>{{LOCALMONTHNAME}}</nowiki></tt>
* <tt><nowiki>{{LOCALMONTHNAMEGEN}}</nowiki></tt>
* <tt><nowiki>{{LOCALMONTHABBREV}}</nowiki></tt>
* <tt><nowiki>{{LOCALDAY}}</nowiki></tt>
* <tt><nowiki>{{LOCALDAY2}}</nowiki></tt>
* <tt><nowiki>{{LOCALDOW}}</nowiki></tt>
* <tt><nowiki>{{LOCALDAYNAME}}</nowiki></tt>
* <tt><nowiki>{{LOCALTIME}}</nowiki></tt>
* <tt><nowiki>{{LOCALHOUR}}</nowiki></tt>
* <tt><nowiki>{{LOCALWEEK}}</nowiki></tt>
* <tt><nowiki>{{LOCALTIMESTAMP}}</nowiki></tt>

===Technical metadata===
Revision variables return data about the '''latest edit to the current page''', even if viewing an older version of the page.
{| {{prettytable}}
|-
!{{Hl2}}| Variable
!{{Hl2}}| Output
!{{Hl2}}| Description
!{{Hl2}}| Versions
|-
|{{Hl3}} colspan="4"| '''Site'''
|-
| <tt><nowiki>{{SITENAME}}</nowiki></tt>
| {{SITENAME}}
| The wiki's site name ({{mediawiki|Manual:$wgSitename|$wgSitename}}).
|
|-
| <tt><nowiki>{{SERVER}}</nowiki></tt>
| {{SERVER}}
| domain URL ({{mediawiki|Manual:$wgServer|$wgServer}})
|
|-
| <tt><nowiki>{{SERVERNAME}}</nowiki></tt>
| {{SERVERNAME}}
| domain name ({{mediawiki|Manual:$wgServerName|$wgServerName}})
|
|-
| <tt><nowiki>{{DIRMARK}}</nowiki></tt><br /><tt><nowiki>{{DIRECTIONMARK}}</nowiki></tt>
| {{DIRMARK}}<br />{{DIRECTIONMARK}}
| Outputs a unicode-directional mark that matches the wiki's default language's direction (<code>&amp;lrm;</code> on left-to-right wikis, <code>&amp;rlm;</code> on right-to-left wikis), useful in text with multi-directional text.
| 1.7+
|-
| <tt><nowiki>{{SCRIPTPATH}}</nowiki></tt>
| {{SCRIPTPATH}}
| relative script path ({{mediawiki|Manual:$wgScriptPath|$wgScriptPath}})
|
|-
| <tt><nowiki>{{CURRENTVERSION}}</nowiki></tt>
| {{CURRENTVERSION}}
| The wiki's MediaWiki version.
| 1.7+
|-
| <tt><nowiki>{{CONTENTLANGUAGE}}</nowiki></tt>
| {{CONTENTLANGUAGE}}
| The wiki's default interface language ({{mediawiki|Manual:$wgLanguageCode|$wgLanguageCode}})
| 1.7+
|-
|{{Hl3}} colspan="4"| '''Latest revision to current page'''
|-
| <tt><nowiki>{{REVISIONID}}</nowiki></tt>
| {{REVISIONID}}
| Unique ID
| 1.5+
|-
| <tt><nowiki>{{REVISIONDAY}}</nowiki></tt>
| {{REVISIONDAY}}
| Day edit was made (unpadded number)
| 1.8+
|-
| <tt><nowiki>{{REVISIONDAY2}}</nowiki></tt>
| {{REVISIONDAY2}}
| Day edit was made (zero-padded number)
| 1.8+
|-
| <tt><nowiki>{{REVISIONMONTH}}</nowiki></tt>
| {{REVISIONMONTH}}
| Month edit was made (unpadded number)
| 1.8+
|-
| <tt><nowiki>{{REVISIONYEAR}}</nowiki></tt>
| {{REVISIONYEAR}}
| Year edit was made
| 1.8+
|-
| <tt><nowiki>{{REVISIONTIMESTAMP}}</nowiki></tt>
| {{REVISIONTIMESTAMP}}
| Timestamp as of time of edit
| 1.8+
|-
| <tt><nowiki>{{PAGESIZE:</nowiki>''page name''<nowiki>}}</nowiki></tt>
| {{PAGESIZE:Help:Magic_words}}
| Returns the byte size of the specified page.
| {{mediawiki|rev:33551|1.13+}}
|-
| <tt><nowiki>{{PROTECTIONLEVEL:</nowiki>''action''<nowiki>}}</nowiki></tt>
| protection level
| Outputs the protection level (e.g. 'autoconfirm', 'sysop') for a given action (e.g. 'edit', 'move') on the current page or an empty string if not protected.
| [[rev:45587|1.15+]]
|-
|{{Hl3}} colspan="4"| '''Affects page content'''
|-
| <tt><nowiki>{{DISPLAYTITLE:</nowiki>''title''<nowiki>}}</nowiki></tt>
|
| Format the current page's title header. The value must be equivalent to the default title: only capitalization changes and replacing spaces with underscores. It can be disabled or enabled by {{mediawiki|Manual:$wgAllowDisplayTitle|$wgAllowDisplayTitle}}; disabled by default before 1.10+, enabled by default thereafter.
| 1.7+
|-
| <tt><nowiki>{{DEFAULTSORT:</nowiki>''sortkey''<nowiki>}}</nowiki></tt>
|
| Used on a categorized page, sets a default [[Help:Categories|category sort key]].
| 1.10+
|}

===Statistics===
Numbers returned by these variables normally contain separators (commas or spaces, depending on the local language), but can return raw numbers with the ":R" flag (for example, <code><tt><nowiki>{{NUMBEROFPAGES}}</nowiki></tt></code> &rarr; {{NUMBEROFPAGES}} and <code><tt><nowiki>{{NUMBEROFPAGES:R}}</nowiki></tt></code> &rarr; {{NUMBEROFPAGES:R}}). Use "|R" for magic words that require a parameter like PAGESINCATEGORY (for example <code><tt><nowiki>{{PAGESINCATEGORY:Help}}</nowiki></tt></code> and <code><tt><nowiki>{{PAGESINCATEGORY:Help|R}}</nowiki></tt></code>).
{| {{prettytable}}
|-
!{{Hl2}}| Variable
!{{Hl2}}| Output
!{{Hl2}}| Description
!{{Hl2}}| Versions
|-
|{{Hl3}} colspan="4"| '''Entire wiki'''
|-
| <tt><nowiki>{{NUMBEROFPAGES}}</nowiki></tt>
| {{NUMBEROFPAGES}}
| Number of wiki pages.
| 1.7+
|-
| <tt><nowiki>{{NUMBEROFARTICLES}}</nowiki></tt>
| {{NUMBEROFARTICLES}}
| Number of pages in main namespace.
|
|-
| <tt><nowiki>{{NUMBEROFFILES}}</nowiki></tt>
| {{NUMBEROFFILES}}
| Number of uploaded files.
| 1.5+
|-
| <tt><nowiki>{{NUMBEROFEDITS}}</nowiki></tt>
| {{NUMBEROFEDITS}}
| Number of page edits.
| {{mediawiki|rev:21319|1.10+}}
|-
| <tt><nowiki>{{NUMBEROFVIEWS}}</nowiki></tt>
| {{NUMBEROFVIEWS}}
| Number of page views. Usually useless on a wiki using [[Manual:Cache|caching]].
| {{mediawiki|rev:42721|1.14+}}
|-
| <tt><nowiki>{{NUMBEROFUSERS}}</nowiki></tt>
| {{NUMBEROFUSERS}}
| Number of registered users.
| 1.7+
|-
| <tt><nowiki>{{NUMBEROFADMINS}}</nowiki></tt>
| {{NUMBEROFADMINS}}
| Number of users in the ''sysop'' {{mediawiki|Manual:User rights|group}}.
| 1.7+
|-
| <tt><nowiki>{{NUMBEROFACTIVEUSERS}}</nowiki></tt>
| {{NUMBEROFACTIVEUSERS}}
| Number of active users, based on the critera used in [[Special:Statistics]].
| {{mediawiki|rev:47392|1.15+}}
|-
| <tt><nowiki>{{PAGESINCATEGORY:</nowiki>''categoryname''<nowiki>}}</nowiki></tt><br /><tt><nowiki>{{PAGESINCAT:Help}}</nowiki></tt>
| {{PAGESINCATEGORY:Help}}<br />{{PAGESINCAT:Help}}
| Number of pages in the given [[Help:Categories|category]] (replace "Help" with the relevant category name).
| {{mediawiki|rev:32932|1.13+}}
|-
| <tt><nowiki>{{NUMBERINGROUP:</nowiki>''groupname''<nowiki>}}</nowiki></tt>
| {{NUMBERINGROUP:bureaucrat}} <br /><nowiki>({{NUMBERINGROUP:bureaucrat}} used here)</nowiki>
| Number of users in a specific {{mediawiki|Manual:User rights|group}}.
| {{mediawiki|rev:40116|1.14+}}
|-
| <tt><nowiki>{{PAGESINNS:</nowiki>''index''<nowiki>}}</nowiki></tt><br /><tt><nowiki>{{PAGESINNAMESPACE:</nowiki>''index''<nowiki>}}</nowiki></tt>
| ''not enabled''
| Number of pages in the given [[Help:Namespaces|namespace]] (replace 2 with the relevant [[Manual:Namespace|namespace index]]). E.g. <tt><nowiki>{{PAGESINNAMESPACE:</nowiki>''14''<nowiki>}}</nowiki></tt> equals the number of categories. <!-- {{NUMBEROFCATEGORIES}} --> Disabled by default, enable with {{mediawiki|Manual:$wgAllowSlowParserFunctions|$wgAllowSlowParserFunctions}}.
| 1.7+
|}

====Page names====
{| {{prettytable}}
|-
!{{Hl2}}| Variable
!{{Hl2}}| Output
!{{Hl2}}| Description
!{{Hl2}}| Versions
|-
| <tt><nowiki>{{FULLPAGENAME}}</nowiki></tt>
| {{FULLPAGENAME}}
| Namespace and page title.
| 1.6+
|-
| <tt><nowiki>{{PAGENAME}}</nowiki></tt>
| {{PAGENAME}}
| Page title.
|
|-
| <tt><nowiki>{{BASEPAGENAME}}</nowiki></tt>
| {{BASEPAGENAME}}
| Page title excluding the current [[Help:Subpages|subpage]] and namespace ("Title" on "Title/foo").
| 1.7+
|-
| <tt><nowiki>{{SUBPAGENAME}}</nowiki></tt>
| {{SUBPAGENAME}}
| The [[Help:Subpages|subpage]] title ("foo" on "Title/foo").
| 1.6+
|-
| <tt><nowiki>{{SUBJECTPAGENAME}}</nowiki></tt>
| {{SUBJECTPAGENAME}}
| The namespace and title of the associated content page.
| 1.7+
|-
| <tt><nowiki>{{TALKPAGENAME}}</nowiki></tt>
| {{TALKPAGENAME}}
| The namespace and title of the associated talk page.
| 1.7+
|}

The following are URL-encoded equivalents:
* <tt><nowiki>{{FULLPAGENAMEE}}</nowiki></tt>
* <tt><nowiki>{{PAGENAMEE}}</nowiki></tt>
* <tt><nowiki>{{BASEPAGENAMEE}}</nowiki></tt>
* <tt><nowiki>{{SUBPAGENAMEE}}</nowiki></tt>
* <tt><nowiki>{{SUBJECTPAGENAMEE}}</nowiki></tt>
* <tt><nowiki>{{TALKPAGENAMEE}}</nowiki></tt>

As of {{mediawiki|rev:46662|1.15+}}, these can all take a parameter, allowing specification of the page to be operated on, instead of just the current page:
* <tt><nowiki>{{PAGENAME:Template:Main Page}}</nowiki></tt> -> {{PAGENAME:Template:Main Page}}

====Namespaces====
{| {{prettytable}}
|-
!{{Hl2}}| Variable
!{{Hl2}}| Output
!{{Hl2}}| Description
!{{Hl2}}| Versions
|-
| <tt><nowiki>{{NAMESPACE}}</nowiki></tt>
| {{NAMESPACE}}
| Namespace (name)
|
|-
| <tt><nowiki>{{SUBJECTSPACE}}</nowiki></tt><br /><tt><nowiki>{{ARTICLESPACE}}</nowiki></tt>
| {{SUBJECTSPACE}}<br />{{ARTICLESPACE}}
| Name of the associated content namespace
| 1.7+
|-
| <tt><nowiki>{{TALKSPACE}}</nowiki></tt>
| {{TALKSPACE}}
| Name of the associated talk namespace
| 1.7+
|}

The following are URL-encoded equivalents:
* <tt><nowiki>{{NAMESPACEE}}</nowiki></tt>
* <tt><nowiki>{{SUBJECTSPACEE}}</nowiki></tt>
* <tt><nowiki>{{TALKSPACEE}}</nowiki></tt>

As of {{mediawiki|rev:46630|1.15+}}, these can all take a parameter, specifying the property should be returned for a given title instead of the current page:
* <tt><nowiki>{{NAMESPACE:Template:Main Page}}</nowiki></tt> -> {{NAMESPACE:Template:Main Page}}