Manual:拡張機能の開発

This page is a translated version of the page Manual:Developing extensions and the translation is 59% complete.

拡張機能:

もし自作の拡張機能をウィキメディアのサイトで展開したいなら展開のための拡張機能の作成をお読みください

各拡張機能は、3つの部分からなります:

セットアップ
実行
地域化

最小限の拡張機能は、以下の構造で構成されます:

MyExtension/extension.json: セットアップの指示を格納するファイルです。ファイル名は必ずextension.jsonにします。（MediaWiki 1.25以前では、セットアップの指示は拡張機能から名前を取った MyExtension/MyExtension.php ファイル内に記述されていました。依然として拡張機能の多くには、このPHPファイルに下位互換性のあるシム (shim) があります。)
MyExtension/includes/ (or MyExtension/src/): 拡張機能のための PHP 実行コードを格納します。
MyExtension/resources/ (or MyExtension/modules/): 拡張機能に必要となるJavaScript、CSSやLESSのようなクライアント側に必要なリソースを保存します。
MyExtension/i18n/*.json: これは拡張機能の地域化に関わる情報を格納したページです。

拡張機能の開発時には上記の MyExtension の代わりにご利用の拡張機能名を記入します。ディレクトリ名と PHP ファイル名はアッパーキャメルケースにします。これは標準的なファイル命名規約に準じています。^[1] (ご利用の拡張機能の処理の導入としてはBoilerPlate extensionが適しています。)

開発段階ではシステムメッセージその他の変更が表示されないよう、$wgMainCacheType = CACHE_NONEと$wgCacheDirectory = falseを設定してキャッシュを回避することができます。

セットアップ

セットアップ部分を書く目的は、拡張機能のインストールをできるだけ簡単にすることです。利用者が以下の行を LocalSettings.php に追加するだけで済むようにすることが目標です:

wfLoadExtension( 'MyExtension' );

ユーザーが拡張機能の設定を変更できるようにするには設定パラメータの設定と説明文書作成が必要で、ユーザ設定はたとえば下記の例のようになります。

wfLoadExtension( 'MyExtension' );
$wgMyExtensionConfigThis = 1;
$wgMyExtensionConfigThat = false;

ここまで単純化するには、セットアップファイルにいくつかの修正を行う必要があります (詳細は以下の節で説明します)。

拡張機能が使用するメディアハンドラ、パーサ関数、特別ページ、カスタムXMLタグ、変数をすべて登録。
拡張機能用に定義した設定変数を定義と/もしくは検証。
拡張機能のオートロード用に使用するクラスの準備。
セットアップ部分で、至急実行すべき部分と、MediaWikiコアの初期化と設定の終了後まで待つべき部分を定義する。
必要なその他のフックの定義
必要なデータベーステーブルの作成もしくは検証。
拡張機能の地域化のための設定。

いい実践としては、拡張機能のインストールと設定方法に関する基本情報が記載された README ファイルを追加することが推奨されています。プレーンテキストまたは Phabricator のマークアップ構文を使用できます。例えば、Extension:Page Forms について Phabricator Diffusion ページを参照してください。 Markdown が使用される場合は、ファイル拡張子に .md を追加してください。例えば、Phabricator Diffusion 上の Parsoid 向けの README.md ファイルを参照してください。

MediaWikiに拡張機能を登録する

MediaWikiのSpecial:Versionページには、インストールされているすべての拡張機能が列挙されています。たとえばこのウィキにインストールされた拡張機能はすべて、Special:Versionで参照できます。

MediaWiki バージョン:

≧ 1.25

これを実現するには、拡張機能の詳細を extension.json に記します。内容は以下のようになります。

{
	"name": "Example",
	"author": "John Doe",
	"url": "https://www.mediawiki.org/wiki/Extension:Example",
	"description": "This extension is an example and performs no discernible function",
	"version": "1.5",
	"license-name": "GPL-2.0-or-later",
	"type": "validextensionclass",
	"manifest_version": 1
}

項目の多くは設定任意ですが、すべて指定しておく方がいいでしょう。 manifest_version は extension.json のファイルが書き込まれるスキーマのバージョンを示しています。設定可能なバージョン値は1と2です。この機能に関する文書はこちらを参照してください。以前のMediaWikiバージョンをサポートする必要がない限り、最新バージョンを選択してください。

上記の登録に加え、MediaWikiにあなたがつくった機能を「フック」しておくことも必要です。上記の内容は Special:Version page だけに関する設定です。これを行う方法はあなたがつくった拡張機能の種類に依存します。詳しくは、拡張機能の種別ごとの説明文書を参照してください。

拡張機能:

拡張機能を利用者が構成可能にする

利用者が拡張機能を構成できるようにするには、1 つ以上の構成変数を用意する必要があります。これらの変数には、固有の名前を付けるといいでしょう。また、MediaWiki の命名規約に従わなければなりません (例: グローバル変数は $wg で始まる)。

例えば、拡張機能の名前が「MyExtension」の場合、すべての設定変数を $wgMyExtension で始めるようにすることを検討するかもしれません。重要なのは、MediaWikiのコアがそのような変数名を使用していないことを確認することであり、公開されている拡張機能の中でもそのような変数名を使用していないかを確認することです。重複する変数名を選択したために、あなたの拡張機能と他の拡張機能のどちらかを選択しなければならなくなったとしたら、利用者は快く思わないでしょう。

また、インストールの注記には、構成変数の詳細を記載することをお勧めします。

ここでは、開始時に使用できるボイラープレートの例を紹介します:

{
	"name": "BoilerPlate",
	"version": "0.0.0",
	"author": [
		"Your Name"
	],
	"url": "https://www.mediawiki.org/wiki/Extension:BoilerPlate",
	"descriptionmsg": "boilerplate-desc",
	"license-name": "GPL-2.0-or-later",
	"type": "other",
	"AutoloadClasses": {
		"BoilerPlateHooks": "includes/BoilerPlateHooks.php",
		"SpecialHelloWorld": "includes/SpecialHelloWorld.php"
	},
	"config": {
		"BoilerPlateEnableFoo": {
			"value": true,
			"description": "Enables the foo functionality"
		}
	},
	"callback": "BoilerPlateHooks::onExtensionLoad",
	"ExtensionMessagesFiles": {
		"BoilerPlateAlias": "BoilerPlate.i18n.alias.php"
	},
	"Hooks": {
		"NameOfHook": "BoilerPlateHooks::onNameOfHook"
	},
	"MessagesDirs": {
		"BoilerPlate": [
			"i18n"
		]
	},
	"ResourceModules": {
		"ext.boilerPlate.foo": {
			"scripts": [
				"resources/ext.boilerPlate.js",
				"resources/ext.boilerPlate.foo.js"
			],
			"styles": [
				"resources/ext.boilerPlate.foo.css"
			]
		}
	},
	"ResourceFileModulePaths": {
		"localBasePath": "",
		"remoteExtPath": "BoilerPlate"
	},
	"SpecialPages": {
		"HelloWorld": "SpecialHelloWorld"
	},
	"manifest_version": 2
}

wfLoadExtension( 'BoilerPlate' ); を呼び出した後、グローバル変数 $wgBoilerPlateEnableFoo は存在しないことに注意してください。例えば LocalSettings.php で変数を設定した場合、extension.json に記載された既定値は使用されません。

カスタム拡張機能内でグローバル変数を使用する方法の詳細については、Manual:Configuration for developers を参照してください。

クラスのオートローディングの準備

拡張機能を実装するためにクラスを使用することを選択した場合、MediaWiki は PHP がクラスの定義が格納されているソースファイルを見つけるのを支援する簡素化された仕組みを提供します。多くの場合、__autoload($classname)の手順を自作しなくて済みます。

MediaWikiのオートローディング機構を使用するには、AutoloadClasses フィールドにエントリを追加します。各エントリのキーはクラス名で、値はクラスの定義が格納されているファイルです。シンプルな 1 クラスの拡張機能では、クラス名は通常拡張機能の名前と同じにされるため、オートローディングの節は以下のようになる場合があります (拡張機能名は MyExtension):

{
	"AutoloadClasses": {
		"MyExtension": "includes/MyExtension.php"
	}
}

ファイル名は extension.json ファイルが格納されているディレクトリに対して相対的です。

より複雑な拡張機能では、名前空間を考慮する必要があります。詳細は Manual:Extension.json/Schema#AutoloadNamespaces を参照してください。

追加的なフックの定義

Manual:フックを参照してください。

データベーステーブルの追加

Make sure the extension doesn't modify the core database tables. Instead, extension should create new tables with foreign keys to the relevant MW tables.

警告:

If your extension is used on any production WMF-hosted wiki please follow the Schema change guide.

If your extension needs to add its own database tables, use the LoadExtensionSchemaUpdates hook. 使用法のより詳細な情報はマニュアルページを参照してください。

地域化のセットアップ

Add logs

On MediaWiki, all actions by users on wiki are tracked for transparency and collaboration. これをどのようにしたらよいかはManual:Special:Log 用に記録を登録するを見てください。

Handling dependencies

Assume that an extension requires the presence of another extension, for example because functionalities or database tables are to be used and error messages are to be avoided in case of non-existence.

For example the extension CountingMarker requires the presence of the extension HitCounters for certain functions.

One way to specify this would be by using the requires key in extension.json.

Another option is using ExtensionRegistry (available since MW 1.25):

	if ( ExtensionRegistry::getInstance()->isLoaded( 'HitCounters', '>=1.1' ) {
		/* do some extra stuff, if extension HitCounters is present in version 1.1 and above */
	}

