This is aninformation page. It is neither anencyclopedia article nor one ofWikipedia's policies or guidelines; rather, its purpose is to explain certain aspects of Wikipedia's norms, customs, technicalities, or practices. It may reflect differing levels ofconsensus andvetting. |
| You takefull responsibility for any actions taken using any user script. You must read and abide by all relevantWikipedia policies when using this tool; failure to do so may result in beingblocked from editing. |
User scripts are programs written inJavaScript to facilitate the editing of Wikipedia. User scripts enable user accounts to do things they otherwise could not. Many user scripts are available, ready for you to install. Also, you can write a new user script, either by modifying an existing script or by starting from scratch.
User scripts have unlimited access to your account by their very nature – unlikeOAuth/bot password based applications such asHuggle, where you can control access levels, the script runs in your browser. Anything you can do on Wikipedia, it can do. As such, and this is especially pertinent to users with advanced permissions, make sure that you trust the user who wrote the script, as you will be held responsible for any actions it takes on your behalf. If you are "importing" a script (instead of copying the code itself) be warned that the user you are importing from could alter their script at any time. Only import from users you trust.
If you come across or write a user script, please add it toWikipedia:User scripts/List andCategory:Wikipedia scripts. To add new scripts to the main list, use the{{user script table row}} template. Include at least the code page path and a short description. For example:
{{user script table row|name=My script|code=User:Example/MyJSpage.js|doc=User:Example/MyJSdocumentationPage|desc=This script does something useful.}}Don't see what you need? You canrequest a new user script or search for an existing script.
Search within the code of user scripts:
Search user scripts by their title:
Method for scripts which are located on theEnglish Wikipedia.
{{subst:Iusc|script_path}} – replace "script_path" with the full name of the .js page that opens when a script's "(source)" link is clicked. TheInstall user script (Iusc) template will add the necessaryimportScript() line along with a backlink.{{subst:Iusc|User:TheDJ/sharebox.js}}Method for scripts which are not located on theEnglish Wikipedia.
Many of these scripts may not work at other wikis, either because the wiki has a different setup or their home wiki's URL is hardcoded into the script. Most script authors probably don't think about how to make their script work at other wikis. If you install a script globally, then you should avoid also keeping a copy inyour local common.js file. Otherwise, the same script is loaded twice when using that wiki and may cause issues.
SCRIPT_PATH with the full name of the .js page that opens when a script's "(source)" link is clicked:mw.loader.load( '//en.wikipedia.org/wiki/SCRIPT_PATH?action=raw&ctype=text/javascript' );
mw.loader.load( '//en.wikipedia.org/wiki/User:GhostInTheMachine/NoEditSummary.js?action=raw&ctype=text/javascript' );
If you encounter issues with a script, first tryclearing your browser cache andpurging the server cache. If you have any ad blockers or similar extensions installed, such asNoScript, check that wikipedia.org, wikimedia.org, mediawiki.org, and wikidata.org are exempted from any filters.
If you continue to experience problems, or if site functionality is significantly broken for you (for example, you are unable to edit any pages), you can enablesafe mode to temporarily deactivate all on-wiki scripts and stylesheets.
To temporarily enable safe mode, add?safemode=1 to the end of the web address (URL) of the page. Example:https://en.wikipedia.org/wiki/Main_Page?safemode=1. If the URL already includes a?, add&safemode=1 instead. Example:https://en.wikipedia.org/w/index.php?title=Main_Page&safemode=1.
Safe mode can be enabled on all pages by default by going to youruser preferences, selecting theAppearance tab, then enabling theAlways enable safe mode option.
User scripts and site gadgets will not run on the user preferences page, so you can still make changes to your account, such as changing your password, even if you have a faulty script installed.
Instructions for writing your own user scripts are included inWikipedia:User scripts/Guide.
Additional script-writing resources are presented below.
The following code snippets still exist under the now defunct WikiProject User scripts. Many are still in use by live scripts, and they may provide insights for current script developers.
To advertise your user script development skills on your user page, you can use these userboxes.
| Markup | Renders as | ||
|---|---|---|---|
{{user script developer}} |
| ||
{{user script developer2}} |
| ||
{{user scripts created}} |
| ||
{{user scripts created|99}} |
|