 | If you intend to have your extension deployed on Wikimedia sites, readWriting an extension for deployment |
This page is a guide to developingextensions for MediaWiki.Before you start, browse the complete list in:Category:Extensions by category to see if an extension already exists for your use case.
Extension development consists of these parts:
To set up a new extension, start by setting up alocal development environment for MediaWiki, and follow the instructions to install and copy theBoilerPlate extension.
$wgMainCacheType = CACHE_NONE and$wgCacheDirectory =false, otherwise system messages and other changes may not show up.A minimal extension has the following structure:
extension.json. (Prior to MediaWiki 1.25 the setup instructions were in aMyExtension/MyExtension.php file named after the extension. Many extensions still have backwards-compatibility shims in this PHP file.).md. For example, see theREADME.md file forParsoid onPhabricator Diffusion.When you develop an extension, replaceMyExtension above with the name of your extension.UseUpperCamelCase names for its directory and PHP files; this is the generalfile naming convention.[1]
| MediaWiki version: | ≥ 1.25 |
Theextension.json file contains the configuration data for the extension. Here is an example of a minimalextension.json:
{"name":"MyExtension","author":"John Doe","url":"https://www.mediawiki.org/wiki/Extension:MyExtension","description":"This extension is an example.","version":"1.5","license-name":"GPL-2.0-or-later","type":"validextensiontype","manifest_version":2}
Many of the fields are optional, but it's still good practice to fill them out.For a more complete example ofextension.json, see theBoilerPlate extension.
Themanifest_version refers to the version of the schema theextension.json file is written against.Seethe documentation on this feature.Unless you need to support an older version of MediaWiki, pick the latest version.
Once you have anextension.json file set up for your extension, the extension will appear on your localSpecial:Version page.
MediaWiki is an open-source project and users are encouraged to make anyMediaWiki extensions under anOpen Source Initiative (OSI) approved license compatible withGPL-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 its short name, e.g. "GPL-2.0-or-later" or "MIT" adhering tothe list of identifiers at spdx.org.
Ideally, users should be able to install your extension by adding only one line toLocalSettings.php:
wfLoadExtension('MyExtension');
If you want to make your extension user configurable, you need to define and document some configuration parameters and your users' setup should look something like this:
wfLoadExtension('MyExtension');$wgMyExtensionConfigThis=1;$wgMyExtensionConfigThat=false;
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 MediaWikinaming conventions (e.g. global variables should begin with $wg).
For example, if your extension is namedMyExtension, you might want to name all your configuration variables to begin with$wgMyExtension.It is important thatnone 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.
Here is an example of how to set up a configuration variable inextension.json:
{"config":{"BoilerPlateEnableFoo":{"value":true,"description":"Enables the foo functionality"}}}
Note that after callingwfLoadExtension('BoilerPlate'); the global variable$wgBoilerPlateEnableFoo does not exist.If you set the variable, e.g. inLocalSettings.php then the default value given inextension.json will not be used.
For more details on how to use global variable inside custom extensions, please refer toConfiguration for developers.
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.In most cases this should eliminate the need to write your own__autoload($classname) method.
To use MediaWiki's autoloading mechanism, you add entries to theAutoloadClasses 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 namedMyExtension):
{"AutoloadClasses":{"MyExtension":"includes/MyExtension.php"}}
The filename is relative to the directory the extension.json file is in.
For more complex extensions,namespaces should be considered.SeeManual:Extension.json/Schema#AutoloadNamespaces for details.
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 extensionCountingMarker requires the presence of the extensionHitCounters for certain functions.
One way to specify this would be by using therequires key inextension.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 theirextension.json.[2][3]
Example:if you want to check the load status of extension OpenIDConnect, you have to use it with aspace
if(ExtensionRegistry::getInstance()->isLoaded('OpenID Connect')){...}
For an overview of code architecture, structure, and conventions for extensions, seeBest practices for extensions.
MediaWiki core provides several ways for extensions to change the behavior, functionality, and appearance of a wiki.Most extensions use more than one of these extension points.For a complete list of extension points supported in extension.json, see theschema reference.
action URL parameter generates a custom page based on the current page, usually to provide information (such as page history) or to perform an action (such as edit the page). In addition to the default actions provided by MediaWiki core, extensions can define a new page action.{{...}}) or tags (<example/>). These customizations are used to generate content and to interact with MediaWiki during page rendering.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.
 Warning: | If your extension is used on any production WMF-hosted wiki please follow theSchema change guide. |
If your extension needs to add its own database tables, use theLoadExtensionSchemaUpdates hook.See the manual page for more information on usage.
Attributes allow extensions to register something, such as a module, with another extension.For example, extensions can use attributes to register a plugin module with the VisualEditor extension.For more information, seeExtension registration.
|
|
$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.
<language-key>.jsonStore 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 maynot contain spaces.Each key should begin with the lowercased extension name.An example you can find in theMobileFrontend extension.Here is an example of a minimal JSON file (in this caseen.json):
en.json
{"myextension-desc":"Adds the MyExtension great functionality.","myextension-action-message":"This is a test message"}
The documentation for message keys can be stored in the JSON file for the pseudo language with codeqqq.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 yourextension.json, define the location of your messages files (e.g. in directoryi18n/):
{"MessagesDirs":{"MyExtension":["i18n"]}}
In your setup and implementation code, replace each literal use of the message with a call towfMessage( $msgID, $param1, $param2, ... ).In classes that implementIContextSource (as well as some others such as subclasses of SpecialPage), you can use$this->msg($msgID,$param1,$param2,...) instead.Example:
wfMessage('myextension-addition','1','2','3')->parse()
It's possible to use i18n functions in JavaScript too.Look atManual:Messages API for details.
To autocategorize and standardize the documentation of your existing extension, please seeTemplate:Extension.To add your new extension to this Wiki:
A developer sharing their code in the MediaWiki code repository should expect:
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.
If you intend to have your extension deployed on Wikimedia sites (including possibly Wikipedia), additional scrutiny is warranted in terms of performance and security.ConsultWriting an extension for deployment.
If your extension adds namespaces, you may wish to register itsdefault namespaces; likewise, if it adds database tables or fields, you may want to register those atDatabase field prefixes.
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 providepublic 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 ofHelp: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 theaddHelpLink() function.
There are a number of common approaches to releasing updates to extensions.These are generally defined according to thecompatibility policy of the extension (master,rel, orltsrel):
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 andltsrel – Release by backporting changes to theREL1_* 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.There are two widespread conventions for supporting older versions of MediaWiki core:
Extension maintainers should declare with thecompatibility policy parameter of the {{Extension}} template which convention they follow.
Extension developers should open an account on Wikimedia'sPhabricator, andrequest 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.