Manual:Extensions

From MediaWiki.org
Jump to: navigation, search
Translate this page
Other languages:
العربية • ‎dansk • ‎Deutsch • ‎Ελληνικά • ‎English • ‎español • ‎français • ‎magyar • ‎Bahasa Indonesia • ‎日本語 • ‎한국어 • ‎polski • ‎پښتو • ‎português do Brasil • ‎русский • ‎سنڌي • ‎ไทย • ‎Türkçe • ‎中文
Gnome-preferences-other.svg Extensions:Manual:Extensions DevelopmentManual:Developing extensions Tag extensionsManual:Tag extensions Parser functionsManual:Parser functions HooksManual:Hooks Special pagesManual:Special pages SkinsManual:Skins Magic wordsManual:Magic words APIAPI:Extensions

What are extensions?

MediaWiki extensions

Extensions let you customize how MediaWiki looks and works.

Wiki users can browse through existing extensions or request a new extension. System administrators can install (or remove) extensions on the MediaWiki installations that they manage. Developers can write new extensions or improve or maintain existing extensions.

Search the extensions by keyword(s):

Depending on your goals you can use extensions to:

While some extensions are maintained by MediaWiki's developers, others were written by third-party developers. As a result, many have bugs, and they are not all guaranteed to be compatible with each other. Some are unmaintained; not all extensions work on all versions of MediaWiki. Use any extension, especially those tagged as insecure, at your own risk. When using an extension requiring patches to the core MediaWiki code or entries in your database(s), be sure to create a back-up of your database and/or the core MediaWiki code, to avoid the risk of permanently breaking your wiki.

Browsing extensions

You can browse Category:Extensions by categoryCategory:Extensions by category to see the full range of extensions that have already been written. Comparison of extensions in distributionsComparison of extensions in distributions may also be helpful to pick out extensions. For information on installing these extensions or writing your own, see below.

Checking installed extensions

Only someone with administration access to the filesystem (and often the database too) on a server can install extensions for MediaWiki, but anyone can check which extensions are active on an instance of MediaWiki by accessing the Special:Version page. For example, these extensions are active in the English Wikipedia.

Installing an extension

MediaWiki is ready to accept extensions just after installation is finished. To add an extension follow these steps:

  1. Before you start
    Many extensions provide instructions designed for installation using unix commands. You require shell access (SSH) to enter these commands listed on the extension help pages.
  2. Download your extension.
    Extension Distributor helps you to select and download most of the popular extensions.
    Extensions are usually distributed as modular packages. They generally go in their own subdirectory of $IPManual:$IP/extensions/. A list of extensions stored in the Wikimedia Git repository is located at git:mediawiki/extensions. Some extensions don't use version control and are not recommended.
    Some extensions are also available in bundles, composercomposer or package repositories.
  3. Install your extension..
    Generally, at the end of the LocalSettings.phpManual:LocalSettings.php file (but above the PHP end-of-code delimiter, "?>", if present), the following line should be added:
    // mw.v 1.24.x or less
require_once "$IP/extensions/extension_name/extension_name.php";
// mw.v 1.25.x or above
wfLoadExtension( '<extension-name>' );
    This line forces the PHP interpreter to read the extension file, and thereby make it accessible to MediaWiki.
    Some extensions can conflict with maintenance scripts, for example if they directly access $_SERVER (not recommended).
    In this case they can be wrapped in the conditional so maintenance scripts can still run.
//for mw.v 1.24.x or less
if (!$wgCommandLineMode) {
   require_once "$IP/extensions/extension_name/extension_name.php";
}
//for mw.v 1.25.x or above
if (!$wgCommandLineMode) {
   wfLoadExtension ( '<extension-name>' );
}
The maintenance script importDump.phpManual:ImportDump.php will fail for any extension which requires customized namespaces which is included inside the conditional above such as Extension:Semantic MediaWikiExtension:Semantic MediaWiki, Extension:Semantic FormsExtension:Semantic Forms.
Ensure that required permissions are set for extensions!
While this installation procedure is sufficient for most extensions, some require a different installation procedure. Check your extension's documentation for details.
If you want to alter configuration variables in LocalSettings.php, you have to do this typically after including the extension. Otherwise defaults defined in the extension will overwrite your settings.
Caution! Caution: While extension declaration can be placed in other places within the LocalSettings.php file, never place extensions before the require_once "includes/DefaultSettings.php"; line for MediaWiki versions below 1.17 . Doing so will blank the extension setup function arrays, causing no extensions to be installed, and probably will make your wiki inaccessible until you fix it!

Upgrading an extension

Some extensions require to be updated whenever you update MediaWiki, while others work with multiple versions. To upgrade to a new version of an extension:

  1. Download the new version of the extension
  2. Replace all the extension files in the extension/ExtensionName directory with the new files. Do not remove the extension configuration present in LocalSettings.php
  3. Depending on the extension, you may have to run the Update.php maintenance script. Most extensions will mention if this script needs to be run or not. (Running the update.php script when its unnecessary will not hurt anything, so if you're unsure don't be afraid to run it). If you don't have command line access, you can also use the web updater.
  4. That's all you need to do. In most cases any extension configuration you have in LocalSettings.php will also work with the newer version of the extension.
These instructions cover 99% of extensions. If the specific extension you are upgrading has instructions that differ from these, you should probably follow the specific extension's instructions

Uninstalling an extension

Extensions are added by adding a line to LocalSettings.php, which basically looks like this:

// mw.v 1.24.x or less
require_once 'extensions/extension_name/extension_name.php';
// mw.v 1.25.x or above
wfLoadExtension( '<extension-name>' );
Depending on the extension you want to uninstall additionally other stuff might be done on installation, which you want to undo now. For details see the section on installing an extension.
  1. Remove this line and the extension is uninstalled. If you want to, you can (and if you do not want to use this extension in the future you should) remove the files of this extension inside the folder "extensions/".
  2. Maybe you also have some other lines in LocalSettings.php, which have to do with the extension you want to remove. Most likely this will be lines, which give certain users the right to access pages, which are provided by the extension. These lines contain the variable "$wgGroupPermissions" and make some settings there. As far as they have to do with rights, which come from the removed extension, you can remove these lines as well.
  3. Maybe your extension also has added columns to your database. The updater maintenance/update.php removes them, when you run it, after you have uninstalled the extension.

Developing extensions

This complex topic is handled on the developing extensions manual page.

See also

ExtensionsManual:Extensions: Category:Category:Extensions • All:Category:All extensions • Requests • Tag extensionsManual:Tag extensions • Extensions FAQExtensions FAQ • Extension hook registry • Extension default namespaces
Retrieved from "https://www.mediawiki.org/w/index.php?title=Manual:Extensions&oldid=2372547"