Podręcznik:ConvertExtensionToRegistration.php
Wersja MediaWiki: | ≥ 1.25 Gerrit change 166705 |
Plik MediaWiki: convertExtensionToRegistration.php | |
---|---|
Lokalizacja: | maintenance/ |
Kod źródłowy: | master • 1.42.3 • 1.41.4 • 1.39.10 |
Klasy: | ConvertExtensionToRegistration |
Szczegóły
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 | Wymagane |
--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/convertExtensionToRegistration.php <path> [ --skin| --config-prefix ]
Terminal
$ php maintenance/convertExtensionToRegistration.php 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.