imported>Oshwah: /* importScript() vs mw.loader.load() */ Improving to make complete sentences.

2025-09-15T20:56:47Z

importScript() vs mw.loader.load(): Improving to make complete sentences.

New page

{{Documentation subpage}}{{template shortcuts|lusc}}
{{Subst only}}

This template is used to install [[WP:US|user scripts]] that reside on the English Wikipedia. It is to be used primarily on [[Special:MyPage/common.js]] or [[Special:MyPage/skin.js]]. It adds the necessary <code>mw.loader.load</code> line along with a [[WP:Backlink|backlink]].

== Usage ==
In order to install a user script for your Wikipedia account, add the following line to [[Special:MyPage/common.js]] or [[Special:MyPage/skin.js]]:

<code><nowiki>{{subst:lusc|script_path}}</nowiki></code>
*Replace <code>script_path</code> with the full .js page name of the user script to be installed.
*The template '''must''' be [[WP:SUBST|substituted]] (<code>subst:</code>), or else it won't work.
*[[WP:BYPASS|Bypass your cache]] after saving the page.

== Example ==
<code><nowiki>{{subst:lusc|User:Example/script.js}}</nowiki></code>
*'''Produces:''' <code>mw.loader.load( '{{localurl:User:Example/script.js|action=raw&ctype=text/javascript}}' ); // Backlink: <nowiki>[[User:Example/script.js]]</nowiki></code>

<code><nowiki>{{subst:lusc|User:Example/script.js|User:Example/script}}</nowiki></code>
*'''Produces:''' <code>mw.loader.load( '{{localurl:User:Example/script.js|action=raw&ctype=text/javascript}}' ); // Backlink: <nowiki>[[User:Example/script]]</nowiki></code>

== importScript() vs mw.loader.load() ==
{{T|Install user script}} uses importScript(), and {{T|Load user script}} uses mw.loader.load().

importScript():

* Is less verbose, only needing the string of the page you're loading.
* Is more restrictive, only allowing the loading of Wikipedia pages in the user or MediaWiki namespaces.
* Can load from other Wikimedia wikis, using a prefix such as "c" for "commons". For example, <code>importScript('c:User:YourName/test.js');</code>
** '''However''', this usage is not recommended as it involves an extra round trip. mw.loader.load is faster for cross-wiki loads.
* Makes your common.js file more readable, since it is less verbose.

mw.loader.load():

* Is more verbose, needing a long URL string. Note that the URL string has to be correctly escaped.
* Is less restrictive, allowing you to load any URL from anywhere. For example: it is good for loading from a local dev environment such as localhost.
* Can load from other Wikimedia wikis by adjusting the URL.
* Makes your common.js file less readable, since it is more verbose.

== See also ==
* {{tl|Install user script}} ({{tl|iusc}}) – Version of this script that uses the <code>importScript()</code> method.
* {{tl|Load user stylesheet}}
{{Wikipedia:User scripts/Navbox}}
<includeonly>{{Sandbox other||
[[Category:Wikipedia JavaScript templates]]
[[Category:Wikipedia scripts|*]]
[[Category:Wikipedia user script templates]]
}}</includeonly>

Template:Load user script/doc - Revision history

imported>Oshwah: /* importScript() vs mw.loader.load() */ Improving to make complete sentences.