View source for Manual:Interface/JavaScript

<languages/>
{{JavaScript}}
<translate><!--T:1--> <tvar name=1>[[MediaWiki:Common.js]]</tvar> contains [[w:JavaScript|JavaScript]] that will be loaded for all users.</translate>
<translate><!--T:2--> Enter "<tvar name=1>MediaWiki:Common.js</tvar>" into the search box of your wiki.</translate>
<translate><!--T:3--> It will tell you if the page doesn't exist; if so, and you have the necessary {{<tvar name=1>ll|Manual:User rights</tvar>|user rights}}, just create it with the code you need to execute.</translate>
<translate><!--T:4--> There are similar pages affecting only users of specific {{<tvar name=1>ll|Help:Skins</tvar>|skins}} (see below).</translate>

<translate><!--T:5--> If <tvar name=1>{{wg|AllowUserJs}}</tvar> is set to true, users can customize the interface for only themselves by creating and importing personal scripts in certain user subpages.</translate>
<translate><!--T:6--> <tvar name=1>{{ll|Extension:Gadgets}}</tvar> makes it easier for site admins and users to share JavaScript, see <tvar name=2>{{ll|Gadget kitchen}}</tvar>.</translate>

<translate><!--T:7--> This page covers the state and configuration variables available.</translate>
<translate><!--T:8--> For the general JavaScript API, see the [[<tvar name=1>wmdoc:mediawiki-core/master/js/</tvar>|generated documentation]].</translate>

