View source for Manual:Extensions/Installation and upgrade/ja

← Manual:Extensions/Installation and upgrade/ja

You do not have permission to edit this page, for the following reasons:

This page cannot be updated manually. This page is a translation of the page Manual:Extensions/Installation and upgrade and the translation can be updated using the translation tool.
Your IP address is in a range that has been blocked on all Wikimedia Foundation wikis. The block was made by ‪Jon Kolbert‬. The reason given is Open proxy/Webhost: Visit the FAQ if you are affected .
- Start of block: 16:26, 29 August 2021
- Expiry of block: 16:26, 29 August 2024
Your current IP address is 52.7.32.16. The blocked range is 52.7.0.0/16. Please include all above details in any queries you make. If you believe you were blocked by mistake, you can find additional information and instructions in the No open proxies global policy. Otherwise, to discuss the block please post a request for review on Meta-Wiki. You could also send an email to the stewards VRT queue at stewards@wikimedia.org including all above details.

You can view and copy the source of this page.

<languages/>
<span lang="en" dir="ltr" class="mw-content-ltr">[[Special:MyLanguage/Manual:Installation|Once installed]], MediaWiki is ready to accept [[Special:MyLanguage/Manual:Extensions|extensions]].</span>
<span lang="en" dir="ltr" class="mw-content-ltr">To add an extension follow these steps:</span>

<span id="Before_you_start"></span>
==始める前に==

* <span lang="en" dir="ltr" class="mw-content-ltr">Some extensions provide instructions designed for installation using Unix commands.</span> <span lang="en" dir="ltr" class="mw-content-ltr">You require shell access (SSH) to enter these commands listed on the extension help pages.</span>
* <span lang="en" dir="ltr" class="mw-content-ltr">This page assumes your site settings are in a file called [[Special:MyLanguage/Manual:LocalSettings.php|LocalSettings.php]], but if you ase a different file, for instance in a wiki farm, the instructions should be equally relevant.</span>

<span id="Download_an_extension"></span>
==拡張機能のダウンロード==

<div lang="en" dir="ltr" class="mw-content-ltr">
===Get the file package===
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
For each extension, read its documentation to find out about the appropriate download locations and methods.
</div>
<span lang="en" dir="ltr" class="mw-content-ltr">Common ways of downloading extensions include:</span>

# <span lang="en" dir="ltr" class="mw-content-ltr">[[Special:ExtensionDistributor|Extension Distributor]] helps you to select and download most of the popular extensions, although not all extension developers necessarily recommend it.</span>
# <span lang="en" dir="ltr" class="mw-content-ltr">A list of extensions stored in the Wikimedia {{ll|Gerrit|Git repository}} is located at [[phab:diffusion/MEXT/browse/master/|git:mediawiki/extensions]].</span>
# <span lang="en" dir="ltr" class="mw-content-ltr">Some extensions are also available through:</span>
## {{ll|Software bundles|2=<span lang="en" dir="ltr" class="mw-content-ltr">bundles</span>}}
## <span lang="en" dir="ltr" class="mw-content-ltr">{{ll|Composer}}, a dependency manager for PHP libraries. Many extensions can or should be installed using Composer.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Proceed to {{ll|Composer/For extensions}} for more information.</span>
## {{ll|Comparison of extensions in distributions|2=<span lang="en" dir="ltr" class="mw-content-ltr">package repositories</span>}}
# <span lang="en" dir="ltr" class="mw-content-ltr">Some extensions {{ll|Category:Extensions which host their code in-wiki|don't use version control}} and are not recommended.</span>

===Add the package to the <code>/extensions</code> folder===
<span lang="en" dir="ltr" class="mw-content-ltr">Extensions are usually distributed as modular packages.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">They generally go in their own subdirectory of <code>{{ll|Manual:$IP|$IP}}/extensions/</code>.</span>

<span lang="en" dir="ltr" class="mw-content-ltr">You can add the file folder manually or have it transferred automatically if you use something like Git or Composer.</span>

<span id="Install_an_extension"></span>
==拡張機能のインストール==
# <span lang="en" dir="ltr" class="mw-content-ltr">Always check the requirements and instructions that come with each extension.</span> <span lang="en" dir="ltr" class="mw-content-ltr">The following summary applies to most extensions, but many extensions require different and/or additional steps to be taken.</span>
# <span lang="en" dir="ltr" class="mw-content-ltr">Ensure that required permissions are set.</span>
# <span lang="en" dir="ltr" class="mw-content-ltr">At the end of the <code>{{ll|Manual:LocalSettings.php|LocalSettings.php}}</code> file, add:</span><!--
--><syntaxhighlight lang="php">
wfLoadExtension( 'ExtensionName' );
</syntaxhighlight><!--

