Jump to navigation Jump to search
This page is a translated version of the page Manual:Developing extensions and the translation is 42% complete.

Other languages:
Bahasa Indonesia • ‎Deutsch • ‎English • ‎Latina • ‎Nederlands • ‎español • ‎français • ‎italiano • ‎polski • ‎português • ‎português do Brasil • ‎Ελληνικά • ‎български • ‎русский • ‎العربية • ‎سنڌي • ‎हिन्दी • ‎中文 • ‎日本語 • ‎한국어
OOjs UI icon puzzle-ltr.svg 拡張機能: 開発 タグ拡張機能 パーサー関数 フック 特別ページ 外装 マジックワード API Content models
MediaWiki 拡張機能


  1. セットアップ
  2. 実行
  3. 地域化


セットアップの指示を格納するファイルです。 ファイル名は必ずextension.jsonにします。 (MediaWiki 1.25以前では、セットアップの指示は拡張機能から名前を取った MyExtension/MyExtension.php ファイル内に記述されていました。 依然として拡張機能の多くには、このPHPファイルに下位互換性のあるシムがあります。)
これは、拡張機能のための実装コードを格納したファイルです。 ファイル名を MyExtension.php のようにする命名規約がありますが、必須ではありません。 ご利用の拡張機能が複雑で複数のPHPファイルから構成される場合は、この命名規約に従って実装コードを名付けMyExtension/includesという下位ディレクトリに置く必要があります (Example拡張機能はこの規約から除外されています) 。 一例として、SemanticMediaWiki 拡張機能を参照してください。

拡張機能の開発時には上記のMyExtensionの代わりにご利用の拡張機能名を記入します。 ディレクトリ名とPHP名はアッパーキャメルケースにします。これは標準的なファイル命名規約に準じています。[1] (ご利用の拡張機能の処理の導入としてはBoilerPlate extensionが適しています。またボイラープレート(大規模なテンプレート)の作成にはMWStewも使用できます。さらにGitHubに置かれたMediaWiki用テンプレートcookiecutter template for MediaWiki extensions on GitHubも参照してください。)

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


Your goal in writing the setup portion is to make installing the extension as easy as possible, so users only have to add this line to LocalSettings.php:

wfLoadExtension( 'MyExtension' );


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

ここまで単純化するには、セットアップファイルに数件のタスクを行います (詳細は下記の説で説明します)。

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


MediaWikiのSpecial:Versionページには、インストールされた拡張機能をすべて一覧にしてあります。 たとえばこのウィキにインストールされた拡張機能はすべて、Special:Versionで参照できます。 このページに皆さんの拡張機能も記載されたかどうか確かめるといいでしょう。 その手順は、開発した拡張機能のメディアハンドラパーサ関数特別ページカスタムXMLタグならびに変数各点$wgExtensionCredits に登録する必要があります。実行例は次のとおりです。

	"name": "Example",
	"author": "John Doe",
	"url": "",
	"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

See Manual:$wgExtensionCredits for full details on what these fields do. Many of the fields are optional, but it's still good practice to fill them out. The manifest_version refers to the version of the schema the extension.json file is written against. As of now (January 2018) versions available are 1 and 2. See here for the documentation on this feature.

In addition to the above registration, you must also "hook" your feature into MediaWiki. The above only sets up the Special:Version page. The way you do this depends on the type of your extension. For details, please see the documentation for each type of extension:

OOjs UI icon puzzle-ltr.svg 拡張機能: 開発 タグ拡張機能 パーサー関数 フック 特別ページ 外装 マジックワード API Content models

Making your extension user configurable

If you want your user to be able to configure your extension, you'll need to provide one or more configuration variables. It is a good idea to give those variables a unique name. They should also follow MediaWiki naming conventions (e.g. global variables should begin with $wg).

For example, if your extension is named "Very silly extension that does nothing", you might want to name all your configuration variables to begin $wgVsetdn or $wgVSETDN. It doesn't really matter what you choose so long as none of the MediaWiki core begins its variables this way and you have done a reasonable job of checking to see that none of the published extensions begin their variables this way. Users won't take kindly to having to choose between your extension and some other extensions because you chose overlapping variable names.

It is also a good idea to include extensive documentation of any configuration variables in your installation notes.

警告 警告: To avoid register_globals vulnerabilities, ALWAYS explicitly set all your extension's configuration variables in extension setup file. Constructs like if ( !isset( $wgMyLeetOption ) ) $wgMyLeetOption = somevalue; do not safeguard against register_globals!

