Manual:GetConfiguration.php
MediaWiki version: | ≥ 1.23 |
MediaWiki file: getConfiguration.php | |
---|---|
Location: | maintenance/ |
Source code: | master • 1.43.1 • 1.42.6 • 1.39.12 |
Classes: | GetConfiguration |
Details
getConfiguration.php file is a maintenance script to print serialized output of MediaWiki config variables.
Options
Option | Description | Required | Default |
---|---|---|---|
--regex | Regex to filter variables with | Optional | |
--iregex | Same as --regex but case insensitive | Optional | |
--settings | Space-separated list of wg* variables | Optional | |
--format | Output format, either json, php, serialize, or vardump | Optional | php |
Usage
php maintenance/run.php getConfiguration [ --regex| --iregex| --settings| --format ]
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
.With settings
Terminal
$ php maintenance/run.php getConfiguration --format vardump --settings wgSessionProviders $wgSessionProviders = array(2) { ["MediaWiki\Session\CookieSessionProvider"]=> array(2) { ["class"]=> string(39) "MediaWiki\Session\CookieSessionProvider" ["args"]=> array(1) { [0]=> array(2) { ["priority"]=> int(30) ["callUserSetCookiesHook"]=> bool(true) } } } ["MediaWiki\Session\BotPasswordSessionProvider"]=> array(2) { ["class"]=> string(44) "MediaWiki\Session\BotPasswordSessionProvider" ["args"]=> array(1) { [0]=> array(1) { ["priority"]=> int(75) } } } };
With regex
Terminal
{{#parsoid\0fragment:0}}
Use JSON_PARTIAL_OUTPUT_ON_ERROR (--json-partial-output-on-error) flag with json_encode(). This allows for partial response to be output in case of an exception while serializing to JSON. If an error occurs, the
wgGetConfigurationJsonErrorOccurred
field is set in the output.Terminal
$ php maintenance/run.php getConfiguration --format json --json-partial-output-on-error
See also
- Manual:Configuration settings
- Manual:Configuration for developers
- Config.php
- Extension registration#Configs (Your extension/skins settings)