View source for Common.js

'''[[MediaWiki:Common.js]]''' contains [[w:JavaScript|JavaScript]] that will be loaded for all users. Enter "MediaWiki:Common.js" into the search box of your wiki. It will tell you if the page doesn't exist; if so, and you have the necessary [[Manual:User rights|user rights]], just create it with the code you need to execute. There are similar pages affecting only users of specific [[Help:Skins|skins]] (see below).

If {{wg|AllowUserJs}} is set to true, users can customize the interface for themselves only by creating and importing personal scripts in user subpages with ''lowercase'' titles (see below).
[[Extension:Gadgets]] makes it easier for site admins and users to share JavaScript, see  [[Gadget kitchen]].

This page covers the state and configuration variables available.  For the general JavaScript API, see the [https://doc.wikimedia.org/mediawiki-core/master/js/ JSDuck documentation].

== List of JavaScript pages ==
=== Global scripts ===
* [[MediaWiki:Common.js]] (all skins)
* [[MediaWiki:Vector.js|MediaWiki:''skinname''.js]] (per skin, for example [[MediaWiki:Vector.js]])
* [[Manual:User group CSS and Javascript|MediaWiki:Group-''group''.js]] (per user group, for example [[MediaWiki:Group-sysop.js]])
* [[Special:Gadgets]]

=== Personal scripts ===
They're only available if {{wg|AllowUserJs}} is set to true.

* [[Special:MyPage/common.js|User:''Example''/common.js]] (all skins - introduced in MW v1.17)
* [[Special:MyPage/vector.js|User:''Example''/''skinname''.js]] (per skin, for example [[Special:MyPage/vector.js|User:''Example''/vector.js]])

== [[RL/DM#mediaWiki.config|mw.config]] ==
To ease JavaScript programming, the MediaWiki software exposes a number of configuration values in an object called [[RL/DM#mediaWiki.config|mw.config]].

''Note'' Most of these variables have a '''wg''' prefix.
* For legacy reasons these names are exposed as global JavaScript variables if {{wg|LegacyJavaScriptGlobals}} is true, so they use a prefix to avoid collisions.
* A subset of these names correspond to $[[Manual:Wg_variable|wg variable]]s in PHP, but others are unrelated.
* If your own JavaScript code references a config variable, make sure you express a [[ResourceLoader|module]] dependency on the module that supplies it.
* Besides the names in this list, many extensions also set JavaScript config variables prefixed with 'wg'. To use those you need to express a module dependency ''and'' document that your code depends on the extension.

=== Site-wide ===
{| class="wikitable sortable"
!Name
!Type
!Description
!Availability
|-
|valign="top"|<code>debug</code>
|valign="top"|Boolean
|valign="top"|
|valign="top"|{{Hiddensort|1.17}}MW 1.17+
|-
|valign="top"|<code>skin</code>
|valign="top"|String
|valign="top"|The internal name of the currently used skin. The "Classic" skin is called "standard".
|valign="top"|{{Hiddensort|1.18}}MW <1.7 (monobook skin)<br/>MW 1.8+: all skins and pages
|-
|valign="top"|<code>stylepath</code>
|valign="top"|String
|valign="top"|Full URL to the root directory for skins, containing stylesheets and skin-specific scripts. The path does not contain the skin subdirectory, and is not terminated by a "/".
|valign="top"|{{Hiddensort|1.18}}MW <1.7 (monobook skin)<br/>MW 1.8+: all skins and pages
|-
|valign="top"|<code>[[Manual:$wgActionPaths|wgActionPaths]]</code>
|valign="top"|Object
|valign="top"|See [[Manual:$wgActionPaths|$wgActionPaths]]. The value is either an empty object, or otherwise has entries for each defined actionpath of the form <code>'action' : 'path'</code>. So <code>wgActionPaths['edit']</code> will return the "pretty path" for the edit action, if any is defined.
|valign="top"|{{Hiddensort|1.13}}MW 1.13+
|-
|valign="top"|<code>[[Manual:$wgArticlePath|wgArticlePath]]</code>
|valign="top"|String
|valign="top"|Local path, starting at the root, to reference articles, containing a "$1" placeholder that may be replaced by a page title to get a valid URL to that page. Given a valid page title <code>title</code>, a valid URL may be constructed using <code>wgArticlePath.replace('$1', title)</code>. See also [[Manual:$wgArticlePath|$wgArticlePath]].
|valign="top"|{{Hiddensort|1.08}}MW 1.8+
|-
|valign="top"|<code>wgAvailableSkins</code>
|valign="top"|Object
|valign="top"|
|valign="top"|{{Hiddensort|1.18}}MW 1.18+ ({{r|80791}})
|-
|valign="top"|<code>wgCaseSensitiveNamespaces</code>
|valign="top"|Array
|valign="top"|
|valign="top"|{{Hiddensort|1.18}}MW 1.18+ ({{r|90234}})
|-
|valign="top"|<code>wgContentLanguage</code>
|valign="top"|String
|valign="top"|The language code for the default [[content language]] of the wiki.
|valign="top"|{{Hiddensort|1.08}}MW 1.8+
|-
|valign="top"|<code>wgContentNamespaces</code>
|valign="top"|Array of integers
|valign="top"|The IDs of the namespaces considered "content namespaces" by MediaWiki. Equivalent to the value of the <code>[[Manual:$wgContentNamespaces|$wgContentNamespaces]]</code> configuration variable, with <code>0</code> included if it is not already.
|valign="top"|{{Hiddensort|1.23}}MW 1.23+ ({{Git|3d87e3a86bcb39d444ef916129dd48bf80b5bb31}})
|-
|valign="top"|<code>[[Manual:$wgCookiePrefix|wgCookiePrefix]]</code>
|valign="top"|String
|valign="top"|Prefix added to cookie names by default; used automatically by [https://doc.wikimedia.org/mediawiki-core/master/js/#!/api/mw.cookie mw.cookie].
|valign="top"|{{Hiddensort|1.18}}MW 1.18+ ({{r|86580}})
|-
|valign="top"|<code>[[Manual:$wgCookieDomain|wgCookieDomain]]</code>
|valign="top"|String
|valign="top"|Default domain for cookies; used automatically by [https://doc.wikimedia.org/mediawiki-core/master/js/#!/api/mw.cookie mw.cookie].
|valign="top"|{{Hiddensort|1.24}}MW 1.24+ ([[gerrit:120806]])
|-
|valign="top"|<code>[[Manual:$wgCookieExpiration|wgCookieExpiration]]</code>
|valign="top"|Number
|valign="top"|Default lifetime of cookies, in seconds (or 0 for session cookies); used automatically by [https://doc.wikimedia.org/mediawiki-core/master/js/#!/api/mw.cookie mw.cookie].
|valign="top"|{{Hiddensort|1.24}}MW 1.24+ ([[gerrit:120806]])
|-
|valign="top"|<code>[[Manual:$wgCookiePath|wgCookiePath]]</code>
|valign="top"|String
|valign="top"|Default path for cookies; used automatically by [https://doc.wikimedia.org/mediawiki-core/master/js/#!/api/mw.cookie mw.cookie].
|valign="top"|{{Hiddensort|1.24}}MW 1.24+ ([[gerrit:120806]])
|-
|valign="top"|<code>[[Manual:$wgDBname|wgDBname]]</code>
|valign="top"|String
|valign="top"|The name of the wiki's database.
|valign="top"|{{Hiddensort|1.13}}MW 1.13+
|-
|valign="top"|<code>[[Manual:$wgEnableAPI|wgEnableAPI]]</code>
|valign="top"|Boolean
|valign="top"|<code>true</code> if the Mediawiki [[API]] is enabled at all; <code>false</code> otherwise.
|valign="top"|{{Hiddensort|1.12}}MW 1.12+
|-
|valign="top"|<code>[[Manual:$wgEnableWriteAPI|wgEnableWriteAPI]]</code>
|valign="top"|Boolean
|valign="top"|<code>true</code> if the Mediawiki write [[API]] is enabled at all; <code>false</code> otherwise. If <code>wgEnableAPI && !wgEnableWriteAPI</code>, only the read operations of the API are enabled.
|valign="top"|{{Hiddensort|1.12}}MW 1.12+
|-
|valign="top"|<code>[[Manual:$wgExtensionAssetsPath|wgExtensionAssetsPath]]</code>
|valign="top"|String
|valign="top"|Root path used for extension static assets (e.g. images).  Append '/' then the name of the extension to get the root path for a given extension.
|valign="top"|{{Hiddensort|1.18}}MW 1.18+ ({{r|82247}})
|-
|valign="top"|<code>wgFileExtensions</code>
|valign="top"|Array of strings
|valign="top"|The list of all allowed file extensions (without period).
|valign="top"|{{Hiddensort|1.16}}MW 1.16+
|-
|valign="top"|<code>wgFormattedNamespaces</code>
|valign="top"|Object
|valign="top"|Gives a mapping from namespace IDs to localized namespace names. For each namespace, the object has one entry that has the stringified namespace number as the key and the namespace name as its value. Aliases or canonical names are not included.
|valign="top"|{{Hiddensort|1.16}}MW 1.16+
|-
|valign="top"|<code>wgLegacyJavaScriptGlobals</code>
|valign="top"|Boolean
|valign="top"|
|valign="top"|{{Hiddensort|1.18}}MW 1.18+ ({{r|87856}})
|-
|valign="top"|<code>[[Manual:$wgLoadScript|wgLoadScript]]</code>
|valign="top"|String
|valign="top"|
|valign="top"|{{Hiddensort|1.17}}MW 1.17+
|-
|valign="top"|<code>wgMainPageTitle</code>
|valign="top"|String
|valign="top"|The page name of the wiki's main page, including the namespace name, if any. May contain blanks.
|valign="top"|{{Hiddensort|1.16}}MW 1.16+
|-
|valign="top"|<code>wgNamespaceIds</code>
|valign="top"|Object
|valign="top"|Gives a mapping from namespace names to namespace IDs. For each namespace name, including aliases, the object has one entry that has namespace name as the key and the namespace ID as its integer value. Canonical names are not included. The keys are all lowercase, with blanks replaced by underscores.
|valign="top"|{{Hiddensort|1.16}}MW 1.16+
|-
|valign="top"|<code>wgResourceLoaderMaxQueryLength</code>
|valign="top"|Number
|valign="top"|
|valign="top"|{{Hiddensort|1.18}}MW 1.18+ ({{r|87203}})
|-
|valign="top"|<code>[[Manual:$wgScript|wgScript]]</code>
|valign="top"|String
|valign="top"|Full path to the main access point script, starting at the root, including the full script name with extension. On WMF wikis, normally "/w/index.php". See also [[Manual:$wgScript|$wgScript]].
|valign="top"|{{Hiddensort|1.11}}MW 1.11+
|-
|valign="top"|<code>[[Manual:$wgScriptExtension|wgScriptExtension]]</code>
|valign="top"|String
|valign="top"|The file extension to use for all calls to script access points. Normally ".php". See also [[Manual:$wgScriptExtension|$wgScriptExtension]].
|valign="top"|{{Hiddensort|1.16}}MW 1.16+
|-
|valign="top"|<code>[[Manual:$wgScriptPath|wgScriptPath]]</code>
|valign="top"|String
|valign="top"|The path part of <code>wgScript</code>, without trailing "/". This is the path to use for direct calls to the php access points such as <code>index.php</code> or <code>api.php</code>. See also [[Manual:$wgScriptPath|$wgScriptPath]].
|valign="top"|{{Hiddensort|1.08}}MW 1.8+
|-
|valign="top"|<code>[[Manual:$wgServer|wgServer]]</code>
|valign="top"|String
|valign="top"|The server URL, not terminated by "/". The combination <code>wgServer + wgScriptPath + "/api.php"</code>, for instance, results in a valid URL to the API access point script.
|valign="top"|{{Hiddensort|1.08}}MW 1.8+
|-
|valign="top"|<code>wgSiteName</code>
|valign="top"|String
|valign="top"|The name of the site, as defined by [[Manual:$wgSitename|$wgSitename]].
|valign="top"|{{Hiddensort|1.16}}MW 1.16+
|-
|valign="top"|<code>wgUrlProtocols</code>
|valign="top"|String
|valign="top"|Stringified regular expression matching all protocols recognized in links, i.e. "http\\:\\/\\/|https\\:\\/\\/|..."
|valign="top"|{{Hiddensort|1.16}}MW 1.16+
|-
|valign="top"|<code>[[Manual:$wgVariantArticlePath|wgVariantArticlePath]]</code>
|valign="top"|String or <code>false</code>
|valign="top"|If a wiki has language variants (such as the Chinese and the Serbian Wikipedias), set to a path beginning at the root for language variants other than <code>wgContentLanguage</code>. The path contains two placeholders: "$1" is to be replaced by the page title, and "$2" is to be replaced by the language code of the language variant (e.g. "zh-tw"). If the wiki does not have language variants, set to <code>false</code>. See also [[Manual:$wgVariantArticlePath|$wgVariantArticlePath]].
|valign="top"|{{Hiddensort|1.13}}MW 1.13+
|-
|valign="top"|<code>[[Manual:$wgVersion|wgVersion]]</code>
|valign="top"|String
|valign="top"|Identifies the version of MediaWiki that served the page. 
|valign="top"|{{Hiddensort|1.12}}MW 1.12+
|}

Some additional site-wide variables are present only depending on the wiki configuration.

{|class="wikitable sortable"
!Name
!Type
!Description
!Availability
|-
!colspan="4" style="background-color:#DDDDDD;"| If {{wg|UseAjax}} and {{wg|EnableMWSuggest}} are true:
|-
|valign="top"|<code>wgMWSuggestTemplate</code> {{deprecated-inline}}
|valign="top"|String
|valign="top"|A URL that can be used to obtain search suggestions. The string contains two placeholders that should be replaced: <code>{searchTerms}</code> is to be replaced by the (urlencoded) search terms, and <code>{namespaces}</code> should be replaced by the namespace numbers of the namespaces to search, separated by a vertical bar ("|").
|valign="top"|MW 1.13 - MW 1.19 ({{Git|52c1739f721ec6cc34cd764e6c002cc0188ac346}})
|-
!colspan="4" style="background-color:#DDDDDD;"|If the [[Manual:$wgAjaxWatch|Ajax watch]] feature is enabled, the following variable is available:
|-
|valign="top"|<code>wgAjaxWatch</code> {{deprecated-inline}}
|valign="top"|Object
|valign="top"|An object containing various user interface messages, localized to <code>wgUserLanguage</code>.
|valign="top"|MW 1.11 - MW 1.17 ({{r|88511}})
|}

=== Page-specific ===
{|class="wikitable sortable"
!Name
!Type
!Description
!Availability
|-
|valign="top"|<code>wgAction</code>
|valign="top"|String
|valign="top"|The action performed, e.g. "edit" for edit pages, or "view" for page views. See [[Manual:Parameters to index.php#Actions]].
|valign="top"|MW 1.10+
|-
|valign="top"|<code>wgArticleId</code>
|valign="top"|Integer
|valign="top"|The internal ID of the page. For non-existent pages and special pages, it is zero.
|valign="top"|MW 1.8+
|-
|valign="top"|<code>[[Manual:$wgBreakFrames|wgBreakFrames]]</code>
|valign="top"|Boolean
|valign="top"|See [[Manual:$wgBreakFrames|$wgBreakFrames]].
|valign="top"|MW 1.9+
|-
|valign="top"|<code>wgCanonicalNamespace</code>
|valign="top"|String
|valign="top"|The canonical (i.e., not localized or aliased) [[Manual:namespace|namespace]] name of the page.
|valign="top"|MW 1.8+
|-
|valign="top"|<code>wgCanonicalSpecialPageName</code>
|valign="top"|String or <code>false</code> or not defined
|valign="top"|On special pages, the canonical (i.e., not localized or aliased) name of the special page; otherwise it is not defined at all (up to and including MW 1.15) or is set to <code>false</code> (since MW 1.16).
|valign="top"|MW 1.9+
|-
|valign="top"|<code>wgCategories</code>
|valign="top"|Array of strings
|valign="top"|The list of all the categories a page belongs to. This is essentially a JavaScript version of the category box shown on the page (grey box at bottom of page, in Monobook/Vector). If the category box is not shown on the current page (as is the case when editing/viewing history), <code>wgCategories</code> will be an empty array.
|valign="top"|MW 1.16+
|-
|valign="top"|<code>wgCurRevisionId</code>
|valign="top"|Integer
|valign="top"|The top revision ID of the currently viewed page at the time the page was served. Also set on diff and history pages; zero for special pages. 
|valign="top"|MW 1.9+
|-
|valign="top"|<code>wgDefaultDateFormat</code>
|valign="top"|String
|valign="top"|E.g. "dmy". Depends on the [[page content language]] since 1.20 ([[gerrit:14271]]).
|valign="top"|MW 1.18+ ({{r|86088}})
|-
|valign="top"|<code>wgDigitTransformTable</code>
|valign="top"|Array of two strings
|valign="top"|Describes digit transformations. If transformations are specified, the first entry contains a string of all Arabic digits ("0123456789"), the second array element gives in the corresponding string positions the replacement according to <code>wgPageContentLanguage</code>. The individual characters in each string are tab-separated. If no transformation is specified for the language, the value of <code>wgDigitTransformTable</code> is <code>["", ""]</code> (i.e., an array of two empty strings).
|valign="top"|MW 1.12+
|-
|valign="top"|<code>wgIsArticle</code>
|valign="top"|Boolean
|valign="top"|<code>true</code> if the content displayed on the page is related to the source of the corresponding article on the wiki. So it is <code>true</code> when viewing a page (regardless of namespace), and also true when viewing a diff that has a rendered revision appended to the bottom of it. It is <code>false</code> for anything else (edit, history, special pages, most generated pages, etc).
'''Note:''' This variable is badly named – it has nothing really to do with a page being an "article" or not.
|valign="top"|MW 1.8+
|-
|valign="top"|<code>wgIsProbablyEditable</code>
|valign="top"|boolean
|valign="top"|True if the page is probably editable (based on [[quickUserCan]]) by the current user.  The 'probably' is necessary for performance reasons.  An exact editability check is too costly here, due to cascading protection and hook-based extensions like [[Extension:TitleBlacklist|TitleBlacklist]] that may be enabled.  If this is true, it is likely to be editable.  If it is false, it is definitely not editable.
|valign="top"|({{git|0bbc358951e56fbb3e2e121a02cf213e280ffdc1}})
|-
|valign="top"|<code>wgMonthNames</code>
|valign="top"|Array
|valign="top"|Like January, February, ... Depends on the [[page content language]] since 1.20 ([[gerrit:14271]]).
|valign="top"|MW 1.18+ ({{r|86088}})
|-
|valign="top"|<code>wgMonthNamesShort</code>
|valign="top"|Array
|valign="top"|Like Jan, Feb, ... Depends on the [[page content language]] since 1.20 ([[gerrit:14271]]).
|valign="top"|MW 1.18+ ({{r|86088}})
|-
|valign="top"|<code>wgNamespaceNumber</code>
|valign="top"|Integer
|valign="top"|The number of the [[Manual:namespace|namespace]] the page is in. 
|valign="top"|MW 1.8+
|-
|valign="top"|{{Anchor|wgPageContentLanguage}}<code>wgPageContentLanguage</code>
|valign="top"|String
|valign="top"|Language code of the [[page content language]] (according to <code>$context->getTitle()->getPageLanguage()</code>)
|valign="top"|MW 1.19+ ({{r|104483}})
|-
|valign="top"|<code>wgPageContentModel</code>
|valign="top"|String
|valign="top"|<code>'wikitext'</code> on typical wiki pages, <code>'javascript'</code> on pages interpreted as JavaScript, <code>'css'</code> on pages interpreted as CSS.
|valign="top"|{{Hiddensort|1.16}}MW 1.22+ ([[gerrit:62178]])
|-
|valign="top"|<code>wgPageName</code>
|valign="top"|String
|valign="top"|The full name of the page, including the localized namespace name, if the namespace has a name (the main namespace (number 0) doesn't), and with blanks replaced by underscores.
|valign="top"|MW 1.8+
|-
|valign="top"|<code>wgPostEdit</code>
|valign="top"|Boolean
|valign="top"|True if the user just saved this page.  Add a dependency on the <code>mediawiki.action.view.postEdit</code> module as the variable is set dynamically from JavaScript. If the user did not just save a page the value is omitted entirely (e.g. not set to false but absent in in <code>mw.config</code>).
|valign="top"|MW 1.21+ ([[gerrit:50480]])
|-
|valign="top"|<code>wgRedirectedFrom</code>
|valign="top"|String
|valign="top"|When redirected contains the title of the page we were redirected from. If the page was not redirected, the value is omitted entirely (absent in <code>mw.config</code>). Uses the same format as <code>wgPageName</code>
|valign="top"|MW 1.19+ ({{r|104668}})
|-
|valign="top"|<code>wgRelevantPageName</code>
|valign="top"|String
|valign="top"|The full name of the page to which content actions and navigation links (e.g. a skin's tabs) apply. The AJAX watch function uses this to work correctly on special pages such as [[Special:MovePage]] and [[Special:WhatLinksHere]].
|valign="top"|MW 1.19+ ({{r|113737}})
|-
|valign="top"|<code>wgRelevantUserName</code>
|valign="top"|String or unset
|valign="top"|The relevant name of the user to which content actions and some extra navigation links (e.g. link to user rights or user contributions) apply.
|valign="top"|MW 1.23+ ({{git|88773}})
|-
|valign="top"|<code>wgRestrictionEdit</code>
|valign="top"|Array of strings
|valign="top"|If the page is editable at all (and is not a special page) and editing of the page is restricted to some user groups, the array contains the minimum user group a user must be in in order to edit the page. For semi-protected pages, it'd contain <code>["autoconfirmed"]</code>; for fully protected pages <code>["sysop"]</code>. If there are no explicit restrictions, the value is <code>[]</code> (an array with no elements). 
This array contains only ''explicit ''protections. Namespace-wide protections (e.g. MediaWiki namespace, [[Manual:$wgNamespaceProtection|$wgNamespaceProtection]]), cascading protections, or "protections" brought about by the [[Extension:TitleBlacklist|TitleBlacklist]] extension's "noedit" attribute, are ignored by this array. On such pages, the value is normally <code>[]</code>, unless additional protections have been applied specifically to that page.
|valign="top"|MW 1.14+
|-
|valign="top"|<code>wgRestrictionMove</code>
|valign="top"|Array of strings
|valign="top"|If the page is movable at all (and is not a special page) and moving of the page is restricted to some user groups, the array contains the minimum user group a user must be in in order to move the page. For semi-moveprotected pages, it'd contain <code>["autoconfirmed"]</code>; for fully moveprotected pages <code>["sysop"]</code>. If there are no explicit restrictions, the value is <code>[]</code> (an array with no elements). 
This array contains only ''explicit ''protections. Namespace-wide protections (e.g. MediaWiki namespace, [[Manual:$wgNamespaceProtection|$wgNamespaceProtection]]), cascading protections, or "protections" brought about by the [[Extension:TitleBlacklist|TitleBlacklist]] extension's "moveonly" attribute, are ignored by this array. On such pages, the value is normally <code>[]</code>, unless additional protections have been applied specifically to that page.
|valign="top"|MW 1.14+
|-
|valign="top"|<code>wgRevisionId</code>
|valign="top"|Integer
|valign="top"|The revision ID of the currently viewed revision, or the right revision for diff views. Also set on diff pages; zero for special pages, history pages, or anywhere else inapplicable. 
|valign="top"|MW 1.22+ {{git|7fa7b71eb3a5dd24e75865162e4c06a4a6012524}}
|-
|valign="top"|<code>wgSeparatorTransformTable</code>
|valign="top"|Array of two strings
|valign="top"|Describes number separator transformations. The first entry contains a string of all canonical separators (single characters), the second array element gives in the corresponding string positions the replacement according to <code>wgPageContentLanguage</code>. The individual characters in each string are tab-separated. If no transformations are specified, the value of <code>wgSeparatorTransformTable</code> is <code>["", ""]</code> (i.e., an array of two empty strings).
|valign="top"|MW 1.12+
|-
|valign="top"|<code>wgSearchType</code>
|valign="top"|String or unset
|valign="top"|The name of the search backend used to execute search requests.
|valign="top"|MW 1.23+ ({{git|118655}})
|-
|valign="top"|<code>wgTitle</code>
|valign="top"|String
|valign="top"|The page title, without the namespace. May contain spaces – does not contain underscores.
|valign="top"|MW 1.8+
|-
|valign="top"|<code>wgEditMessage</code>
|valign="top"|String
|valign="top"|The name of the message used to for the title of EditPage. Used by Live preview to update document.title and #firstHeading with a new displaytitle.
|valign="top"|MW 1.25+ ({{git|187710}})
|}

Some additional variables are present only depending on the page namespace, wiki configuration and/or user preferences.

{|class="wikitable sortable"
!Name
!Type
!Description
!Availability
|-
!colspan="4" style="background-color:#DDDDDD;"| Main Page
|-
|valign="top"|<code>wgIsMainPage</code>
|valign="top"|Boolean
|valign="top"|<code>true</code> if the current page is the main page of the wiki.  Omitted entirely otherwise (defaulting to null in <code>mw.config</code>).
|valign="top"|MW 1.18+
|-
!colspan="4" style="background-color:#DDDDDD;"| If the content language has variants:
|-
|valign="top"|<code>wgUserVariant</code>
|valign="top"|String
|valign="top"|If the wiki has language variants, the language code of the user's preferred variant. If the wiki does not have variants, the variable is not configured (''does not exist''), i.e.:<br/>{{inline-code|mw.config.exists( 'wgUserVariant' ); // false|lang=javascript}}<br/>{{inline-code|mw.config.get( 'wgUserVariant' ); // null|lang=javascript}}.
|valign="top"|MW 1.16+
|-
!colspan="4" style="background-color:#DDDDDD;"| If the [[Manual:$wgEnableMWSuggest|Ajax search suggestions]] are enabled (both globally and in the user's preferences), the following variables are available:
|-
|valign="top"|<code>wgMWSuggestMessages</code> {{deprecated-inline}}
|valign="top"|Array of strings
|valign="top"|Some localized user interface texts that may be used by the search suggestion engine.
|valign="top"|MW 1.13 - MW 1.16
|-
|valign="top"|<code>wgSearchNamespaces</code> {{deprecated-inline}}
|valign="top"|Array of integers
|valign="top"|An array of the namespace numbers of all namespaces to search by default, according to the user's preferences.
|valign="top"|MW 1.13 - MW 1.19 ({{Git|52c1739f721ec6cc34cd764e6c002cc0188ac346}})
|-
!colspan="4" style="background-color:#DDDDDD;"|If the [[Manual:live preview|live preview]] is enabled, some MediaWiki versions may provide the following variables. (Note: it appears that these variables have been pulled in MW 1.16).
|-
|valign="top"|<code>wgLivepreviewMessageError</code> {{deprecated-inline}}
|valign="top"|String
|valign="top"|The contents of [[MediaWiki:Livepreview-error]] for <code>wgUserLanguage</code>.
|valign="top"|MW 1.10-1.15
|-
|valign="top"|<code>wgLivepreviewMessageFailed</code> {{deprecated-inline}}
|valign="top"|String
|valign="top"|The contents of [[MediaWiki:Livepreview-failed]] for <code>wgUserLanguage</code>.
|valign="top"|MW 1.10-1.15
|-
|valign="top"|<code>wgLivepreviewMessageLoading</code> {{deprecated-inline}}
|valign="top"|String
|valign="top"|The contents of [[MediaWiki:Livepreview-loading]] for <code>wgUserLanguage</code>.
|valign="top"|MW 1.10-1.15
|-
|valign="top"|<code>wgLivepreviewMessageReady</code> {{deprecated-inline}}
|valign="top"|String
|valign="top"|The contents of [[MediaWiki:Livepreview-ready]] for <code>wgUserLanguage</code>.
|valign="top"|MW 1.10-1.15
|}

=== User-specific ===
Related to the user currently viewing the page:

{|class="wikitable sortable"
!Name
!Type
!Description
!Availability
|-
|valign="top"|<code>wgUserEditCount</code>
|valign="top"|Number
|valign="top"|The number of edits the current user made (null if not logged in).
|valign="top"|{{Hiddensort|1.21}}MW 1.21+
|-
|valign="top"|<code>wgUserGroups</code>
|valign="top"|Array of strings
|valign="top"|An array containing all the (local) user groups the current user is a member of, or <code>null</code> for non-logged-in users. User groups are identified by the internal user group names, e.g. "sysop", "autoconfirmed", "bureaucrat", and so on. The default user group is named "*".
|valign="top"|MW 1.10+
|-
|valign="top"|<code>wgUserId</code>
|valign="top"|Number
|valign="top"|The numeric ID of the current user (null if not logged in).
|valign="top"|{{Hiddensort|1.21}}MW 1.21+
|-
|valign="top"|<code>wgUserLanguage</code>
|valign="top"|String
|valign="top"|The language code for the user's interface language, as set in Special&rarr;Preferences (which may be overridden by a <code>uselang=</code> parameter in the URL).
|valign="top"|{{Hiddensort|1.08}}MW 1.8+
|-
|valign="top"|<code>wgUserName</code>
|valign="top"|String
|valign="top"|The user name of the user currently viewing the page, if it's a logged-in user. For non-logged-in users, it is <code>null</code> (''not'' the user's IP address, unlike PHP <code> $wgUser->getName()</code> on the server).
|valign="top"|MW 1.8+
|-
|valign="top"|<code>wgUserRegistration</code>
|valign="top"|Number
|valign="top"|The time and date on which the current user registered, represented as milliseconds since epoch. Null if not logged in.
|valign="top"|{{Hiddensort|1.21}}MW 1.21+
|}

=== Hooks for extensions ===
* [[Manual:Hooks/ResourceLoaderGetConfigVars|ResourceLoaderGetConfigVars]]: Since MediaWiki 1.17 extensions can add their own site-wide variables through this hook.
* [[Manual:Hooks/MakeGlobalVariablesScript|MakeGlobalVariablesScript]]: Since MediaWIki 1.14 extensions can add their own variables to the OutputPage. If the variable is not dependent on the page being viewed, use the [[Manual:Hooks/ResourceLoaderGetConfigVars|ResourceLoaderGetConfigVars]] hook instead.