Here is an example boiler plate that can be used to get started:

	"name": "BoilerPlate",
	"version": "0.0.0",
	"author": [
		"Your Name"
	"url": "",
	"descriptionmsg": "boilerplate-desc",
	"license-name": "MIT",
	"type": "other",
	"AutoloadClasses": {
		"BoilerPlateHooks": "BoilerPlateHooks.php",
		"SpecialHelloWorld": "specials/SpecialHelloWorld.php"
	"config": {
		"BoilerPlateEnableFoo": true
	"callback": "BoilerPlateHooks::onExtensionLoad",
	"ExtensionMessagesFiles": {
		"BoilerPlateAlias": "BoilerPlate.i18n.alias.php"
	"Hooks": {
		"NameOfHook": [
	"MessagesDirs": {
		"BoilerPlate": [
	"ResourceModules": {
		"": {
			"scripts": [
			"styles": [
	"ResourceFileModulePaths": {
		"localBasePath": "",
		"remoteExtPath": "BoilerPlate"
	"SpecialPages": {
		"HelloWorld": "SpecialHelloWorld"
	"manifest_version": 1

Note that after calling wfLoadExtension( 'Silly extension that does nothing' ); the global variable $wfBoilerPlateEnableFoo does not exist. If you set the variable, e.g. in LocalSettings.php then the value given in the

	"config": {
		"BoilerPlateEnableFoo": true

will not be used.

Preparing classes for autoloading

If you choose to use classes to implement your extension, MediaWiki provides a simplified mechanism for helping PHP find the source file where your class is located. 多くの場合、__autoload($classname)の手順を自作しなくて済みます。

To use MediaWiki's autoloading mechanism, you add entries to the AutoloadClasses field. The key of each entry is the class name; the value is the file that stores the definition of the class. For a simple one class extension, the class is usually given the same name as the extension, so your autoloading section might look like this (extension is named MyExtension):

	"AutoloadClasses": {
		"MyExtension": "MyExtension.php"

The filename is relative to the directory the extension.json file is in.


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. See the manual page for more information on usage.



Add logs

On MediaWiki, all actions by users on wiki are tracked for transparency and collaboration. See Manual:Special:Logにログを記入する for how to do it.


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. An example you can find e.g. in extension MobileFrontend. Here is an example of a minimal JSON file (in this case 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:


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


  • Assign each message a unique, lowercase, no space message id; e.g.uploadwizard-desc
  • For any text string displayed to the user, define a message.
  • MediaWiki supports parameterized messages and that feature should be used when a message is dependent on information generated at runtime. Parameter placeholders are specified with $n, where n represents the index of the placeholder; e.g.
"mwe-upwiz-api-warning-was-deleted": "There was a file by this name, '$1', but it was deleted and you cannot reupload the file. If your file is different, try renaming it."


Each message you define needs to have an associated message documentation entry Message documentation; in qqq.json e.g.

"uploadwizard-desc": "Description of extension. It refers to [// this event], i.e. the development was paid with this $300,000 grant."


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

	"MessagesDirs": {
		"MyExtension": [

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 を参照してください。


OOjs UI icon puzzle-ltr.svg 拡張機能: 開発 タグ拡張機能 パーサー関数 フック 特別ページ 外装 マジックワード API Content models

Extensions can be categorized based on the programming techniques used to achieve their effect. Most complex extensions will use more than one of these techniques:

  • Subclassing: MediaWiki expects certain kinds of extensions to be implemented as subclasses of a MediaWiki-provided base class:
    • 特別ページ – 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.
  • Manual:Page content models – If you need to store data in formats other than wikitext, JSON, etc. then you can create a new Manual:ContentHandler .

Support other core versions

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.33 need to use the REL1_33 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 is an open-source project and users are encouraged to make any MediaWiki extensions under an Open Source Initiative (OSI) approved license compatible with GPL-2.0-or-later (Wikimedia's standard software license).

We recommend adopting one of the following compatible licenses for your projects in Gerrit:

For extensions that have a compatible license, you can request developer access to the MediaWiki source repositories for extensions. To specify the licence in code and with "license-name" a key should be used to provide it's short name, e.g. "GPL-2.0-or-later" or "MIT" adhering to the list of identifiers at


To autocategorize and standardize the documentation of your existing extension, please see テンプレート:拡張機能 . To add your new extension to this Wiki: Template:Extension/Expectations

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. Review queue を参照してください。

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 database table and field registration .

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.[2]


You should provide public-domain help documentation for features provided by your extension. Help:CirrusSearch is a good example. You should give users a link to the documentation via the addHelpLink() function.

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.