Template:ExtensionInstall

• Download and place the file(s) in a directory called ExtensionInstall in your extensions/ folder.
• Add the following code at the bottom of your LocalSettings.php :

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

•  <translate> Done</translate> – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Template documentation

Usage

Template parameters

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
Vagrant role name	vagrant	If given, shows how to install extension with the Vagrant's enable-role command Auto value	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}}

• <translate> [[<tvar name=2>Special:ExtensionDistributor/MyExtension</tvar>|Download]] and place the file(s) in a directory called <tvar name=name>MyExtension</tvar> in your <tvar name=ext>extensions/</tvar> folder.</translate>
• <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php </tvar>:</translate>

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

•  <translate> Done</translate> – <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>

Name

{{ExtensionInstall|CategoryTree}}

• <translate> [[<tvar name=2>Special:ExtensionDistributor/CategoryTree</tvar>|Download]] and place the file(s) in a directory called <tvar name=name>CategoryTree</tvar> in your <tvar name=ext>extensions/</tvar> folder.</translate>
• <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php </tvar>:</translate>

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

•  <translate> Done</translate> – <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>

Download link

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

• <translate> <tvar name=1>Download</tvar> and place the file(s) in a directory called <tvar name=name>MyExtension</tvar> in your <tvar name=ext>extensions/</tvar> folder.</translate>
• <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php </tvar>:</translate>

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

•  <translate> Done</translate> – <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>

LocalSettings

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

• <translate> [[<tvar name=2>Special:ExtensionDistributor/MyExtension</tvar>|Download]] and place the file(s) in a directory called <tvar name=name>MyExtension</tvar> in your <tvar name=ext>extensions/</tvar> folder.</translate>
• <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php </tvar>:</translate>

  require_once "$IP/extensions/MyExtension/MyExtension.php";
  $wgUseAjax = true;
  

•  <translate> Done</translate> – <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>

LocalSettings early

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

• <translate> [[<tvar name=2>Special:ExtensionDistributor/MyExtension</tvar>|Download]] and place the file(s) in a directory called <tvar name=name>MyExtension</tvar> in your <tvar name=ext>extensions/</tvar> folder.</translate>
• <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php </tvar>:</translate>

  $wgUseAjax = true; // this must be included before the extension is loaded
  require_once "$IP/extensions/MyExtension/MyExtension.php";
  

•  <translate> Done</translate> – <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>

DB Update

{{ExtensionInstall
|db-update=Yes
}}

• <translate> [[<tvar name=2>Special:ExtensionDistributor/MyExtension</tvar>|Download]] and place the file(s) in a directory called <tvar name=name>MyExtension</tvar> in your <tvar name=ext>extensions/</tvar> folder.</translate>
• <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php </tvar>:</translate>

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

• <translate> Run the [[<tvar name=update>Special:MyLanguage/Manual:Update.php</tvar>|update script]] which will automatically create the necessary database tables that this extension needs.</translate>
•  <translate> Done</translate> – <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>

Composer

{{ExtensionInstall
|composer=Yes
}}

• <translate> [[<tvar name=2>Special:ExtensionDistributor/MyExtension</tvar>|Download]] and place the file(s) in a directory called <tvar name=name>MyExtension</tvar> in your <tvar name=ext>extensions/</tvar> folder.</translate>
• <translate> Only when installing from Git, run <tvar name=composer>Composer</tvar> to install PHP dependencies, by issuing <tvar name=code>composer install --no-dev</tvar> in the extension directory.</translate> <translate> (See <tvar name=phab><translate> task <tvar name=1>T173141</tvar></translate></tvar> for potential complications.)</translate>
• <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php </tvar>:</translate>

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

•  <translate> Done</translate> – <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>

Custom steps

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

• <translate> [[<tvar name=2>Special:ExtensionDistributor/MyExtension</tvar>|Download]] and place the file(s) in a directory called <tvar name=name>MyExtension</tvar> in your <tvar name=ext>extensions/</tvar> folder.</translate>
• <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php </tvar>:</translate>

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

