Extension:BoilerPlate

MediaWiki extensions manual

BoilerPlate Release status: stable
Implementation	Example
Description	Boilerplate code ready to be substituted to create a new extension with the latest standards and structure in place.
Author(s)	Krinkletalk
MediaWiki	1.32+
License	GNU General Public License 2.0 or later
Download	Download extension Git [?]: Download Git master browse repository (Phabricator · GitHub) commit history repository contributors (GitHub) code review
Parameters $wgBoilerPlateVandalizeEachPage $wgBoilerPlateEnableFoo
Hooks used BeforePageDisplay
Quarterly downloads	9 (Ranked 122nd)
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.

Usage

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

Then in MyExtension:

• rename BoilerPlate files to MyExtension.
• change BoilerPlate variable names, preserving case (i.e. boilerPlate → myExtension).
• replace "Your Name" in extension.json and i18n files with your name.
• run git init (if you are going to use Git for version control)

Test automation and continuous integration

The BoilerPlate extension implements the standard entry points for test automation, running various code checkers for you that test for errors and enforce part of the MediaWiki coding conventions.

If your extension is hosted on gerrit.wikimedia.org, you can request that Wikimedia's continuous integration machinery run these tests on each commit; see gerrit:226680.

Installation

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 BoilerPlate folder to your extensions/ directory.
  Developers and code contributors should install the extension from Git instead, using:cd extensions/
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

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

• 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
• Extension:Cookiecutter - provides a template to create a new MediaWiki extension using the Cookiecutter project
• A cookiecutter template for MediaWiki extensions
• MWStew generates extension boilerplate files based on various parameters you give it.