Manual:拡張機能
拡張機能は、MediaWiki の外観や動作をカスタマイズできるようにします。
- 管理者であれば MediaWiki 上の拡張機能を管理することができ、インストール、あるいは削除を行うことができます。
- 開発者は、新しい拡張機能の作成や既存の拡張機能に貢献できます。
拡張機能の選択
追加の拡張機能
いくつかの拡張機能はbundled with MediaWikiとして標準搭載されています。
These extensions should generally be of high utility, perform efficiently, be stable, be well-written, and have no known major security issues. They should also be compatible with the latest versions of MediaWiki, and with each other (i.e. one extension shouldn't block the functions of another). A bundled extension may have a dependency on one or more other extensions, as long as those are also bundled.
Site admins get these automatically when installing or upgrading MediaWiki. When upgrading MediaWiki, any extension upgrades will be automatically applied as well. Site admins may choose to uninstall any of these, if they wish.
There are open, ongoing discussions about which extensions should be part of this group. You can suggest additional extensions to be bundled. Extensions will be bundled once the developers reach a consensus to do so.
An extension may be removed from bundling if its functionality is merged into MediaWiki core, it is replaced by an alternative, or in the unlikely event of any unsolvable major security vulnerabilities being discovered.
拡張機能の参照
カテゴリ:すべての拡張機能 を閲覧するか、カテゴリ:カテゴリごとの拡張機能 を使って利用可能な拡張機能の全体を確認できます。
インストールされた拡張機能の確認
MediaWiki のインスタンス上でどの拡張機能が有効になっているかは、Special:Version ページにアクセスし、インストール済み拡張機能の見出し(アンカーは #mw-version-ext)までスクロールすることで確認できます。
たとえば、これらの拡張機能はこのウィキにインストールされており、これらの拡張機能は英語版ウィキペディアで有効です。
人気の拡張機能
別の選択肢は、拡張機能がインストールされているウィキの数を示す WikiApiary の集計を確認することです。 これには、単なるダウンロードではなく実際のインストールを表すという利点があります (つまり、ウィキの API に問い合わせます)。しかし (2023年現在) 完全に最新というわけではありません。 また、非公開ウィキでのインストールを数えません。
拡張機能のインストール
- 詳しい手引きについては、Manual:拡張機能/インストールおよびアップグレードを参照
MediaWiki はインストールが終わった直後に既に拡張機能を受け入れる用意ができています。 拡張機能を追加するために以下のステップに従います:
- 始める前に
- いくつかの拡張機能はパッチのインストールが要求されます。それらの多くはunixコマンドの使用によるインストールのために設計された手引きを提供しています。 拡張機能ヘルプページにリスト表示されたこれらのコマンドを入力するためにシェルアクセス(SSH)の権限が要求されることもあります。
- 拡張機能をダウンロードする。
- Extension Distributorは、よく用いられている拡張機能を選び、ダウンロードする手助けをしてくれます。
- 通常、拡張機能はモジュール パッケージとして配布されます。 それらは一般的に
$IP/extensions/の独自の下位ディレクトリに入ります。 ウィキメディアの Git リポジトリに保存された拡張機能の一覧は git:mediawiki/extensions にあります。 拡張機能の中には、履歴管理をしていないものがあり、使用は推奨されません。 - 拡張機能のなかにはbundles、Composer、package repositoriesで利用可能なものもあります。
- インストール前に README ファイルを読むことをお勧めします。 これには通常、設定に関する重要な情報が含まれています。
- 拡張機能をインストール
LocalSettings.phpファイルの末尾に、以下を追加します:wfLoadExtension( 'ExtensionName' );
- この行はPHPインタプリタに拡張機能ファイルを読み込むことを強制し、その結果MediaWikiにアクセス可能にします。
- 拡張機能の中には、メンテナンススクリプトと衝突するものもあります。例えば
$_SERVERに直接アクセスする(非推奨)場合です。 この場合、メンテナンススクリプトが動作するように、条件文で包むことができます。 if ( !$wgCommandLineMode ) { wfLoadExtension ( 'ExtensionName' ); }
- 上記の条件文の中で加えられる特別な名前空間を必要とするすべての拡張機能に対して、メンテナンススクリプト importDump.php は失敗します。そのような拡張機能は、例えば Extension:Semantic MediaWiki や Extension:Page Forms です。
- 拡張機能用に必要な権限が設定されていることを確認してください!
- このインストール手順は、ほとんどの拡張機能にあてはまりますが、異なったインストール手順が必要なものもあります。 詳細は、拡張機能のドキュメントを確認して下さい。
LocalSettings.phpで設定の変数を変更したい場合は、通常は拡張機能のインクルードの後で行う必要があります。 そのようにしない場合、拡張機能内で定義されている既定値があなたの設定を上書きします。
拡張機能のアップグレード
拡張機能のなかには、複数のバージョンで動作するものもありますが、MediaWikiの更新ごとにアップデートしなければならないものもあります。 拡張機能を新しいバージョンにアップグレードするためには:
- 新しいバージョンの拡張機能をダウンロードします。
extensions/ExtensionNameディレクトリにある拡張機能のすべてのファイルを、新しいファイルに置き換えます。LocalSettings.phpにある拡張機能の設定は、削除しないでください- 拡張機能が MediaWiki データベースの変更を必要とする場合、メンテナンス スクリプトの update.php を実行する必要があるかもしれません。 ほとんどの拡張機能は、このスクリプトを実行する必要があるかどうかについて言及しています。 (スクリプト実行前にデータのバックアップを取ってください)。 もしコマンドラインにアクセスできない場合には、web updaterを使うこともできます。
拡張機能のアンインストール
アンインストールするには、拡張機能の名前が書かれた行を LocalSettings.php から削除してください。
wfLoadExtension( 'ExtensionName' );
- 拡張機能の設定に関係する行はすべて削除する必要があります。
拡張機能の開発
MediaWiki コアは、拡張機能がウィキの動作や外観を変更するための複数の方法を提供します。 これらの拡張ポイントにより、拡張機能は特別ページの表示や API モジュールの定義などの機能を追加できる柔軟性を持ちます。 始めるには、拡張機能の開発ガイドを参照してください。 新しい拡張機能を作成する前に、既存の拡張機能に貢献するか、保守されていない拡張機能を支援することを検討してください。
Users can also make a general request on Phabricator, and hope that your good idea is picked up by a developer. https://phabricator.wikimedia.org/tag/mediawiki-extension-requests/を見てください
関連項目
- カテゴリ:拡張機能
- Template:Extension
- Manual:拡張機能の開発
- Manual:拡張機能の翻訳 – 拡張機能の翻訳に関する情報。
- Special:ExtensionDistributor – ウィキメディアのバージョン管理で最もダウンロードされた 15 の拡張機能の一覧が含まれます
- extloc – MediaWiki の拡張機能がウィキメディアのどのウィキで展開されているか
- API:Siteinfo#Extensions
- Manual:ウィキ マークアップの拡張
- Manual:フック
- Manual:マジックワード
- Manual:外装