• Lorem ipsum dolor sit amet
• Foo bar baz quux sandbox
•  <translate> Done</translate> – <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>

Support registration

{{ExtensionInstall
|registration=1
}}

• <translate> [[<tvar name=2>Special:ExtensionDistributor/MyExtension</tvar>|Download]] and place the file(s) in a directory called <tvar name=name>MyExtension</tvar> in your <tvar name=ext>extensions/</tvar> folder.</translate>
• <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php </tvar>:</translate>

  wfLoadExtension( 'MyExtension' );
  

•  <translate> Done</translate> – <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>

<translate> To users running MediaWiki <tvar name=1>1.24</tvar> or earlier: </translate>

<translate> The instructions above describe the new way of installing this extension using <tvar name=LoadExtension>wfLoadExtension()</tvar>.</translate> <translate> If you need to install this extension on these earlier versions (MediaWiki <tvar name=1>1.24</tvar> and earlier), instead of <tvar name=code>wfLoadExtension( 'MyExtension' );</tvar>, you need to use:</translate>

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

Set recommended registration MediaWiki version

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

• <translate> [[<tvar name=2>Special:ExtensionDistributor/MyExtension</tvar>|Download]] and place the file(s) in a directory called <tvar name=name>MyExtension</tvar> in your <tvar name=ext>extensions/</tvar> folder.</translate>
• <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php </tvar>:</translate>

  wfLoadExtension( 'MyExtension' );
  

•  <translate> Done</translate> – <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>

<translate> To users running MediaWiki <tvar name=1>1.25</tvar> or earlier: </translate>

<translate> The instructions above describe the new way of installing this extension using <tvar name=LoadExtension>wfLoadExtension()</tvar>.</translate> <translate> If you need to install this extension on these earlier versions (MediaWiki <tvar name=1>1.25</tvar> and earlier), instead of <tvar name=code>wfLoadExtension( 'MyExtension' );</tvar>, you need to use:</translate>

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

Require registration

{{ExtensionInstall
|registration=required
}}

• <translate> [[<tvar name=2>Special:ExtensionDistributor/MyExtension</tvar>|Download]] and place the file(s) in a directory called <tvar name=name>MyExtension</tvar> in your <tvar name=ext>extensions/</tvar> folder.</translate>
• <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php </tvar>:</translate>

  wfLoadExtension( 'MyExtension' );
  

•  <translate> Done</translate> – <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>

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
}}

• <translate> <tvar name=1>Download</tvar> and place the file(s) in a directory called <tvar name=name>Example</tvar> in your <tvar name=ext>extensions/</tvar> folder.</translate>
• <translate> Only when installing from Git, run <tvar name=composer>Composer</tvar> to install PHP dependencies, by issuing <tvar name=code>composer install --no-dev</tvar> in the extension directory.</translate> <translate> (See <tvar name=phab><translate> task <tvar name=1>T173141</tvar></translate></tvar> for potential complications.)</translate>
• <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php </tvar>:</translate>

  wfLoadExtension( 'Example' );
  $wgUseAjax = true;
  

• <translate> Run the [[<tvar name=update>Special:MyLanguage/Manual:Update.php</tvar>|update script]] which will automatically create the necessary database tables that this extension needs.</translate>
• Lorem ipsum dolor sit amet
• Foo bar baz quux sandbox
•  <translate> Done</translate> – <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>

<translate> To users running MediaWiki <tvar name=1>1.24</tvar> or earlier: </translate>

<translate> The instructions above describe the new way of installing this extension using <tvar name=LoadExtension>wfLoadExtension()</tvar>.</translate> <translate> If you need to install this extension on these earlier versions (MediaWiki <tvar name=1>1.24</tvar> and earlier), instead of <tvar name=code>wfLoadExtension( 'Example' );</tvar>, you need to use:</translate>

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

<translate> Vagrant installation:</translate>

• <translate> If using <tvar name=vagrant>Vagrant </tvar>, install with <tvar name=code>vagrant roles enable example --provision</tvar></translate>

Editors can experiment in this template’s sandbox (create | mirror) and testcases (create) pages.
Subpages of this template.