Release status: stable
|Description||Boilerplate code ready to be substituted to create a new extension with the latest standards and structure in place.|
|License||GNU General Public License 2.0 or later|
|Quarterly downloads||23 (Ranked 142nd)|
|Translate the BoilerPlate extension if it is available at translatewiki.net|
The BoilerPlate extension is a blank extension template. It doesn't really do anything on its own, but provides boilerplate code for an actual MediaWiki extension. It also implements MediaWiki's preferred test automation and continuous integration (see that section below).
You should base your own code on the BoilerPlate extension, but for more in-depth comments and learning you should go and examine the Examples extension.
To use it, enter the following commands to make a clean directory of just the BoilerPlate source code without the Git meta-data and other examples. (Substitute your extension's name for MyExtension.)
cd extensions git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/BoilerPlate.git cp -r BoilerPlate ./MyExtension rm -rf ./MyExtension/.git
- rename BoilerPlate files to MyExtension.
BoilerPlatevariable names, preserving case (i.e. boilerPlate → myExtension).
extension.jsonand i18n files with your name.
git init(if you are going to use Git for version control)
Test automation and continuous integration edit
If you want to install this dummy extension on your wiki to see if it works or troubleshoot problems with your adaptation.
- Download and move the extracted
BoilerPlatefolder to your
Developers and code contributors should install the extension from Git instead, using:
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/BoilerPlate
- Add the following code at the bottom of your LocalSettings.php file:
wfLoadExtension( 'BoilerPlate' );
- To verify if the extension is working add
$wgBoilerPlateVandalizeEachPage = true;to your LocalSettings.php and check for "BoilerPlate was here" text on any page.
- Follow the steps in its README to install testing dependencies, then run npm test and composer test.
- Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
Earlier MediaWiki releases edit
If you want your extension to be compatible with earlier MediaWiki releases, consult the source code of release branches of the Examples extension.
See also edit
- Extension:Examples - based off this extension with additional documentation. Use the Examples extension as a place to read and understand; Use the BoilerPlate extension when starting fresh on a new project.
- Manual:Developing extensions
- A cookiecutter template for MediaWiki extensions
- MWStew generates extension boilerplate files based on various parameters you give it.