<translate>
== List of JavaScript pages == <!--T:9-->
</translate>
{{note|1=<translate><!--T:247--> Any scripts or gadgets won't load on <tvar name=1>[[Special:Preferences]]</tvar> itself, or if [[<tvar name=2>Special:MyLanguage/Manual:Safemode</tvar>|safemode]] is used.</translate>}}

<translate>
=== Global scripts === <!--T:10-->
</translate>
* [[MediaWiki:Common.js]] - <translate><!--T:44--> applies to all skins, but ignored by the mobile website provided by <tvar name=1>{{ll|Extension:MobileFrontend}}</tvar></translate>
* [[MediaWiki:Vector.js|MediaWiki:''skinname''.js]] - <translate><!--T:45--> applies to a specific skin, for example <tvar name=1>[[MediaWiki:Vector.js]]</tvar></translate>
* {{ll|Manual:User group CSS and JavaScript|MediaWiki:Group-''group''.js}} - <translate><!--T:46--> applies to a specific user group, for example <tvar name=1>[[MediaWiki:Group-sysop.js]]</tvar></translate>
* [[MediaWiki:Mobile.js|MediaWiki:Mobile.js]] - <translate><!--T:47--> applies to the mobile website; provided by <tvar name=1>{{ll|Extension:MobileFrontend}}</tvar></translate>
* [[Special:Gadgets]] - <translate><!--T:166--> can be activated by any user in <tvar name=1>{{ll|Preferences}}</tvar>, or may be enabled by default for all users; provided by <tvar name=2>{{ll|Extension:Gadgets}}</tvar></translate>

<translate>
=== Personal scripts === <!--T:11-->
</translate>
<translate><!--T:48--> Personal scripts are only available if <tvar name=1>{{wg|AllowUserJs}}</tvar> is set to <tvar name=2>{{phpi|true}}</tvar>.</translate>
See also <code>{{ll|ResourceLoader/Core modules#importScript|importScript()}}</code>.

* [[Special:MyPage/common.js|User:''Example''/common.js]] - <translate><!--T:49--> all skins - introduced in MW v1.17</translate>
* [[Special:MyPage/vector.js|User:''Example''/''skinname''.js]] - <translate><!--T:50--> per skin, for example <tvar name=1>[[Special:MyPage/vector.js|User:''Example''/vector.js]]</tvar>; always lowercase</translate>)
* [[:meta:special:MyPage/global.js|User:''Example''/global.js]] - <translate><!--T:51--> per <tvar name=1>{{ll|Manual:Wiki family}}</tvar>, if <tvar name=2>{{ll|Extension:GlobalCssJs}}</tvar> is in use in for this family</translate>

== {{ll|ResourceLoader/Core_modules#mediaWiki.config|mw.config}} ==
<translate>
<!--T:52-->
To facilitate JavaScript programming, the MediaWiki software exposes a number of configuration values in an object called <tvar name=1>{{ll|RL/DM#mediaWiki.config|mw.config}}</tvar>.
</translate>

{{note|1=
<translate>
<!--T:107-->
Most of these variables have a <tvar name=1>'''wg'''</tvar> prefix.
</translate>

* <translate><!--T:108--> Their names were previously exposed as global JavaScript variables if <tvar name=1>{{wg|LegacyJavaScriptGlobals}}</tvar> is true, so they use a prefix to avoid collisions.</translate>
* <translate><!--T:109--> A subset of these names correspond to $[[<tvar name=1>Special:MyLanguage/Manual:Wg variable</tvar>|wg variable]]s in PHP, but others are unrelated.</translate>
* <translate><!--T:110--> Besides the names in this list, many extensions also set additional JavaScript config variables prefixed with '<tvar name=1>wg</tvar>'.</translate>
}}

<translate>
<!--T:53-->
These values can be accessed through <tvar name=1><code>mw.config</code></tvar>, documented at [[<tvar name=2>Special:MyLanguage/RL/DM#mediaWiki.config</tvar>|ResourceLoader/Core modules]].

=== Site-wide === <!--T:13-->
</translate>

{| class="wikitable sortable"
! <translate><!--T:18--> Name</translate>
! <translate><!--T:19--> Type</translate>
! <translate><!--T:20--> Description</translate>
! <translate><!--T:21--> Availability</translate>
! <translate><!--T:169--> Example output</translate>
|-
|valign="top"|<code>{{Visible anchor|debug}}</code>
|valign="top"| <translate><!--T:170--> Integer</translate> (1.36+) / <translate><!--T:171--> Boolean</translate> (-1.35)
|valign="top"| <translate><!--T:172--> Since MediaWiki 1.36+, <tvar name=1><code>0</code></tvar> means debug mode is off, and a positive non-zero number means debug mode is on (e.g. <tvar name=2><code>1</code></tvar> or <tvar name=3><code>2</code></tvar>).</translate>

<translate><!--T:173--> In MediaWiki 1.35 and earlier, <tvar name=1>{{phpi|false}}</tvar> and <tvar name=2>{{phpi|true}}</tvar> were used (<tvar name=3>[[phab:T85805]]</tvar>).</translate>
|valign="top"|{{Hiddensort|1.17}}MW 1.17+
|0
|-
|valign="top"|<code>{{Visible anchor|skin}}</code>
|valign="top"| <translate><!--T:174--> String</translate>
|valign="top"| <translate><!--T:111--> The internal name of the currently used skin.</translate>
|valign="top"|{{Hiddensort|1.18}}MW <1.7 <translate><!--T:242--> (monobook skin)</translate><br/>MW 1.8+: all skins and pages
|vector
|-
|valign="top"|<code>{{Visible anchor|stylepath}}</code>
|valign="top"| <translate><!--T:175--> String</translate>
|valign="top"| <translate><!--T:113--> Full URL to the root directory for skins, containing stylesheets and skin-specific scripts.</translate> <translate><!--T:114--> The path does not contain the skin subdirectory, and is not terminated by a "<tvar name=1>/</tvar>".</translate>
|valign="top"|{{Hiddensort|1.18}}MW <1.7 <translate><!--T:243--> (monobook skin)</translate><br/>MW 1.8+: <translate><!--T:244--> all skins and pages</translate>
|/w/skins
|-
|valign="top"|<code>{{anchor|wgArticlePath}}{{ll|Manual:$wgArticlePath|wgArticlePath}}</code>
|valign="top"| <translate><!--T:176--> String</translate>
|valign="top"| <translate><!--T:115--> 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.</translate> <translate><!--T:116--> Given a valid page title <tvar name=1><code>title</code></tvar>, a valid URL may be constructed using <tvar name=2><code>wgArticlePath.replace('$1', title)</code></tvar>.</translate> <translate><!--T:117--> See also <tvar name=1>{{ll|Manual:$wgArticlePath|$wgArticlePath}}</tvar>.</translate>
|valign="top"|{{Hiddensort|1.08}}MW 1.8+
|/wiki/$1
|-
|valign="top"|<code>{{Visible anchor|wgCaseSensitiveNamespaces}}</code>
|valign="top"| <translate><!--T:177--> Array</translate>
|valign="top"| <translate><!--T:118--> The IDs of the namespaces treated as case-sensitive by MediaWiki.</translate> <translate><!--T:119--> Determined by the values of the <tvar name=1><code>{{ll|Manual:$wgCapitalLinks|$wgCapitalLinks}}</code></tvar> and <tvar name=2><code>{{ll|Manual:$wgCapitalLinksOverrides|$wgCapitalLinksOverrides}}</code></tvar> configuration variables.</translate><!-- I'm assuming; it would be good to have someone confirm this -->
|valign="top"|{{Hiddensort|1.18}}MW 1.18+ ({{r|90234}})
|[]
|-
|valign="top"|<code>{{Visible anchor|wgContentLanguage}}</code>
|valign="top"| <translate><!--T:178--> String</translate>
|valign="top"| <translate><!--T:248--> The language code for the default <tvar name=1>{{ll|content language}}</tvar> of the wiki.</translate>
|valign="top"|{{Hiddensort|1.08}}MW 1.8+
|en
|-
|valign="top"|<code>{{Visible anchor|wgContentNamespaces}}</code>
|valign="top"| <translate><!--T:120--> Array of integers</translate>
|valign="top"| <translate><!--T:121--> The IDs of the namespaces considered "content namespaces" by MediaWiki.</translate> <translate><!--T:122--> Equivalent to the value of the <tvar name=1><code>{{ll|Manual:$wgContentNamespaces|$wgContentNamespaces}}</code></tvar> configuration variable, with <tvar name=2><code>0</code></tvar> included if it is not already.</translate>
|valign="top"|{{Hiddensort|1.23}}MW 1.23+ ({{Git|3d87e3a86bcb39d444ef916129dd48bf80b5bb31}})
|[100, 102, 104, 106, 0]
|-
|valign="top"|<code>{{anchor|wgDBname}}{{ll|Manual:$wgDBname|wgDBname}}</code>
|valign="top"| <translate><!--T:179--> String</translate>
|valign="top"| <translate><!--T:123--> The name of the wiki's database.</translate>
|valign="top"|{{Hiddensort|1.13}}MW 1.13+
|mediawikiwiki
|-
|valign="top"|<code>{{Visible anchor|wgWikiID}}</code>
|valign="top"| <translate><!--T:180--> String</translate>
|valign="top"| <translate><!--T:164--> The wiki identifier.</translate> <translate><!--T:165--> Should be preferred over <tvar name=1><code>wgDBname</code></tvar>.</translate>
|valign="top"|{{Hiddensort|1.34}}MW 1.34+ ([[phab:rMWd45baf7f0734a2506c77925064f42bc13e1bff5e|d45baf7f0734]])
|mediawikiwiki
|-
|valign="top"|<code>{{anchor|wgExtensionAssetsPath}}{{ll|Manual:$wgExtensionAssetsPath|wgExtensionAssetsPath}}</code>
|valign="top"| <translate><!--T:181--> String</translate>
|valign="top"| <translate><!--T:124--> Root path used for extension static assets (e.g. <tvar name=1>images</tvar>).</translate> <translate><!--T:125--> Append '<tvar name=1>/</tvar>' then the name of the extension to get the root path for a given extension.</translate>
|valign="top"|{{Hiddensort|1.18}}MW 1.18+ ({{r|82247}})
|/w/extensions
|-
|valign="top"|<code>{{Visible anchor|wgFormattedNamespaces}}</code>
|valign="top"| <translate><!--T:182--> Object</translate>
|valign="top"| <translate><!--T:126--> Gives a mapping from namespace IDs to localized namespace names.</translate> <translate><!--T:127--> For each namespace, the object has one entry that has the stringified namespace number as the key and the namespace name as its value.</translate> <translate><!--T:128--> Aliases or canonical names are not included.</translate>
|valign="top"|{{Hiddensort|1.16}}MW 1.16+
|{0: <nowiki>''</nowiki>, 1: 'Talk', 2: 'User', ... }
|-
|valign="top"|<code>{{Visible anchor|wgNamespaceIds}}</code>
|valign="top"| <translate><!--T:183--> Object</translate>
|valign="top"| <translate><!--T:129--> Gives a mapping from namespace names to namespace IDs.</translate> <translate><!--T:130--> For each namespace name, including localized and canonical names as well as aliases, the object has one entry that has namespace name as the key and the namespace ID as its integer value.</translate> <translate><!--T:132--> The keys are all lowercase, with spaces replaced by underscores.</translate>
|valign="top"|{{Hiddensort|1.16}}MW 1.16+
|{media: -2, special: -1, "": 0, talk: 1, user: 2, ... }
|-
|valign="top"|<code>{{anchor|wgScript}}{{ll|Manual:$wgScript|wgScript}}</code>
|valign="top"| <translate><!--T:184--> String</translate>
|valign="top"| <translate><!--T:133--> Full path to the main access point script, starting at the root, including the full script name with extension.</translate> <translate><!--T:134--> On WMF wikis, normally "<tvar name=1>/w/index.php</tvar>".</translate> <translate><!--T:135--> See also <tvar name=1>{{ll|Manual:$wgScript|$wgScript}}</tvar>.</translate>
|valign="top"|{{Hiddensort|1.11}}MW 1.11+
|/w/index.php
|-
|valign="top"|<code>{{anchor|wgScriptPath}}{{ll|Manual:$wgScriptPath|wgScriptPath}}</code>
|valign="top"| <translate><!--T:185--> String</translate>
|valign="top"| <translate><!--T:139--> The path part of <tvar name=1><code>wgScript</code></tvar>, without trailing "<tvar name=2>/</tvar>".</translate> <translate><!--T:140--> This is the path to use for direct calls to the php access points such as <tvar name=1><code>index.php</code></tvar> or <tvar name=2><code>api.php</code></tvar>.</translate> <translate><!--T:141--> See also <tvar name=1>{{ll|Manual:$wgScriptPath|$wgScriptPath}}</tvar>.</translate>
|valign="top"|{{Hiddensort|1.08}}MW 1.8+
|/w
|-
|valign="top"|<code>{{anchor|wgServer}}{{ll|Manual:$wgServer|wgServer}}</code>
|valign="top"| <translate><!--T:186--> String</translate>
|valign="top"| <translate><!--T:142--> The server URL, not terminated by "<tvar name=1>/</tvar>".</translate> <translate><!--T:143--> The combination <tvar name=1><code>wgServer + wgScriptPath + "/api.php"</code></tvar>, for instance, results in a valid URL to the API access point script.</translate>
|valign="top"|{{Hiddensort|1.08}}MW 1.8+
|//www.mediawiki.org
|-
|valign="top"|<code>{{anchor|wgServerName}}{{ll|Manual:$wgServerName|wgServerName}}</code>
|valign="top"|String
|valign="top"| <translate><!--T:167--> The name of the server, without the protocol or trailing slash (e.g. "en.wikipedia.org").</translate>
|valign="top"|{{Hiddensort|1.24}}MW 1.24+ ([[phab:rMW72c0ce43a854d5cd5601d1d19423518065ce33ff|72c0ce43a854]])
|www.mediawiki.org
|-
|valign="top"|<code>{{Visible anchor|wgSiteName}}</code>
|valign="top"|String
|valign="top"| <translate><!--T:144--> The name of the site, as defined by <tvar name=1>{{ll|Manual:$wgSitename|$wgSitename}}</tvar>.</translate>
|valign="top"|{{Hiddensort|1.16}}MW 1.16+
|MediaWiki
|-
|valign="top"|<code>{{anchor|wgVariantArticlePath}}{{ll|Manual:$wgVariantArticlePath|wgVariantArticlePath}}</code>
|valign="top"| <translate><!--T:187--> String or <tvar name=1>{{phpi|false}}</tvar></translate>
|valign="top"| <translate><!--T:145--> 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 <tvar name=1><code>wgContentLanguage</code></tvar>.</translate> <translate><!--T:146--> 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. "<tvar name=3>zh-tw</tvar>").</translate> <translate><!--T:147--> If the wiki does not have language variants, set to <tvar name=1>{{phpi|false}}</tvar>.</translate> <translate><!--T:148--> See also <tvar name=1>{{ll|Manual:$wgVariantArticlePath|$wgVariantArticlePath}}</tvar>.</translate>
|valign="top"|{{Hiddensort|1.13}}MW 1.13+
|false
|-
|valign="top"|<code>{{anchor|wgVersion}}{{ll|Manual:$wgVersion|wgVersion}}</code>
|valign="top"| <translate><!--T:188--> String</translate>
|valign="top"| <translate><!--T:149--> Identifies the version of MediaWiki that served the page.</translate> 
|valign="top"|{{Hiddensort|1.12}}MW 1.12+
|1.42.0-wmf.26
|-
| valign="top" |<code>{{Visible anchor|wgMFMode}}</code>
| valign="top" |String (or null)
|valign="top"| <translate><!--T:259--> Whether the current web response was formatted for a mobile device (e.g. by [[Extension:MobileFrontend|MobileFrontend]] based on user agent, URL param, or cookie). Only boolean use is supported. In practice it is null or string, and the exact string is considered internal. This may become a real boolean in the future.</translate>
| valign="top" |MW 1.21+ ([[gerrit:r/52270|change 52270]], [[phab:T390923|T390923]], [[phab:T299772|T299772]])
|
|}

<translate>

=== All pages (user/page-specific) === <!--T:42-->
</translate>
{| class="wikitable sortable"
! <translate><!--T:26--> Name</translate>
! <translate><!--T:27--> Type</translate>
! <translate><!--T:28--> Description</translate>
! <translate><!--T:29--> Availability</translate>
! <translate><!--T:189--> Example output</translate>
|-
| valign="top" |<code>{{Visible anchor|wgAction}}</code>
|valign="top"| <translate><!--T:190--> String</translate>
|valign="top"| <translate><!--T:150--> The action performed, e.g. "<tvar name=1>edit</tvar>" for edit pages, or "<tvar name=2>view</tvar>" for page views.</translate> <translate><!--T:151--> See [[<tvar name=1>Special:MyLanguage/Manual:Parameters to index.php#Actions</tvar>|Manual:Parameters to index.php#Actions]].</translate>
| valign="top" |MW 1.10+
|view
|-
| valign="top" |<code>{{Visible anchor|wgArticleId}}</code>
|valign="top"| <translate><!--T:191--> Integer</translate>
|valign="top"| <translate><!--T:152--> The internal ID (page ID) of the page. For non-existent pages and special pages, it is zero.</translate>
| valign="top" |MW 1.8+
|17317
|-
| valign="top" |<code>{{Visible anchor|wgCanonicalNamespace}}</code>
|valign="top"| <translate><!--T:192--> String</translate>
|valign="top"| <translate><!--T:153--> The canonical (i.e., not localized or aliased) <tvar name=1>{{ll|Manual:namespace|namespace}}</tvar> name of the page.</translate>
| valign="top" |MW 1.8+
|Manual
|-
| valign="top" |<code>{{Visible anchor|wgCanonicalSpecialPageName}}</code>
|valign="top"| <translate><!--T:154--> String or <tvar name=1>{{phpi|false}}</tvar> or not defined</translate>
|valign="top"| <translate><!--T:155--> On special pages, the canonical (i.e., not localized or aliased) name of the special page; otherwise it is set to <tvar name=1>{{phpi|false}}</tvar> (since MW 1.16; previously not defined at all in that case).</translate>
| valign="top" |MW 1.9+
|false
|-
| valign="top" |<code>{{Visible anchor|wgCategories}}</code>
|valign="top"| <translate><!--T:193--> Array of strings</translate>
|valign="top"| <translate><!--T:156--> The list of all the categories a page belongs to.</translate> <translate><!--T:157--> This is essentially a JavaScript version of the category box shown on the page (grey box at bottom of page, in Monobook/Vector).</translate> <translate><!--T:158--> If the category box is not shown on the current page (as is the case when editing/viewing history), <tvar name=1><code>wgCategories</code></tvar> will be an empty array.</translate> {{note|1=<translate><!--T:168--> This is not available in MobileFrontend, regardless of the advanced mode being on or off.</translate>}}
| valign="top" |MW 1.16+
|['JavaScript']
|-
| valign="top" |<code>{{Visible anchor|wgCurRevisionId}}</code>
|valign="top"| <translate><!--T:194--> Integer</translate>
|valign="top"| <translate><!--T:159--> The top revision ID of the currently viewed page at the time the page was served.</translate> <translate><!--T:160--> Also set on diff and history pages; zero for special pages.</translate>
| valign="top" |MW 1.9+
|6400980
|-
| valign="top" |<code>{{Visible anchor|wgIsArticle}}</code>
|valign="top"| <translate><!--T:195--> Boolean</translate>
|valign="top"| <translate><!--T:196--> <tvar name=1>{{phpi|true}}</tvar> if the page displays the content of a wiki page, e.g. when viewing a page (regardless of namespace), or when viewing an old revision or diff with rendered content below it.</translate> <translate><!--T:197--> It is <tvar name=1>{{phpi|false}}</tvar> for anything else (edit form, history page, special pages, most generated pages, etc.).</translate>
{{note|1=<translate><!--T:245--> This variable is badly named – it is not related to a page being a main namespace "article".</translate>}}
| valign="top" |MW 1.8+
|true
|-
| valign="top" |<code>{{Visible anchor|wgIsProbablyEditable}}</code>
|valign="top"| <translate><!--T:198--> Boolean</translate>
|valign="top"| <translate><!--T:249--> <tvar name=1>{{phpi|true}}</tvar> if the page is probably editable (based on <tvar name=2>{{phpi|Title::quickUserCan}}</tvar>) by the current user.</translate> <translate><!--T:199--> The 'probably' is necessary for performance reasons.</translate> <translate><!--T:250--> An exact editability check is too costly here, due to cascading protection and hook-based extensions like <tvar name=1>{{ll|Extension:TitleBlacklist|TitleBlacklist}}</tvar> that may be enabled.</translate>  <translate><!--T:251--> If this is <tvar name=1>{{phpi|true}}</tvar>, it is likely to be editable.</translate> <translate><!--T:252--> If it is <tvar name=1>{{phpi|false}}</tvar>, it is definitely not editable.</translate>
| valign="top" |({{git|0bbc358951e56fbb3e2e121a02cf213e280ffdc1}})
|true
|-
| valign="top" |<code>{{Visible anchor|wgIsRedirect}}</code>
|valign="top"| <translate><!--T:200--> Boolean</translate>
|valign="top"| <translate><!--T:161--> <tvar name=1>{{phpi|true}}</tvar> if the page is a redirect to a wiki page using {{<tvar name=2>tmpl|0=<code>#REDIRECT <nowiki>[[</nowiki>$1<nowiki>]]</nowiki></code></tvar>|Target page name}}.</translate> <translate><!--T:162--> It is <tvar name=1>{{phpi|false}}</tvar> for anything else (normal pages, special pages, most generated pages, etc.).</translate>
| valign="top" |MW 1.22+ ([[gerrit:75478]])
|false
|-
| valign="top" |<code>{{Visible anchor|wgNamespaceNumber}}</code>
|valign="top"| <translate><!--T:201--> Integer</translate>
| valign="top" | <translate><!--T:246--> The number of the {{<tvar name=1>ll|Manual:namespace</tvar>|namespace}} the page is in.</translate>
| valign="top" |MW 1.8+
|100
|-
| valign="top" |<code>{{Visible anchor|wgPageContentLanguage}}</code>
|valign="top"| <translate><!--T:202--> String</translate>
|valign="top"| <translate><!--T:253--> Language code of the <tvar name=1>{{ll|page content language}}</tvar> (according to <tvar name=2>{{phpi|$context->getTitle()->getPageLanguage()}}</tvar>)</translate>
| valign="top" |MW 1.19+ ({{r|104483}})
|en
|-
| valign="top" |<code>{{Visible anchor|wgPageContentModel}}</code>
|valign="top"| <translate><!--T:203--> String</translate>
|valign="top"| <translate><!--T:204--> <tvar name=1><code>'wikitext'</code></tvar> on typical wiki pages, <tvar name=2><code>'javascript'</code></tvar> on pages interpreted as JavaScript, <tvar name=3><code>'css'</code></tvar> on pages interpreted as CSS, <tvar name=4><code>'Scribunto'</code></tvar> on pages interpreted as Scribunto (Lua).</translate>
| valign="top" |{{Hiddensort|1.16}}MW 1.22+ ([[gerrit:62178]])
|wikitext
|-
| valign="top" |<code>{{Visible anchor|wgPageName}}</code>
|valign="top"| <translate><!--T:205--> String</translate>
|valign="top"| <translate><!--T:206--> 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 spaces replaced by underscores.</translate> <translate><!--T:207--> To get only the title without the namespace, use <tvar name=1><code>wgTitle</code></tvar>.</translate>
| valign="top" |MW 1.8+
|Manual:Interface/JavaScript
|-
| valign="top" |<code>{{Visible anchor|wgPageParseReport}}</code>
|valign="top"| <translate><!--T:208--> Object</translate>
|valign="top"| <translate><!--T:209--> Parser limit report for the page when parser data is available.</translate> <translate><!--T:210--> Includes data about parser limits, Lua statistics when Scribunto extension is enabled and parser cache information.</translate>
| valign="top" |MW 1.28+ ({{git|316207}})
|<nowiki>{limitreport: {...}, scribunto: {...}, cachereport: {...}}</nowiki>
|-
| valign="top" |<code>{{Visible anchor|wgRedirectedFrom}}</code>
|valign="top"| <translate><!--T:211--> String</translate>
|valign="top"| <translate><!--T:212--> When redirected contains the title of the page we were redirected from.</translate> <translate><!--T:213--> If the page was not redirected, the value is omitted entirely (absent in <tvar name=1><code>mw.config</code></tvar>).</translate> <translate><!--T:214--> Uses the same format as <tvar name=1><code>wgPageName</code></tvar>.</translate>
| valign="top" |MW 1.19+ ({{r|104668}})
|null
|-
| valign="top" |<code>{{Visible anchor|wgRelevantPageName}}</code>
|valign="top"| <translate><!--T:215--> String</translate>
|valign="top"| <translate><!--T:216--> The full name of the page to which content actions and navigation links (e.g. a skin's tabs) apply.</translate> <translate><!--T:254--> The AJAX watch function uses this to work correctly on special pages such as <tvar name=1>[[Special:MovePage]]</tvar> and <tvar name=2>[[Special:WhatLinksHere]]</tvar>.</translate>
| valign="top" |MW 1.19+ ({{r|113737}})
|Manual:Interface/JavaScript
|-
| valign="top" |<code>{{Visible anchor|wgRelevantUserName}}</code>
|valign="top"| <translate><!--T:217--> String or unset</translate>
|valign="top"| <translate><!--T:218--> 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.</translate>
| valign="top" |MW 1.23+ ({{git|88773}})
|null
|-
| valign="top" |<code>{{Visible anchor|wgRelevantPageIsProbablyEditable}}</code>
|valign="top"| <translate><!--T:219--> Boolean</translate>
|valign="top"| <translate><!--T:220--> Like <tvar name=1><code>wgIsProbablyEditable</code></tvar>, but applied to the contextually relevant page name from <tvar name=2><code>wgRelevantPageName</code></tvar> instead of strictly the current page being viewed.</translate> <translate><!--T:221--> For example, when viewing a page "<tvar name=1><code>Special:MovePage/Example</code></tvar>" this will indicate whether the subject page is editable.</translate>
|MW 1.30+ ({{git|dbfe9c99}})
|true
|-
| valign="top" |<code>{{Visible anchor|wgRestrictionEdit}}</code>
|valign="top"| <translate><!--T:222--> Array of strings or unset</translate>
|valign="top"| <translate><!--T:223--> 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.</translate> <translate><!--T:224--> For semi-protected pages, it'd contain <tvar name=1><code>["autoconfirmed"]</code></tvar>; for fully protected pages <tvar name=2><code>["sysop"]</code></tvar>.</translate> <translate><!--T:225--> If there are no explicit restrictions, the value is <tvar name=1><code>[]</code></tvar> (an array with no elements).</translate>
<translate><!--T:226--> This array contains only ''explicit'' protections.</translate> <translate><!--T:255--> Namespace-wide protections (e.g. MediaWiki namespace, <tvar name=1>{{ll|Manual:$wgNamespaceProtection|$wgNamespaceProtection}}</tvar>), cascading protections, or "protections" brought about by the <tvar name=2>{{ll|Extension:TitleBlacklist|TitleBlacklist}}</tvar> extension's "noedit" attribute, are ignored by this array.</translate> <translate><!--T:227--> On such pages, the value is normally <tvar name=1><code>[]</code></tvar>, unless additional protections have been applied specifically to that page.</translate>

<translate><!--T:228--> If the page does not exist, the variable is not set.</translate>
| valign="top" |MW 1.14+
|[]
|-
| valign="top" |<code>{{Visible anchor|wgRestrictionMove}}</code>
|valign="top"| <translate><!--T:229--> Array of strings</translate>
|valign="top"| <translate><!--T:230--> 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.</translate> <translate><!--T:231--> For semi-moveprotected pages, it'd contain <tvar name=1><code>["autoconfirmed"]</code></tvar>; for fully moveprotected pages <tvar name=2><code>["sysop"]</code></tvar>.</translate> <translate><!--T:232--> If there are no explicit restrictions, the value is <tvar name=1><code>[]</code></tvar> (an array with no elements).</translate> 
<translate><!--T:233--> This array contains only ''explicit'' protections.</translate> <translate><!--T:256--> Namespace-wide protections (e.g. MediaWiki namespace, <tvar name=1>{{ll|Manual:$wgNamespaceProtection|$wgNamespaceProtection}}</tvar>), cascading protections, or "protections" brought about by the <tvar name=2>{{ll|Extension:TitleBlacklist|TitleBlacklist}}</tvar> extension's "moveonly" attribute, are ignored by this array.</translate> <translate><!--T:234--> On such pages, the value is normally <tvar name=1><code>[]</code></tvar>, unless additional protections have been applied specifically to that page.</translate>
| valign="top" |MW 1.14+
|[]
|-
| valign="top" |<code>{{Visible anchor|wgRevisionId}}</code>
|valign="top"| <translate><!--T:54--> Integer</translate>
|valign="top"| <translate><!--T:55--> The revision ID of the currently viewed revision, or the right revision for diff views (But 0 when <tvar name=2>diffonly=yes</tvar>, <tvar name=1>{{phabricator|T231744}}</tvar>).</translate> <translate><!--T:56--> Also set on diff pages; zero for special pages, history pages, or anywhere else inapplicable.</translate>
| valign="top" |MW 1.22+ {{git|7fa7b71eb3a5dd24e75865162e4c06a4a6012524}}
|6400980
|-
| valign="top" |<code>{{Visible anchor|wgSearchType}}</code>
|valign="top"| <translate><!--T:57--> String or unset</translate>
|valign="top"| <translate><!--T:58--> The name of the search backend used to execute search requests.</translate>
| valign="top" |MW 1.23+ ({{git|118655}})
|CirrusSearch
|-
| valign="top" |<code>{{Visible anchor|wgTitle}}</code>
|valign="top"| <translate><!--T:59--> String</translate>
|valign="top"| <translate><!--T:60--> The page title, without the namespace.</translate> <translate><!--T:61--> May contain spaces – does not contain underscores.</translate> <translate><!--T:62--> To get the title including the namespace, use <tvar name=1><code>wgPageName</code></tvar>.</translate>
| valign="top" |MW 1.8+
|Interface/JavaScript
|}

<translate>
<!--T:63-->
Related to the user currently viewing the page:
</translate>

{| class="wikitable sortable"
! <translate><!--T:38--> Name</translate>
! <translate><!--T:39--> Type</translate>
! <translate><!--T:40--> Description</translate>
! <translate><!--T:41--> Availability</translate>
! <translate><!--T:235--> Example output</translate>
|-
| valign="top" |<code>{{Visible anchor|wgUserEditCount}}</code>
|valign="top"| <translate><!--T:64--> Integer</translate>
|valign="top"| <translate><!--T:65--> The number of edits the current user made (null if not logged in).</translate>
| valign="top" |{{Hiddensort|1.21}}MW 1.21+
|556
|-
| valign="top" |<code>{{Visible anchor|wgUserGroups}}</code>
|valign="top"| <translate><!--T:66--> Array of strings</translate>
|valign="top"| <translate><!--T:67--> An array containing all the (local) user groups the current user is a member of, or <tvar name=1><code>null</code></tvar> for non-logged-in users.</translate> <translate><!--T:68--> User groups are identified by the internal user group names, e.g. <tvar name=1>"sysop"</tvar>, <tvar name=2>"autoconfirmed"</tvar>, <tvar name=3>"bureaucrat"</tvar>, and so on.</translate> <translate><!--T:69--> The default user group is named <tvar name=1>"*"</tvar>.</translate>

If you'd like to check {{ll|Manual:User rights|user rights}}, there is no <code>wgUserRights</code> per [[phab:T233175]], but you can use <syntaxhighlight inline lang="js">mw.user.getRights().then(function (rights) { console.log('Rights:', rights); });</syntaxhighlight> or similar.
| valign="top" |MW 1.10+
|['autopatrolled', '*', 'user', 'autoconfirmed']
|-
| valign="top" |<code>{{Visible anchor|wgUserId}}</code>
|valign="top"| <translate><!--T:70--> Integer</translate>
|valign="top"| <translate><!--T:71--> The numeric ID of the current user (null if not logged in).</translate>
| valign="top" |{{Hiddensort|1.21}}MW 1.21+
|12311063
|-
| valign="top" |<code>{{Visible anchor|wgUserLanguage}}</code>
|valign="top"| <translate><!--T:72--> String</translate>
|valign="top"| <translate><!--T:73--> The language code for the user's interface language, as set in Special&rarr;Preferences (which may be overridden by a <tvar name=1><code>uselang=</code></tvar> parameter in the URL).</translate>
| valign="top" |{{Hiddensort|1.08}}MW 1.8+
|en
|-
| valign="top" |<code>{{Visible anchor|wgUserName}}</code>
|valign="top"| <translate><!--T:74--> String</translate>
|valign="top"| <translate><!--T:75--> The user name of the user currently viewing the page, if it's a logged-in user.</translate> <translate><!--T:76--> For non-logged-in users, it is <tvar name=1><code>null</code></tvar> (''not'' the user's IP address, unlike PHP <tvar name=2>{{phpi|$wgUser->getName()}}</tvar> on the server).</translate>
| valign="top" |MW 1.8+
|Your Username
|-
| valign="top" |<code>{{Visible anchor|wgUserRegistration}}</code>
|valign="top"| <translate><!--T:77--> Integer</translate>
|valign="top"| <translate><!--T:78--> The time and date on which the current user registered, represented as milliseconds since epoch.</translate> <translate><!--T:79--> Null if not logged in.</translate>
| valign="top" |{{Hiddensort|1.21}}MW 1.21+
|1514273653000
|}

<translate>
=== Some pages === <!--T:43-->

<!--T:80-->
Some additional variables are present only depending on the page namespace, wiki configuration and/or user preferences.
</translate>

{| class="wikitable sortable"
! <translate><!--T:30--> Name</translate>
! <translate><!--T:31--> Type</translate>
! <translate><!--T:32--> Description</translate>
! <translate><!--T:33--> Availability</translate>
|-
! colspan="4" style="color:var(--color-base, #202122); background-color:var(--background-color-interactive-subtle--active, #dadde3)" | <translate><!--T:236--> Main Page</translate>
|-
| valign="top" |<code>{{Visible anchor|wgIsMainPage}}</code>
|valign="top"| <translate><!--T:81--> Boolean</translate>
|valign="top"| <translate><!--T:82--> <tvar name=1>{{phpi|true}}</tvar> if the current page is the main page of the wiki.</translate> <translate><!--T:83--> Omitted entirely otherwise (defaulting to <tvar name=1>{{inline-code|null|lang=javascript}}</tvar> in <tvar name=2><code>mw.config</code></tvar>).</translate>
| valign="top" |MW 1.18+
|-
! colspan="4" style="color:var(--color-base, #202122); background-color:var(--background-color-interactive-subtle--active, #dadde3)" | <translate><!--T:84--> If the content language has variants:</translate>
|-
| valign="top" |<code>{{Visible anchor|wgUserVariant}}</code>
|valign="top"| <translate><!--T:85--> String</translate>
|valign="top"| <translate><!--T:86--> If the wiki has language variants, the language code of the user's preferred variant.</translate> <translate><!--T:87--> If the wiki does not have variants, the variable is not configured (''does not exist''), i.e.: <tvar name=1><br />{{inline-code|mw.config.exists( 'wgUserVariant' ); // false|lang=javascript}}<br />{{inline-code|mw.config.get( 'wgUserVariant' ); // null|lang=javascript}}</tvar>.</translate>
| valign="top" |MW 1.16+
|-
! colspan="4" style="color:var(--color-base, #202122); background-color:var(--background-color-interactive-subtle--active, #dadde3)" | <translate><!--T:88--> After saving an edit</translate>
|-
| valign="top" |<code>{{Visible anchor|wgPostEdit}}</code>
|valign="top"| <translate><!--T:89--> String</translate>
|valign="top"| <translate><!--T:90--> <tvar name=1>"saved"</tvar> if the user just saved this page.</translate> <translate><!--T:91--> <tvar name=1>"created"</tvar> if the user just created this page.</translate> <translate><!--T:92--> <tvar name=1>"restored"</tvar> if the user just restored this page by going to the history page, clicked on a timestamp link for an old revision, clicked on edit and then saved.</translate> <translate><!--T:93--> <tvar name=1><code>null</code></tvar> otherwise.</translate> <translate><!--T:237--> Note that:</translate>
# <translate><!--T:257--> On null edits, this is <tvar name=1><code>null</code></tvar>, not "saved"</translate>
# <translate><!--T:258--> When using "undo", this is "saved"</translate>
# <translate><!--T:238--> On rollback, this is <tvar name=1><code>null</code></tvar></translate>
| valign="top" |MW 1.21+ ([[gerrit:50480]])
|-
!colspan="4" style="color:var(--color-base, #202122); background-color:var(--background-color-interactive-subtle--active, #dadde3)"| <translate><!--T:94--> When comparing revisions</translate>
|-
|valign="top"| <code>{{Visible anchor|wgDiffOldId}}</code>
|valign="top"| <translate><!--T:239--> Integer</translate>
|valign="top"| <translate><!--T:95--> Revision ID of the "old" revision when viewing a diff.</translate> <translate><!--T:96--> Only available when viewing a revision comparison.</translate>
|MW 1.30+ ({{git|a469795efc5bc1c585c9f84ee289ee099833661d}})
|-
|valign="top"| <code>{{Visible anchor|wgDiffNewId}}</code>
|valign="top"| <translate><!--T:240--> Integer</translate>
|valign="top"| <translate><!--T:97--> Revision ID of the "new" revision when viewing a diff.</translate> <translate><!--T:98--> Only available when viewing a revision comparison.</translate>
|MW 1.30+ ({{git|a469795efc5bc1c585c9f84ee289ee099833661d}})
|}

<translate>
=== Page specific (Wikibase extension) === <!--T:15-->

<!--T:99-->
Some additional information will be available when the site supports <tvar name=1>{{ll|Wikibase}}</tvar>:
</translate>

{|class="wikitable sortable"
! <translate><!--T:34--> Name</translate>
! <translate><!--T:35--> Type</translate>
! <translate><!--T:36--> Description</translate>
! <translate><!--T:37--> Availability</translate>
|-
|valign="top"|<code>{{Visible anchor|wgWikibaseItemId}}</code>
|valign="top"| <translate><!--T:100--> String</translate>
|valign="top"| <translate><!--T:101--> The Wikibase item ID of the current page.</translate> <translate><!--T:102--> Currently, in the edit mode, this variable is not set.</translate> <translate><!--T:103--> See <tvar name=1>[[phab:T185437]]</tvar>.</translate>
|valign="top"|?
|}

<translate>
=== Hooks for extensions === <!--T:17-->
</translate>
* {{ll|Manual:Hooks/ResourceLoaderGetConfigVars|ResourceLoaderGetConfigVars}} - <translate><!--T:104--> Since MediaWiki 1.17 extensions can add their own site-wide variables through this hook.</translate>
* {{ll|Manual:Hooks/MakeGlobalVariablesScript|MakeGlobalVariablesScript}} - <translate><!--T:105--> Since MediaWiki 1.14 extensions can add their own variables to the <tvar name=1>OutputPage</tvar>.</translate> <translate><!--T:106--> If the variable is not dependent on the page being viewed, use the <tvar name=1>{{ll|Manual:Hooks/ResourceLoaderGetConfigVars|ResourceLoaderGetConfigVars}}</tvar> hook instead.</translate>

<translate>
==See also == <!--T:163-->
</translate>
* [[How to enhance wiki content with JavaScript]]
* <translate><!--T:241--> [<tvar name=url>https://www.npmjs.com/package/types-mediawiki</tvar> TypeScript definitions] for the JavaScript interface (work in JavaScript projects as well in popular IDEs)</translate>

[[Category:JavaScript{{#translation:}}]]