--><span lang="en" dir="ltr" class="mw-content-ltr">This line forces the PHP interpreter to read the extension file, and thereby make it accessible to MediaWiki. For an earlier installation method using <code>require_once</code> and how to migrate, see the instructions below.</span>
# <span lang="en" dir="ltr" class="mw-content-ltr">Configure if required or wanted.</span> <span lang="en" dir="ltr" class="mw-content-ltr">{{ll|Manual:Configuration settings|Configuration settings}} should typically be added '''after''' including the extension.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Again, check the extension's instructions for details.</span>
# <span lang="en" dir="ltr" class="mw-content-ltr">You may be required to run a [[Special:MyLanguage/maintenance script|maintenance script]], for instance to add the necessary database tables.</span>
# <span lang="en" dir="ltr" class="mw-content-ltr">Done!</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
===Possible issues===
</div>
* <span lang="en" dir="ltr" class="mw-content-ltr">Some extensions can conflict with maintenance scripts, for example if they directly access $_SERVER (not recommended).</span> <span lang="en" dir="ltr" class="mw-content-ltr">In this case they can be wrapped in the conditional so maintenance scripts can still run.</span><!--
--><syntaxhighlight lang="php">
if ( !$wgCommandLineMode ) {
wfLoadExtension ( 'ExtensionName' );
}
</syntaxhighlight>
* <span lang="en" dir="ltr" class="mw-content-ltr">The maintenance script {{ll|Manual:ImportDump.php|importDump.php}} will fail for any extension which requires customised namespaces which is ''included'' inside the conditional above such as {{ll|Extension:Semantic MediaWiki}}, {{ll|Extension:Page Forms}}.</span>

=== Add multiple extensions to <code>wfLoadExtensions()</code> ===
<span lang="en" dir="ltr" class="mw-content-ltr">Especially if you have a large number of extensions, it may be useful to add them as an array to <code>wfLoadExtensions()</code> (with plural -s) instead of adding them to separate instances of <code>wfLoadExtension()</code> (singular).</span>
<span lang="en" dir="ltr" class="mw-content-ltr">For instance, to install Cite, ParserFunctions and SpamBlacklist, you could write:</span>

<pre>wfLoadExtensions( [ 'Cite', 'ParserFunctions', 'SpamBlacklist' ] );</pre>

