Plopilpy: 1 revision imported

2026-01-04T20:50:28Z

1 revision imported

← Older revision		Revision as of 20:50, 4 January 2026
(No difference)

mw>FuzzyBot: Updating to match new version of source page

2025-06-20T22:04:17Z

Updating to match new version of source page

New page

<noinclude>
<languages/>
</noinclude>{{trim| {{{custom-steps0|}}} }}
* {{#if:{{{download-link|}}}
|{{{download-link|}}} and place the file(s) in a directory called <code>{{trim| {{#if:{{{1|}}}|{{{1}}}|{{ROOTPAGENAME}}}} }}</code> in your <code>extensions/</code> folder.
|{{#if:{{{1|}}}{{#invoke:Extension|isOnGerrit}}
|[[Special:ExtensionDistributor/{{trim| {{#if:{{{1|}}}|{{{1}}}|{{ROOTPAGENAME}}}} }}|Download]] and move the extracted <code>{{trim| {{#if:{{{1|}}}|{{{1}}}|{{ROOTPAGENAME}}}} }}</code> folder to your <code>extensions/</code> directory.<br/>Developers and code contributors should install the extension [[Special:MyLanguage/Download from Git|from Git]] instead, using:{{#tag:syntaxhighlight|cd extensions/
git clone{{#if:{{{git-submodule|}}}|<nowiki/> --recurse-submodules}} https:<nowiki/>//gerrit.wikimedia.org/r/mediawiki/extensions/{{urlencode:{{trim| {{#if:{{{1|}}}|{{{1}}}|{{ROOTPAGENAME}}}} }}}}|lang=bash|copy=1}}
|Download and place the file(s) in a directory called <code>{{trim| {{#if:{{{1|}}}|{{{1}}}|{{ROOTPAGENAME}}}} }}</code> in your <code>extensions/</code> folder.
}}
}}{{#if: {{{composer|}}} |
* Only when installing from Git, run [[Special:MyLanguage/Composer|Composer]] to install PHP dependencies, by issuing <code>composer install --no-dev</code> in the extension directory. <small>(See {{task|T173141}} for potential complications.)</small>{{#ifeq: {{NAMESPACENUMBER}} |102 |{{#ifeq: {{SUBPAGENAME}} |en | |[[Category:Extensions requiring Composer with git{{#translation:}}]] }} }}
}}
* Add the following code at the bottom of your {{ll|Manual:LocalSettings.php|LocalSettings.php}} file: {{#tag:syntaxhighlight|
{{{localsettingsearly|}}}
{{#if: {{{source|}}} | {{{source|}}} | {{#if: {{{registration|}}} | {{#if: {{{customizereg|}}} | {{{customizereg|}}} |wfLoadExtension( '{{trim| {{#if:{{{1|}}}|{{{1}}}|{{ROOTPAGENAME}}}} }}' );}} | {{#if: {{{oldreg|}}} | {{{oldreg|}}} | require_once "$IP/{{{basedir|extensions}}}/{{trim| {{#if:{{{1|}}}|{{{1}}}|{{ROOTPAGENAME}}}} }}/{{trim| {{#if:{{{1|}}}|{{{1}}}|{{ROOTPAGENAME}}}} }}.php";}}}} }}
{{{localsettings|}}}
|lang="php"
|copy=1
}}{{#if: {{{db-update|}}} |
* Run the '''[[Special:MyLanguage/Manual:Update.php|update script]]''' which will automatically create the necessary database tables that this extension needs.}} {{trim| {{{custom-steps|}}} }}
* {{Done|uselang={{pagelang}}}} – Navigate to [[Special:Version]] on your wiki to verify that the extension is successfully installed.{{#if: {{{registration|}}}|{{#ifeq:{{{registration|}}}|required||<nowiki/>
{{#ifexpr:{{{no-registration-version|1.24}}}<({{MW legacy lts branch number}}-0.04)||
{{#ifeq:{{NAMESPACE}}|Extension|[[Category:Extensions still supporting pre-registration versions]]}}
To users running MediaWiki {{{no-registration-version|1.24}}} or earlier:

The instructions above describe the new way of installing this extension using <code>wfLoadExtension()</code>.
If you need to install this extension on these earlier versions (MediaWiki {{{no-registration-version|1.24}}} and earlier), instead of {{#tag:syntaxhighlight|wfLoadExtension( '{{trim| {{#if:{{{1|}}}|{{{1}}}|{{ROOTPAGENAME}}}} }}' );|lang=php|inline=true}}, you need to use:

{{#tag:syntaxhighlight|
require_once "$IP/{{{basedir|extensions}}}/{{trim| {{#if:{{{1|}}}|{{{1}}}|{{ROOTPAGENAME}}}} }}/{{trim| {{#if:{{{1|}}}|{{{1}}}|{{ROOTPAGENAME}}}} }}.php";
|lang="php"
}}}}}}}}{{#if: {{{vagrant|}}} |<nowiki/>

'''Vagrant installation:'''
* If using {{ll|MediaWiki-Vagrant|Vagrant}}, install with <code>vagrant roles enable {{{vagrant}}} --provision</code>
}}{{#ifeq:{{NAMESPACE}}|Extension|{{#if:{{{registration|}}}||[[Category:Extensions not using extension registration{{#translation:}}]]}}}}<noinclude>
{{documentation|content=
{{lua|Module:Extension}}
== Usage ==

{{ExtensionInstall/doc}}

== Examples ==

Below a few examples of how to use this template:

=== Simple ===
<pre>
{{ExtensionInstall}}
</pre>
<blockquote>
{{ExtensionInstall|MyExtension}}
</blockquote>

=== Name ===
<pre>
{{ExtensionInstall|CategoryTree}}
</pre>
<blockquote>
{{ExtensionInstall|CategoryTree}}
</blockquote>

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

=== LocalSettings ===

<pre>
{{ExtensionInstall
|localsettings=
$wgUseAjax = true;
}}
</pre>
<blockquote>
{{ExtensionInstall|MyExtension
|localsettings=
$wgUseAjax = true;
}}
</blockquote>

==== LocalSettings early ====

<pre>
{{ExtensionInstall
|localsettingsearly=
$wgUseAjax = true; // This must be included before the extension is loaded
}}
</pre>
<blockquote>
{{ExtensionInstall|MyExtension
|localsettingsearly=
$wgUseAjax = true; // This must be included before the extension is loaded
}}
</blockquote>

=== DB Update ===
<pre>
{{ExtensionInstall
|db-update=Yes
}}
</pre>
<blockquote>
{{ExtensionInstall|MyExtension
|db-update=Yes
}}
</blockquote>

=== Composer ===
<pre>
{{ExtensionInstall
|composer=Yes
}}
</pre>
<blockquote>
{{ExtensionInstall|MyExtension
|composer=Yes
}}
</blockquote>

=== Custom steps ===
<pre>
{{ExtensionInstall
|custom-steps=
* Lorem ipsum dolor sit amet
* Foo bar baz quux [[sandbox]]
}}
</pre>
<blockquote>
{{ExtensionInstall|MyExtension
|custom-steps=
* Lorem ipsum dolor sit amet
* Foo bar baz quux [[sandbox]]
}}
</blockquote>

=== Support registration ===
<pre>
{{ExtensionInstall
|registration=1
}}
</pre>
<blockquote>
{{ExtensionInstall|MyExtension
|registration=1
}}
</blockquote>

=== Support registration with minimum version ===
<pre>
{{ExtensionInstall
|registration=1
|no-registration-version=1.39
}}
</pre>
<blockquote>
{{ExtensionInstall|MyExtension
|registration=1
|no-registration-version=1.39
}}
</blockquote>

This only works if the version specified is {{#expr:{{MW legacy lts branch number}}-.04}} or later, otherwise the template assumes nobody cares about ancient versions and falls back to [[#Require registration|#Require registration]].

=== Require registration ===
<pre>
{{ExtensionInstall
|registration=required
}}
</pre>
<blockquote>
{{ExtensionInstall|MyExtension
|registration=required
}}
</blockquote>

=== Everything ===
<pre>
{{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
}}
</pre>
<blockquote>
{{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
|no-registration-version=1.39
}}
</blockquote>
}}
[[Category:Installation guide templates{{#translation:}}]]
</noinclude>

Template:ExtensionInstall/en - Revision history

Plopilpy: 1 revision imported

mw>FuzzyBot: Updating to match new version of source page