Template:ExtensionInstall

Download and move the extracted ExtensionInstall folder to your extensions/ directory.
Developers and code contributors should install the extension from Git instead, using:cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/ExtensionInstall

Add the following code at the bottom of your LocalSettings.php file:

require_once "$IP/extensions/ExtensionInstall/ExtensionInstall.php";

Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Template documentation

Uses Lua:

Module:Extension

Usage

Installation instructions.

Template parameters[Edit template data]
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Extension name	`1`	Set the extension name manually. Default The current page name without namespace prefix. Auto value `{{ROOTPAGENAME}}`	String	optional
Git submodule	`git-submodule`	Add --recurse-submodules to the git clone command	Boolean	optional
Vagrant role name	`vagrant`	If given, shows how to install extension with the Vagrant's enable-role command	String	optional
Download link	`download-link`	Overwrite the download link. Default Link to Special:ExtensionDistributor with the extension name.	URL	optional
LocalSettings early	`localsettingsearly`	Pass custom php code that the user should include in [[LocalSettings.php]] before the extension is loaded. Example $wgUseAjax = true; //must be included before the extension is loaded	Unknown	optional
LocalSettings	`localsettings`	Pass custom php code that the user should include in [[LocalSettings.php]]. Example $wgUseAjax = true;	Unknown	optional
Database update	`db-update`	If the extension has one or more database tables that need to be created through [[update.php]], set this parameter to any value. Default false	Boolean	optional
Composer	`composer`	If the extension uses [[Composer]] to manage dependencies, set this parameter to any value. Default false	Boolean	optional
Custom steps 0	`custom-steps0`	Additional steps before download, e.g. other required extensions (as an unordered "* list")	Content	optional
Custom steps	`custom-steps`	Additional steps (as an unordered "* list")	Content	optional
Supports registration	`registration`	Changes the template to use <code>wfLoadExtension()</code> if it supports registration. Set to any value if the extension supports registration, or to <code>required</code> if it <em>only</em> supports registration and doesn't support the old-style of loading.	String	optional
No registration version	`no-registration-version`	The MediaWiki version for which extension registration should not be used Default 1.24	Unknown	optional

Examples

Below a few examples of how to use this template:

Simple

{{ExtensionInstall}}

Name

{{ExtensionInstall|CategoryTree}}

Download link

{{ExtensionInstall
|download-link=[http://bits.wikimedia.org/example.zip Download]
}}

LocalSettings

{{ExtensionInstall
|localsettings=
$wgUseAjax = true;
}}

LocalSettings early

{{ExtensionInstall
|localsettingsearly=
$wgUseAjax = true; // this must be included before the extension is loaded
}}

DB Update

{{ExtensionInstall
|db-update=Yes
}}

Composer

{{ExtensionInstall
|composer=Yes
}}

Custom steps

{{ExtensionInstall
|custom-steps=
* Lorem ipsum dolor sit amet
* Foo bar baz quux [[sandbox]]
}}

Support registration

{{ExtensionInstall
|registration=1
}}

Support registration with minimum version

{{ExtensionInstall
|registration=1
|no-registration-version=1.39
}}

This only works if the version specified is 1.35 or later, otherwise the template assumes nobody cares about ancient versions and falls back to #Require registration.

Require registration

{{ExtensionInstall
|registration=required
}}

Everything

{{ExtensionInstall|Example
|download-link=[http://bits.wikimedia.org/example.zip Download]
|vagrant=example
|localsettings=
$wgUseAjax = true;

|db-update=Yes
|composer=Yes
|custom-steps=
* Lorem ipsum dolor sit amet
* Foo bar baz quux [[sandbox]]
|registration=yes
}}