<div lang="en" dir="ltr" class="mw-content-ltr">
This method comes with one limitation, which is that you cannot point to custom file locations, as explained in [[#Use custom locations|this section]].
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
==Upgrade an extension==
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Some extensions require to be updated whenever you update MediaWiki, while others work with multiple versions.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
To upgrade to a new version of an extension:
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
# Download the new version of the extension
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
# Replace all the extension files in the <code>extensions/&lt;ExtensionName></code> directory with the new files.
</div> <span lang="en" dir="ltr" class="mw-content-ltr">Do not remove the extension configuration present in LocalSettings.php</span>
<div lang="en" dir="ltr" class="mw-content-ltr">
# If the extension requires changes to the MediaWiki database, you will need to run the {{ll|Manual:update.php|update.php}} maintenance script.
</div> <span lang="en" dir="ltr" class="mw-content-ltr">Most extensions will mention if this script needs to be run or not.</span> <span lang="en" dir="ltr" class="mw-content-ltr">(Perform backup of your data before executing the script).</span> <span lang="en" dir="ltr" class="mw-content-ltr">If you don't have command line access, you can also use the [[Special:MyLanguage/Manual:Upgrading#Web_updater|web updater]].</span>
# <span lang="en" dir="ltr" class="mw-content-ltr">Documentation for an extension usually tells you what else you need to do.</span>

<span id="Uninstall"></span>
== アンインストール ==

<div lang="en" dir="ltr" class="mw-content-ltr">
# To uninstall the extension, remove the relevant lines from LocalSettings.php (<code>wfLoadExtension</code> with the extension's name as well as any possible lines for associated configuration settings).
</div>
# <span lang="en" dir="ltr" class="mw-content-ltr">Optionally, delete the file package from the /extensions folder.</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
==Advanced==
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
=== Use custom locations ===
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
This must be done before you load any extensions or skins from non-standard directory locations:
</div>

: <span lang="en" dir="ltr" class="mw-content-ltr">If you keep your extensions in a location different from {{phpi|$IP/extensions}}, you need to override {{wg|ExtensionDirectory}}, ''or use the second parameter of <code>wfLoadExtension()</code>'', to specify the directory in which to find the extension.</span>
:: <span lang="en" dir="ltr" class="mw-content-ltr">If one or more of your extensions are stored in additional locations, use the second parameter of <code>wfLoadExtension()</code> to specify the location of the <code>.json</code> file for ''each'' of those extensions.</span>
:: {{note|1=<span lang="en" dir="ltr" class="mw-content-ltr"><code>wfLoadExtensions()</code> '''(plural)''' always uses {{wg|ExtensionDirectory}} and cannot be overridden.</span>}}

:<syntaxhighlight lang="php">
$wgExtensionDirectory = '/some/path';
wfLoadExtension( 'FooBar' ); // Looks in $wgExtensionDirectory for /some/path/FooBar/extension.json
wfLoadExtension( 'Hello', '/some/other/path/HelloV2/Hello.json' ); // Looks for /some/other/path/HelloV2/Hello.json
</syntaxhighlight>

: <span lang="en" dir="ltr" class="mw-content-ltr">If your skins are not in {{phpi|$IP/skins}}, you need to override the poorly named {{wg|StyleDirectory}}, ''or use the second parameter of <code>wfLoadSkin()</code>'', to specify the directory in which to find the skin.</span>
:: <span lang="en" dir="ltr" class="mw-content-ltr">If one or more of your skins are stored in additional locations, use the second parameter of <code>wfLoadSkin()</code> to specify the location of the <code>.json</code> file for ''each'' of those skins.</span>
:: {{note|1=<span lang="en" dir="ltr" class="mw-content-ltr"><code>wfLoadSkins()</code> '''(plural)''' always uses {{wg|StyleDirectory}} and cannot be overridden.</span>}}

:<syntaxhighlight lang="php">
$wgStyleDirectory = '/my/skins';
wfLoadSkins( [ 'BarBaz', 'BazBar' ] ); // Looks in $wgStyleDirectory for both /my/skins/BarBaz/skin.json and /my/skins/BazBar/skin.json
wfLoadSkin( 'BamBam', '/yet/another/path/BamBam/skin.json' ); // Looks for /yet/another/path/BamBam/skin.json
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
== Migrate from require_once==
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Before MediaWiki 1.25, configuration for extensions and skins was done in a PHP file using the extension's or skin's name, for example <code>MyExtension.php</code> or <code>MySkin.php</code>. To install an extension with LocalSettings.php, you would use <code>require_once</code> to call this PHP file:
</div>

<syntaxhighlight lang="php">
require_once "$IP/extensions/Hello/Hello.php";
require_once "$IP/extensions/FooBar/FooBar.php";
$wgFooBarEnable = true;
require_once "$IP/skins/Baz/Baz.php";
require_once "/tmp/extension/some/where/else/BarFoo/BarFoo.php";
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
If the extensions are recent enough to support the current registration system, you would convert this to:
</div>

<syntaxhighlight lang="php">
wfLoadExtensions( [ 'Hello', 'FooBar' ] );
$wgFooBarEnable = true;
wfLoadSkin( 'Baz' );
wfLoadExtension( 'BarFoo', '/tmp/extension/some/where/else/BarFoo/extension.json' );
</syntaxhighlight>

{{Extensions}}

[[Category:MediaWiki administration]]
[[Category:Extensions]]
[[Category:Customization techniques{{#translation:}}|{{PAGENAME}}]]

Templates used on this page:

Template:Dir (view source) (semi-protected)
Template:Extensions (edit)
Template:Extensions/ja (edit)
Template:Flatlist (view source) (semi-protected)
Template:Flatlist/styles.css (view source) (semi-protected)
Template:Inline-code (view source) (semi-protected)
Template:Ll (view source) (protected)
Template:Localized link (view source) (protected)
Template:Nmbox (view source) (protected)
Template:Nmbox/styles.css (view source) (protected)
Template:Note (view source) (protected)
Template:Note/ja (edit)
Template:Note/styles.css (view source) (protected)
Template:Pagelang (view source) (protected)
Template:Phpi (view source) (semi-protected)
Template:TNTN (view source) (semi-protected)
Template:Translatable (view source) (protected)
Template:Translatable/ja (edit)
Template:Translatable template name (view source) (semi-protected)
Template:Wg (edit)
Template:Yesno (view source) (semi-protected)
Module:String (view source) (semi-protected)
Module:Template translation (view source) (protected)
Translations:Composer/Page display title/ja (edit)
Translations:Extension:Page Forms/Page display title/ja (edit)
Translations:Extension:Semantic MediaWiki/Page display title/ja (edit)
Translations:Extension default namespaces/Page display title/ja (edit)
Translations:Manual:Tag extensions/Page display title/ja (edit)

Return to Manual:Extensions/Installation and upgrade/ja.

Retrieved from "https://www.mediawiki.org/wiki/Manual:Extensions/Installation_and_upgrade/ja"