Manual:拡張機能

拡張機能:Manual:Extensions

開発Manual:Developing extensions

タグ拡張機能Manual:Tag extensions

パーサー関数Manual:Parser functions

フックManual:Hooks

特別ページManual:Special pages

外装Manual:Skins

マジックワードManual:Magic words

APIAPI:Extensions

拡張機能とは 拡張機能とは、MediaWiki の外観や動作をカスタマイズさせるものです。 ウィキの利用者は、既存の拡張機能を閲覧したり、新たな拡張機能を要求することができます。 管理者であれば MediaWiki 上の拡張機能を管理することができ、インストール、あるいは削除を行うことができます。 開発者は、新しい拡張機能の作成や改善・改良ができます。

拡張機能をキーワードで検索:

拡張機能は以下のように使われます:

• 記事を書くのに使用されるウィキマークアップを拡張します - 例は カテゴリ:パーサー関数の拡張機能Category:Parser function extensions と カテゴリ:パーサーの拡張機能Category:Parser extensions を参照してください。
• 新しい報告と運営上の機能を追加します - 例はCategory:Special page extensionsをご覧下さい。
• MediaWiki の見た目を変更します - 例は Special:AllPages/Skin: および カテゴリ:ユーザーインターフェイスの拡張機能Category:User interface extensions を参照してください。
• カスタム認証メカニズムを使用してセキュリティを強化します - 例は Category:Authentication and Authorization ExtensionsCategory:Authentication and Authorization Extensions を参照してください。

拡張機能には、MediaWikiの開発者によってメンテナンスされているものもありますが、サードパーティーの開発者によって書かれたものもあります。 その結果、拡張機能の多くがバグを有し、相互に互換性があることを保証されているわけではありません。 一部のものはメンテナンスがされていません。したがって、すべての拡張機能が、MediaWikiのすべてのバージョンで動作するわけではありません。 どの拡張機能であっても、特に安全ではないというタグが付けられたものについては、自己責任で使用して下さい。 もし、MediaWiki本体のコードや、データベースのエントリにパッチをあてなければならない拡張機能を使う場合には、あなたのWikiが回復しない損害を受けるリスクを避けるためにも、データベースやMediaWikiのコードのバックアップをとることを忘れないでください。

拡張機能の参照

カテゴリ:Extensions by categoryCategory:Extensions by category では、これまで書かれたあらゆる種類の拡張機能を閲覧することができます。 これらの拡張機能をインストールしたり、独自に拡張機能を作ったりするための情報については、下記をご覧下さい。

インストールされた拡張機能の確認

MediaWikiに拡張機能をインストールできるのは、サーバのファイルシステム（データベースを含む場合も多い）にアクセスできる管理者に限られますが、誰でも Special:Version ページにアクセスすることで、MediaWikiのインスタンスでどの拡張機能がアクティブになっているかを確認することができます。 たとえば、ここにあげられている拡張機能は、英語版ウィキペディアでアクティブになっているものです。

拡張機能のインストール

MediaWiki はインストールが終わった直後に既に拡張機能を受け入れる用意ができています。 拡張機能を追加するために以下のステップに従います:

1. 始める前に

   いくつかの拡張機能はパッチのインストールが要求されます。それらの多くはunixコマンドの使用によるインストールのために設計された手引きを提供しています。 拡張機能ヘルプページにリスト表示されたこれらのコマンドを入力するためにシェルアクセス(SSH)の権限が要求されることもあります。

2. 拡張機能をダウンロードする。

   Extension Distributorは、よく用いられている拡張機能を選び、ダウンロードする手助けをしてくれます。

   通常、拡張機能はモジュール パッケージとして配布されます。 それらは一般的に $IPManual:$IP/extensions/ の独自のサブディレクトリに入ります。 ウィキメディアの Git リポジトリに保存された拡張機能の一覧は git:mediawiki/extensions にあります。 拡張機能の中には、履歴管理をしていないものがあり、使用は推奨されません。

   拡張機能のなかにはbundles、composercomposer、package repositoriesで利用可能なものもあります。

3. 拡張機能をインストールする。.

   一般的に、LocalSettings.phpManual:LocalSettings.php ファイルの終わりに、(PHPのコードの終わりの区切り文字、"?>"の上に)、次の行を追加します:

   // 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>' );
   

   この行はPHPインタプリタに拡張機能ファイルを読み込むことを強制し、その結果MediaWikiにアクセス可能にします。

   拡張機能の中には、たとえば$_SERVERに直接アクセスするような（推奨されていません）、メンテナンススクリプトと衝突するものもあります。

   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!

このインストール手順は、ほとんどの拡張機能にあてはまりますが、異なったインストール手順が必要なものもあります。 詳細は、拡張機能のドキュメントを確認して下さい。

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.

警告:

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!

拡張機能のアップグレード

拡張機能のなかには、複数のバージョンで動作するものもありますが、MediaWikiをアップデートするごとにアップデートしなければならないものもあります。 拡張機能を新しいバージョンにアップグレードするためには：

1. 新しいバージョンの拡張機能をダウンロードします。
2. extension/ExtensionName ディレクトリにある拡張機能のすべてのファイルを、新しいファイルに置き換えます。 LocalSettings.phpにある拡張機能の設定は、削除しないで下さい。
3. 拡張機能によっては、メンテナンススクリプトのUpdate.phpを実行しなければならないかもしれません。 ほとんどの拡張機能は、このスクリプトを実行する必要があるかどうかについて言及しています。 （update.phpを実行する必要がない場合に実行したとしても、何も損害はありませんので、もしよくわからない場合には実行してみましょう。） もしコマンドラインにアクセスできない場合には、web updaterを使うこともできます。
4. すべきことは以上です。 多くの場合、LocalSettings.phpに書かれた拡張機能の設定は、新しいバージョンの拡張機能でも有効でしょう。

この説明は、拡張機能の99％にあてはまります。 もし、あなたがアップグレードしようとしている特殊な拡張機能が、上と異なる説明をしていたならば、その拡張機能の説明に従うべきだろうと思います。

拡張機能のアンインストール

拡張機能を追加するには、LocalSettings.phpに以下のような行を追加します。

// 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. この行を削除すれば、拡張機能はアンインストールされます。 もし望むならば、"extensions/"フォルダ内にあるその拡張機能のファイルを削除することができます（もしその拡張機能を将来的に使いたくないならば、削除してしまいましょう）。
2. 恐らく、LocalSettings.php内には、削除しようと思っている拡張機能が動作するのに必要なことが書かれた他の行もあるでしょう。 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.

拡張機能の開発

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

関連項目

• カテゴリ:拡張機能Category:Extensions
  • カテゴリ:新しいメンテナーを必要としている拡張機能Category:Extensions in need of a new maintainer
• テンプレート:拡張機能Template:Extension
• Manual:拡張機能の開発Manual:Developing extensions
• Manual:パーサー関数Manual:Parser functions
• Manual:Special pagesManual:Special pages
• Manual:タグ拡張機能Manual:Tag extensions
• Project:Extension requests
• Manual:拡張機能の翻訳Manual:Translating extensions - Information about translating extensions.