Currently (as of February 2024, MediaWiki 1.41.0) the name of the extension-to-be-checked needs to exactly match the name in their extension.json.^[2]^[3]

Example: if you want to check the load status of extension "OpenIDConnect", you have to use it with a space

	if ( ExtensionRegistry::getInstance()->isLoaded( 'OpenID Connect' ) {
    ...
	}

地域化

Localisation – discusses the MediaWiki localisation engine, in particular, there is a list of features that can be localized and some review of the MediaWiki source code classes involved in localization.
Creating new messages
Localization checks – discusses common problems with localized messages

While developing, you may want to disable both cache by setting $wgMainCacheType = CACHE_NONE and $wgCacheDirectory = false, otherwise your system message changes may not show up.

If you want your extension to be used on wikis that have a multi-lingual readership, you will need to add localisation support to your extension.

Store messages in <language-key>.json

Store message definitions in a localisation JSON file, one for each language key your extension is translated in. The messages are saved with a message key and the message itself using standard JSON format. Each message id should be lowercase and may not contain spaces. Each key should begin with the lowercased extension name. An example you can find in the MobileFrontend extension. Here is an example of a minimal JSON file (in this case en.json):

en.json

{
	"myextension-desc": "Adds the MyExtension great functionality.",
	"myextension-action-message": "This is a test message"
}

Store message documentation in qqq.json

The documentation for message keys can be stored in the JSON file for the pseudo language with code qqq. A documentation of the example above can be:

qqq.json:

{
	"myextension-desc": "The description of MyExtension used in Extension credits.",
	"myextension-action-message": "Adds 'message' after 'action' triggered by user."
}

地域化ファイルの読み込み

In your extension.json, define the location of your messages files (e.g. in directory i18n/):

{
	"MessagesDirs": {
		"MyExtension": [
			"i18n"
		]
	}
}

PHP での wfMessage の使用

In your setup and implementation code, replace each literal use of the message with a call to wfMessage( $msgID, $param1, $param2, ... ). In classes that implement IContextSource (as well as some others such as subclasses of SpecialPage), you can use $this->msg( $msgID, $param1, $param2, ... ) instead. 例:

wfMessage( 'myextension-addition', '1', '2', '3' )->parse()

JavaScript での mw.message の使用

It's possible to use i18n functions in JavaScript too. 詳細は Manual:メッセージAPI を参照してください。

拡張機能の種類

拡張機能:

拡張機能は、その機能を実現するために使われているプログラミング手法によって分類できます。複雑な拡張機能の多くは複数の手法を用いることになるでしょう。

下位クラス: MediaWikiは、MediaWikiが提供する基本クラスの下位クラスとして実装されるある特定種類の拡張機能を想定しています。
- 特別ページ – Subclasses of the SpecialPage class are used to build pages whose content is dynamically generated using a combination of the current system state, user input parameters, and database queries. Both reports and data entry forms can be generated. They are used for both reporting and administration purposes.
- 外装 – Skins change the look and feel of MediaWiki by altering the code that outputs pages by subclassing the MediaWiki class SkinTemplate .
フック – A technique for injecting custom PHP code at key points within MediaWiki processing. They are widely used by MediaWiki's parser, its localization engine, its extension management system, and its page maintenance system.
- タグと関数の関連付け – XML style tags that are associated with a php function that outputs HTML code. You do not need to limit yourself to formatting the text inside the tags. You don't even need to display it. Many tag extensions use the text as parameters that guide the generation of HTML that embeds Google objects, data entry forms, RSS feeds, excerpts from selected wiki articles.
マジックワード – A technique for mapping a variety of wiki text string to a single id that is associated with a function. Both variables and parser functions use this technique. All text mapped to that id will be replaced with the return value of the function. The mapping between the text strings and the id is stored in the array $magicWords. The interpretation of the id is a somewhat complex process – see Manual:マジックワード for more information.
- 変数 – Variables are something of a misnomer. They are bits of wikitext that look like templates but have no parameters and have been assigned hard-coded values. Standard wiki markup such as {{PAGENAME}} or {{SITENAME}} are examples of variables. They get their name from the source of their value: a php variable or something that could be assigned to a variable, e.g. a string, a number, an expression, or a function return value.
- パーサー関数 – {{functionname: argument 1 | argument 2 | argument 3...}}. Similar to tag extensions, parser functions process arguments and returns a value. Unlike tag extensions, the result of parser functions is wikitext.
API モジュール – You can add custom modules to MediaWiki's action API, that can be invoked by JavaScript, bots or third-party clients.
Page content models – If you need to store data in formats other than wikitext, JSON, etc. then you can create a new ContentHandler .

異なるコアバージョンのサポート

There are two widespread conventions for supporting older versions of MediaWiki core:

Master: the master branch of the extension is compatible with as many old versions of core as possible. This results in a maintenance burden (backwards-compatibility hacks need to be kept around for a long time, and changes to the extension need to be tested with several versions of MediaWiki), but sites running old MediaWiki versions benefit from functionality recently added to the extension.
Release branches: release branches of the extension are compatible with matching branches of core, e.g. sites using MediaWiki 1.43 need to use the REL1_43 branch of the extension. (For extensions hosted on Gerrit, these branches are automatically created when new versions of MediaWiki are released.) This results in cleaner code and faster development but users on old core versions do not benefit from bugfixes and new features unless they are backported manually.

Extension maintainers should declare with the compatibility policy parameter of the {{Extension }} template which convention they follow.

ライセンス

MediaWiki はオープンソースプロジェクトであり、オープンソースイニシアティブ (OSI) 承認済みライセンスの下で任意の MediaWiki extensions を GPL-2.0-or-later (ウィキメディアの標準ソフトウェアライセンス) と互換性のあるものにすることをお勧めします。

Gerrit のプロジェクトには、以下の互換ライセンスのいずれかを採用することをお勧めします:

互換性のあるライセンスを持つ拡張機能の場合、拡張機能の MediaWiki ソースリポジトリへの開発者アクセスを申請できます。コード内で「license-name」でライセンスを指定するには、短い名前を提供するために、spdx.orgの識別子一覧に準拠するキー (例:「GPL-2.0-or-later」「MIT」) を使用する必要があります。

Publishing

To autocategorize and standardize the documentation of your existing extension, please see Template:Extension . To add your new extension to this Wiki:

A developer sharing their code in the MediaWiki code repository should expect:

フィードバック / 批評 / コードレビュー: Review and comments by other developers on things like framework use, security, efficiency and usability.

Developer tweaking: Other developers modifying your submission to improve or clean-up your code to meet new framework classes and methods, coding conventions and translations.

Improved access for wiki sysadmins: If you do decide to put your code on the wiki, another developer may decide to move it to the MediaWiki code repository for easier maintenance. You may then create a 開発者アカウント to continue maintaining it.

他の開発者による将来のバージョン: New branches of your code being created automatically as new versions of MediaWiki are released. You should backport to these branches if you want to support older versions.; Incorporation of your code into other extensions with duplicate or similar purposes — incorporating the best features from each extension.

帰属: Credit for your work being preserved in future versions — including any merged extensions.; Similarly, you should credit the developers of any extensions whose code you borrow from — especially when performing a merger.

Any developer who is uncomfortable with any of these actions occurring should not host in the code repository. You are still encouraged to create a summary page for your extension on the wiki to let people know about the extension, and where to download it.

Deploying and registering

If you intend to have your extension deployed on Wikimedia sites (including possibly Wikipedia), additional scrutiny is warranted in terms of performance and security. 展開のための拡張機能の作成を参照してください。

If your extension adds namespaces, you may wish to register its default namespaces; likewise, if it adds database tables or fields, you may want to register those at データベースフィールドの接頭辞 .

Please be aware that review and deployment of new extensions on Wikimedia sites can be extremely slow, and in some cases has taken more than two years.^[4]

ヘルプの説明文書

You should provide public domain help documentation for features provided by your extension. The convention is for extensions to have their user-focused help pages under a pseudo-namespace of Help:Extension:<ExtensionName>, with whatever subpages are required (the top level page will be automatically linked from the extension infobox if it exists). Help:CirrusSearch is a example of good documentation. You should give users a link to the documentation via the addHelpLink() function.

Releasing updates

There are a number of common approaches to releasing updates to extensions. These are generally defined according to the compatibility policy of the extension (master, rel, or ltsrel):

master - Releases may be tagged with version numbers on the master branch, and documentation provided on the extension's homepage describing which extension versions are compatible with which core versions. Release branches will still be created automatically, and you may wish to delete these if they are not intended to be used.
rel and ltsrel - Release by backporting changes to the REL1_* branches (either all changes, or only critical ones). Version numbers are generally not needed unless the extension is a dependency of another (the version number can then be provided in the other extension's configuration to ensure that incompatible combinations aren't installed). Many extensions will stay at the same version number for years.

Providing support / collaboration

Extension developers should open an account on Wikimedia's Phabricator , and request a new project for the extension. This provides a public venue where users can submit issues and suggestions, and you can collaborate with users and other developers to triage bugs and plan features of your extension.

参考資料

[1] rchive:wikitech-l/2011-August/054839.html

[2] ttps://www.mediawiki.org/wiki/Topic:Xyjw7nhfzaas5r5z

[3] ttps://phabricator.wikimedia.org/T356596

[4] ricator:T148848

[1]

[2]

[3]

[4]

Manual:拡張機能の開発

セットアップ

MediaWikiに拡張機能を登録する

拡張機能を利用者が構成可能にする

クラスのオートローディングの準備

追加的なフックの定義

データベーステーブルの追加

地域化のセットアップ

Add logs

Handling dependencies

地域化

Store messages in <language-key>.json

Store message documentation in qqq.json

地域化ファイルの読み込み

PHP での wfMessage の使用

JavaScript での mw.message の使用

拡張機能の種類

異なるコアバージョンのサポート

ライセンス

Publishing

Deploying and registering

ヘルプの説明文書

Releasing updates

Providing support / collaboration

関連項目

Learn by example

参考資料

セットアップ

MediaWikiに拡張機能を登録する

拡張機能を利用者が構成可能にする

クラスのオートローディングの準備

追加的なフックの定義

データベース テーブルの追加

地域化のセットアップ

Add logs

Handling dependencies

地域化

Store messages in <language-key>.json

Store message documentation in qqq.json

地域化ファイルの読み込み

PHP での wfMessage の使用

JavaScript での mw.message の使用

拡張機能の種類

異なるコアバージョンのサポート

ライセンス

Publishing

Deploying and registering

ヘルプの説明文書

Releasing updates

Providing support / collaboration

関連項目

Learn by example

参考資料

データベーステーブルの追加