Manual:ConvertExtensionToRegistration.php
| MediaWiki version: | ≥ 1.25 Gerrit change 166705 |
| MediaWiki file: convertExtensionToRegistration.php | |
|---|---|
| Location: | maintenance/ |
| Source code: | master • 1.43.1 • 1.42.6 • 1.39.12 |
| Classes: | ConvertExtensionToRegistration |
Details
convertExtensionToRegistration.php is a maintenance script, which helps you migrating extensions and skins from PHP entry points to a JSON metadata file named extension.json or skin.json.
If your extension supports older versions of MediaWiki, you should keep your PHP entry point DirName/FileName.php until you drop support for those older versions.
Options/Arguments
| Option/Argument | Description | Required? |
|---|---|---|
| <path> | Location to the PHP entry point you wish to convert | Required |
| --skin | Whether to write to skin.json; use this option for converting a skin! |
Optional |
| --config-prefix | Custom prefix for configuration settings | Optional |
Usage
php maintenance/run.php convertExtensionToRegistration <path> [ --skin| --config-prefix ]
Terminal
$ php maintenance/run.php convertExtensionToRegistration extensions/FooBar/FooBar.php Wrote output to extensions/FooBar/extension.json
This detects many variable declarations in the entry point FooBar.php and converts them into settings in an extension.json file.
Afterwards, you might still want to manually clean up these declarations inside the FooBar.php file and add a call to wfLoadExtension() as detailed on Manual:Extension registration#Migration for extension developers.
In MediaWiki version 1.39.12 and earlier, you must invoke maintenance scripts using
php maintenance/scriptName.php instead of php maintenance/run.php scriptName.