MediaWiki

Manual:Extension.json/Esquema

< Manual:Extension.json
This page is a translated version of the page Manual:Extension.json/Schema and the translation is 2% complete.
Outdated translations are marked like this.
Languages:
ficheiro do MediaWiki: extension.schema.v2.json
Localização: docs/
Código fonte: master • 1.42.4 • 1.41.5 • 1.39.11
Classes: Find code • Find documentation

Esta página documenta o esquema utilizado por extension.json . Todos os campos são opcionais, a menos que indicação em contrário. Está atualmente incompleto.

Para a primeira iteração deste esquema, consulte docs/extension.schema.v1.json (MW 1,25+), para a segunda, consulte docs/extension.schema.v2.json (MW 1,29+).

manifest_version

Versão MediaWiki:
≥ 1.25
Gerrit change 212239

This field is required.

This specifies the version of the extension.json file format that is being used. In the future if breaking changes are made to the file format, this number will be incremented to continue supporting extensions using the older format.

Currently the following values are supported:

  • 1: 1.25+
  • 2: 1.29+

v2 provides stronger developer validation features, and is recommended if your extension already requires MediaWiki 1.29+. It is not recommended to break MediaWiki compatibility with older versions just to upgrade to a newer manifest_version.

Until MediaWiki 1.43, new features were added to both v1 and v2, but since then v1 is frozen and deprecated.

Example: 

{
	"manifest_version": 2
}
This field is typically placed at the bottom of extension.json files.

name

Versão MediaWiki:
≥ 1.25
Gerrit change 166705

This field is required.

This is the extension's canonical name. It should not be changed once set, as it is used as an API for other extensions to detect what is installed. The name field does not have to match an extension's directory name nor the name of its page in the Extension namespace on MediaWiki.org. 

{
	"name": "FooBar"
}

namemsg

Versão MediaWiki:
≥ 1.25
Gerrit change 166705

A localized version of the extension's name. Typically the message key is named in the format <name>-extensionname or <name>-skinname. 

{
	"namemsg": "foobar-extensionname"
}

type

Versão MediaWiki:
≥ 1.25
Gerrit change 166705

The type of extension it is, for sorting on Special:Version. The following types are supported:

Custom types can be added by using the ExtensionTypes hook. Known ones include:

If not set, the extension will default to the "other" section, and if set to an invalid value the extension will not appear on Special:Version. 

{
	"type": "specialpage"
}

author

Versão MediaWiki:
≥ 1.25
Gerrit change 166705

Os autores da extensão, poderão conter texto wiki. Pode ser uma única string ou uma matriz de strings. Adicionalmente, a string especial ... pode ser utilizada para adicionar um sufixo genérico "outros" utilizando a mensagem version-poweredby-others.

version

Versão MediaWiki:
≥ 1.25
Gerrit change 166705

The current version of the extension. Should be in a format supported by Composer.

url

Versão MediaWiki:
≥ 1.25
Gerrit change 166705

URL to the extension's "homepage" or documentation. Typically points to https://www.mediawiki.org/wiki/Extension:<extensionname>.

description

Versão MediaWiki:
≥ 1.25
Gerrit change 166705

Description of the extension, may contain wikitext.

It is recommended to use descriptionmsg instead.

descriptionmsg

Versão MediaWiki:
≥ 1.25
Gerrit change 166705

Localization message key for the extension's description, typically in the format <extensionname>-desc. This will override description.

license-name

Versão MediaWiki:
≥ 1.25
Gerrit change 166705

The SPDX license identifier for the license the source code is licensed as. If you create a file named COPYING or LICENSE (with an optional .txt extension) in the extension root directory with the contents of the license, it will also be linked and visible from Special:Version.

requires

Versão MediaWiki:
≥ 1.26
Gerrit change 210856
Versão MediaWiki:
≥ 1.29
Gerrit change 250060

The requires section allows you to document dependencies on versions of MediaWiki core (1.26+) and other extensions (1.29+). 

{
	"requires": {
		"MediaWiki": ">= 1.27.0",
		"extensions": {
			"FooBar": "*",
			"Baz": ">= 1.2.3"
		}
	}
}

You can use any version specifier that composer supports. For MediaWiki, it is best practice to specify a >= for the minimum supported version, unless you know a future version is explicitly broken. For extensions, if they don't have a version specifier set, or don't use a versioning system, use a plain * to indicate any version is acceptable.

If your extension uses Wikimedia Continuous integration, you also need to add extension dependencies to zuul/parameter_functions.py in the integration/config project.

platform

Versão MediaWiki:
≥ 1.32
Gerrit change 458940
Versão MediaWiki:
≥ 1.32
Gerrit change 462596

You can also express a dependency on platform settings, currently limited to PHP version and PHP extensions. Note that most extensions are expected to follow the PHP version requirements for the versions of MediaWiki core they support, and specifying a more restrictive PHP version contraint should only be done in exceptional cases. Checking for PHP extension versions isn't supported right now. 

{
	"requires": {
		"MediaWiki": ">= 1.32.0",
		"platform": {
			"php": ">= 7.1",
			"ext-curl": "*"
		}
	}
}

In this example, the extension requires 1.32 (which has a minimum requirement of PHP 7.0), and additionally expresses that it needs a higher dependency of at least PHP 7.1 since it requires usage of some newer PHP feature. Furthermore, it required the curl PHP extension to be installed.

suggests

Versão MediaWiki:
≥ 1.39
Gerrit change 591897

Allows listing suggested but not required dependencies. The format is identical to requires.

ResourceFileModulePaths

Versão MediaWiki:
≥ 1.25
Gerrit change 188996

Specifies the default paths to use for all ResourceLoader file modules.

The allowed properties are:

  • localBasePath
  • remoteExtPath - must not point to other extension folders
  • remoteSkinPath

These correspond to the same options in each module definition in ResourceModules. If a value is not specified in the module definition, the default value specified here will be used. 

{
	"ResourceFileModulePaths": {
		"localBasePath": "resources",
		"remoteExtPath": "FooBar/resources"
	}
}

ResourceModules

Versão MediaWiki:
≥ 1.25
Gerrit change 166705

ResourceLoader modules to register.

This option corresponds directly with the global variable $wgResourceModules . Please refer to the documentation there on how to configure it.


For guidance, see Developing with ResourceLoader and extension.json .

ResourceModuleSkinStyles

Versão MediaWiki:
≥ 1.25
Gerrit change 201661

ResourceLoader modules for custom skin styles.

This option corresponds directly with the global variable $wgResourceModuleSkinStyles . Please refer to the documentation there on how to configure it.


ResourceLoaderSources

Versão MediaWiki:
≥ 1.25
Gerrit change 166705

ResourceLoader sources to register.

This option corresponds directly with the global variable $wgResourceLoaderSources . Please refer to the documentation there on how to configure it.


ResourceLoaderLESSVars

Versões do MediaWiki:
1.25 – 1.30
Gerrit change 166705

An associative array binding variable names to LESS code snippets representing their values.

This option corresponds directly with the global variable $wgResourceLoaderLESSVars . Please refer to the documentation there on how to configure it.


SkinLessImportPaths

Versão MediaWiki:
≥ 1.36
Gerrit change 434211

Path to the skin-specific LESS import directory, keyed by skin name. Can be used to define skin-specific LESS variables.

QUnitTestModule

Versão MediaWiki:
≥ 1.33
Gerrit change 485247

A ResourceLoader file module, to loaded when running JavaScript unit tests. This follows the same syntax as ResourceModules.

Internally, when $wgEnableJavaScriptTest is true, this module is automatically registered under the name "test.ExtensionName".

MessagePosterModule

Versão MediaWiki:
≥ 1.35
Gerrit change 542655

Allows extensions to add additional files or dependencies to the mediawiki.messagePoster module bundle. This follows the same syntax as ResourceModules.

ConfigRegistry

Versão MediaWiki:
≥ 1.25
Gerrit change 166705

Registry of factory functions to create Config objects.

This option corresponds directly with the global variable $wgConfigRegistry . Please refer to the documentation there on how to configure it.


SessionProviders

Versão MediaWiki:
≥ 1.27
Gerrit change 288324

Specifies what providers to use for SessionManager.

This option corresponds directly with the global variable $wgSessionProviders . Please refer to the documentation there on how to configure it.


AuthManagerAutoConfig

Versão MediaWiki:
≥ 1.27
Gerrit change 195297

AuthManager auto-configuration.

This option corresponds directly with the global variable $wgAuthManagerAutoConfig . Please refer to the documentation there on how to configure it.


The following properties are available:

  • preauth – Pre-authentication providers.
  • primaryauth – Primary authentication providers.
  • secondaryauth – Secondary authentication providers.

CentralIdLookupProviders

Versão MediaWiki:
≥ 1.27
Gerrit change 261909

Central ID lookup providers.

This option corresponds directly with the global variable $wgCentralIdLookupProviders . Please refer to the documentation there on how to configure it.


ChangeCredentialsBlacklist

Versão MediaWiki:
≥ 1.28
Gerrit change 294859

AuthenticationRequest classes which can only be used internally for credential change.

This option corresponds directly with the global variable $wgChangeCredentialsBlacklist . Please refer to the documentation there on how to configure it.


RemoveCredentialsBlacklist

Versão MediaWiki:
≥ 1.28
Gerrit change 294859

AuthenticationRequest classes which can only be used internally for credential removal.

This option corresponds directly with the global variable $wgRemoveCredentialsBlacklist . Please refer to the documentation there on how to configure it.


namespaces

Versão MediaWiki:
≥ 1.25.3
Gerrit change 237973

Method to add extra namespaces .

The following properties are available:

Name Type Description Default
id integer The numeric identifier of the namespace, as used in the database. Since MW 1.30, the namespace ID can be overwritten locally, by defining the respective constant in LocalSettings.php before loading the extension. Extension code must therefore always use the constant for the namespace ID, and never use the ID as a literal in PHP code. Consider listing your id number used at Extension default namespaces to avoid conflicts with other extensions.
constant string The name of the constant that the extension code uses to refer to the namespace ID.
name string The name of the namespace, as used in titles.
gender Gender object Properties are either "male" or "female". See gender support.
subpages Boolean See Manual:$wgNamespacesWithSubpages . false
content Boolean See Manual:$wgContentNamespaces . false
defaultcontentmodel string See ContentHandler .
protection array or string Userright(s) required to edit in this namespace.
capitallinkoverride Boolean Set $wgCapitalLinks on a per-namespace basis.
conditional Boolean Whether the namespace is conditional upon configuration and should not be registered (requires separate registration via a hook such as CanonicalNamespaces ). false
movable Boolean Whether it is possible to move pages in this namespace. (introduzido(a) na 1.35.2) true

TrackingCategories

Versão MediaWiki:
≥ 1.25
Gerrit change 166705

Tracking category message keys.

This option corresponds directly with the global variable $wgTrackingCategories . Please refer to the documentation there on how to configure it.


DefaultUserOptions

Versão MediaWiki:
≥ 1.25
Gerrit change 166705


This option corresponds directly with the global variable $wgDefaultUserOptions . Please refer to the documentation there on how to configure it. 

	"DefaultUserOptions": {
		"math": "png"
	},

HiddenPrefs

Versão MediaWiki:
≥ 1.25
Gerrit change 166705

Preferences users cannot set.

This option corresponds directly with the global variable $wgHiddenPrefs . Please refer to the documentation there on how to configure it.


GroupPermissions

Versão MediaWiki:
≥ 1.25
Gerrit change 166705

Default permissions to give to user groups.

This option corresponds directly with the global variable $wgGroupPermissions . Please refer to the documentation there on how to configure it.


PrivilegedGroups

Versão MediaWiki:
≥ 1.41
Gerrit change 954742

User groups that should be considered privileged.

This option corresponds directly with the global variable $wgPrivilegedGroups . Please refer to the documentation there on how to configure it.


RevokePermissions

Versão MediaWiki:
≥ 1.25
Gerrit change 166705

Default permissions to revoke from user groups.

This option corresponds directly with the global variable $wgRevokePermissions . Please refer to the documentation there on how to configure it.


GrantPermissions

Map of permissions granted to authorized consumers to their bundles, called 'grants.'

This option corresponds directly with the global variable $wgGrantPermissions . Please refer to the documentation there on how to configure it.


GrantPermissionGroups

Map of grants to their UI grouping.

This option corresponds directly with the global variable $wgGrantPermissionGroups . Please refer to the documentation there on how to configure it.


ImplicitGroups

Implicit groups.

This option corresponds directly with the global variable $wgImplicitGroups . Please refer to the documentation there on how to configure it.


GroupsAddToSelf

Groups a user can add to themselves.

This option corresponds directly with the global variable $wgGroupsAddToSelf . Please refer to the documentation there on how to configure it.


GroupsRemoveFromSelf

Groups a user can remove from themselves.

This option corresponds directly with the global variable $wgGroupsRemoveFromSelf . Please refer to the documentation there on how to configure it.


AddGroups

Groups a user can add to users.

This option corresponds directly with the global variable $wgAddGroups . Please refer to the documentation there on how to configure it.


RemoveGroups

Groups a user can remove from users.

This option corresponds directly with the global variable $wgRemoveGroups . Please refer to the documentation there on how to configure it.


AvailableRights

User rights added by the extension.

This option corresponds directly with the global variable $wgAvailableRights . Please refer to the documentation there on how to configure it.


ContentHandlers

Mapping of Model ID to class name.

This option corresponds directly with the global variable $wgContentHandlers . Please refer to the documentation there on how to configure it.


RateLimits

Simple rate limiter options to brake edit floods.

This option corresponds directly with the global variable $wgRateLimits . Please refer to the documentation there on how to configure it.


RecentChangesFlags

Flags (letter symbols) shown in recent changes and watchlist to indicate certain types of edits.

This option corresponds directly with the global variable $wgRecentChangesFlags . Please refer to the documentation there on how to configure it.


MediaHandlers

Plugins for media file type handling. Each entry in the array map maps a MIME type to a PHP class name.

This option corresponds directly with the global variable $wgMediaHandlers . Please refer to the documentation there on how to configure it.


ExtensionFunctions

Function to call after setup has finished.

This option corresponds directly with the global variable $wgExtensionFunctions . Please refer to the documentation there on how to configure it.


Note that extension functions cannot be used to programmatically update configuration variables or register hooks. For that purpose, a registration callback should be used instead.

ExtensionMessagesFiles

File paths containing PHP internationalization files for magic words (including parser functions), special page aliases , and/or namespace names .

This option corresponds directly with the global variable $wgExtensionMessagesFiles . Please refer to the documentation there on how to configure it.


MessagesDirs

Directory paths containing JSON internationalization data.

This option corresponds directly with the global variable $wgMessagesDirs . Please refer to the documentation there on how to configure it.


If you use the default directory layout with localized messages in the i18n/ directory, you can specify: 

"MessagesDirs": {
	"ExtensionName": [
		"i18n"
	]
},

ExtensionEntryPointListFiles

Array of files with list(s) of extension entry points to be used in maintenance/mergeMessageFileList.php

This option corresponds directly with the global variable $wgExtensionEntryPointListFiles . Please refer to the documentation there on how to configure it.


SpecialPages

SpecialPages implemented in this extension (mapping of page name to class name).

This option corresponds directly with the global variable $wgSpecialPages . Please refer to the documentation there on how to configure it.


AutoloadClasses

Array mapping class names to filenames, for autoloading.

This option corresponds directly with the global variable $wgAutoloadClasses . Please refer to the documentation there on how to configure it.

Example: 

{
    ...
    "AutoloadClasses": {
        "MyClassName": "includes/FileContainingMyClassName.php",
        "SomeNamespace\\SpecialHelloWorld": "specials/SpecialHelloWorld.php"
    },
    ...
}

AutoloadNamespaces

Versão MediaWiki:
≥ 1.31
Gerrit change 373626

Array containing mapping of namespaces to directories in a PSR-4 compatible manner. Here's an example: 

{
	"AutoloadNamespaces": {
		"MediaWiki\\Extension\\BetaFeatures\\": "includes/"
	}
}

In this case all of the PHP classes are under the MediaWiki\Extension\BetaFeatures\ namespace, and the naming of the classes directly maps to the files located in the includes/ directory (relative to the extension.json file). Note that the namespace portion must end with \\.

Extensions using this feature should require at least MediaWiki 1.31 in extension.json file: 

{
	"requires": {
		"MediaWiki": ">= 1.31.0"
	},
}

For example, see Gerrit change 468385.

TestAutoloadClasses and TestAutoloadNamespaces

Versão MediaWiki:
≥ 1.35
Gerrit change 556181

Both are the same as AutoloadClasses and AutoloadNamespaces, except that they are only used when running tests.

For example, see Gerrit change 556240.

Hooks

Hooks this extension uses (mapping of hook name to callback).

This option corresponds directly with the global variable $wgHooks . Please refer to the documentation there on how to configure it. 


{
	"Hooks": {
		"ParserFirstCallInit": "MassMessageHooks::onParserFirstCallInit"
	}
}

It's possible to register multiple callbacks for the same hook event: 

{
	"Hooks": {
		"ParserFirstCallInit": [
			"MassMessageHooks::onParserFirstCallInitOne",
			"MassMessageHooks::onParserFirstCallInitTwo"
		]
	}
}

HookHandlers

Versão MediaWiki:
≥ 1.35
Gerrit change 596914

ObjectFactory specifications for new-style hook handlers. 

{
    "Hooks": {
        "BeforePageDisplay": "main"
    },
    "HookHandlers": {
        "main": {
            "class": "MediaWiki\\Extension\\MyExtension\\HookHandler",
            "services": [ "UserNameUtils" ]
        }
    }
}

There is a difference with the previous approach in that:

  • Your HookHandler must import the hooks with the use keyword.
  • The HookHandler class must also implement them.
  • The functions using those hooks in your HookHandler class cannot be called statically, i.e. are dynamic rather than static.

DeprecatedHooks

Versão MediaWiki:
≥ 1.35
Gerrit change 596914

Deprecated hooks (see Stable interface policy). Maps hook name to an array with deprecatedVersion (MediaWiki version) and component (optional, usually omitted).

JobClasses

Job types this extension implements (mapping of job types to class name).

This option corresponds directly with the global variable $wgJobClasses . Please refer to the documentation there on how to configure it.


LogTypes

List of new log types this extension uses.

This option corresponds directly with the global variable $wgLogTypes . Please refer to the documentation there on how to configure it.


LogRestrictions

Restricts log access to those who have a certain right.

This option corresponds directly with the global variable $wgLogRestrictions . Please refer to the documentation there on how to configure it.


FilterLogTypes

An object.

This option corresponds directly with the global variable $wgFilterLogTypes . Please refer to the documentation there on how to configure it.


ActionFilteredLogs

List of log types which can be filtered by log actions.

This option corresponds directly with the global variable $wgActionFilteredLogs . Please refer to the documentation there on how to configure it.


LogNames

Lists the message key string for each log type.

This option corresponds directly with the global variable $wgLogNames . Please refer to the documentation there on how to configure it.


LogHeaders

Lists the message key string for descriptive text to be shown at the top of each log type.

This option corresponds directly with the global variable $wgLogHeaders . Please refer to the documentation there on how to configure it.


LogActions

Lists the message key string for formatting individual events of each type and action when listed in the logs.

This option corresponds directly with the global variable $wgLogActions . Please refer to the documentation there on how to configure it.


LogActionsHandlers

Same as $wgLogActions , but values are functions callbacks.

This option corresponds directly with the global variable $wgLogActionsHandlers . Please refer to the documentation there on how to configure it.


Actions

Array of allowed values for the "action" parameter for normal pages.

This option corresponds directly with the global variable $wgActions . Please refer to the documentation there on how to configure it.


APIModules

API module extensions.

This option corresponds directly with the global variable $wgAPIModules . Please refer to the documentation there on how to configure it.


APIFormatModules

API format module extensions.

This option corresponds directly with the global variable $wgAPIFormatModules . Please refer to the documentation there on how to configure it.


APIMetaModules

API Query meta module extensions.

This option corresponds directly with the global variable $wgAPIMetaModules . Please refer to the documentation there on how to configure it.


APIPropModules

API Query prop module extensions.

This option corresponds directly with the global variable $wgAPIPropModules . Please refer to the documentation there on how to configure it.


APIListModules

API Query list module extensions.

This option corresponds directly with the global variable $wgAPIListModules . Please refer to the documentation there on how to configure it.


RestRoutes

Versão MediaWiki:
≥ 1.35
Gerrit change 508972

List of route specifications to be added to the REST API. See API:REST API/Extensions.

ValidSkinNames

List of valid skin names. Skins can optionally use this variable to tell MediaWiki that they are available.

This option corresponds directly with the global variable $wgValidSkinNames . Please refer to the documentation there on how to configure it.


FeedClasses

Available feed objects.

This option corresponds directly with the global variable $wgFeedClasses . Please refer to the documentation there on how to configure it.


SkinOOUIThemes

Map of skin names to OOUI themes to use. 

{
	"SkinOOUIThemes": {
		"yourskinname": "Apex"
	}
}

OOUIThemePaths

Map of custom OOUI theme names to paths to load them from. 

{
	"OOUIThemePaths": {
		"YourTheme": {
			"scripts": "resources/ooui/oojs-ui-yourtheme.js",
			"styles": "resources/ooui/oojs-ui-{module}-yourtheme.css",
			"images": "resources/ooui/{module}.json"
		}
	},
}
scripts
Path to script file.
styles
Path to style files. {module} will be replaced with the module's name.
images
Path to image definition files. {module} will be replaced with the module's name. If the files don't exist, default theme's images will be used instead.

PasswordPolicy

Password policies.

This option corresponds directly with the global variable $wgPasswordPolicy . Please refer to the documentation there on how to configure it.


FileExtensions

Preferred file extensions for uploading.

This option corresponds directly with the global variable $wgFileExtensions . Please refer to the documentation there on how to configure it.


RawHtmlMessages

List of messages which might contain raw HTML.

This option corresponds directly with the global variable $wgRawHtmlMessages . Please refer to the documentation there on how to configure it.


LateJSConfigVarNames

Names of JS config vars (as used in MakeGlobalVariablesScript hook or in ParserOutput::setJsConfigVar ) that may be set from the end of the HTML body instead of the HTML head, to improve page load time. In JavaScript, these variables should be accessed via mw.hook( 'wikipage.content' ).

DatabaseVirtualDomains

Names of virtual domains that are used to get a db connection. See $wgVirtualDomainsMapping .

ReauthenticateTime

Time frame for re-authentication.

This option corresponds directly with the global variable $wgReauthenticateTime . Please refer to the documentation there on how to configure it.


ForeignResourcesDir

Versão MediaWiki:
≥ 1.41
Gerrit change 911307

Directory containing the extension's foreign resources (and the foreign-resources.yaml file defining them). Should be given relative to the extension root.

callback

Sometimes extensions need to do non-standard things during registration, or are just very complex. You can specify a callback key in your extension.json if you need to execute some PHP code. The value should be set to a valid PHP callable, for example: FooBarHooks::onRegistration. ExtensionRegistry will execute this callback after it processes the extension.json file and sets all the other globals and configuration settings. This happens after LocalSettings, so all user-specified configuration is available, but some defaults set by MediaWiki might not have been initialized yet. 

{
	"callback": "FooBarHooks::onRegistration"
}

The callback is provided with two parameters, an array containing information about the extension (a subset of extension.json) and an instance of SettingsBuilder MW 1.40+.

The callback isn't a normal hook function, it runs in early initialization. See Manual:Extension registration/Limitations for what sort of things may require custom registration.

Registration callbacks are the preferred way for extensions to dynamically set configuration. This should be done through the SettingsBuilder object passed to callback, using the getConfig() and overrideConfigValue() methods.

Registration callbacks do not have access to service objects via MediaWikiServices, and cannot make use of the main RequestContext. Neither has been initialized at the time the callback is executed. Extensions that need to access the request context or interact with a service object during initialization should register an ExtensionFunction instead.

config

Versão MediaWiki:
≥ 1.25

The config section is where you can define configuration settings that sysadmins can change to configure the extension. This section should only be used for things that are configured in LocalSettings.php - if it is supposed to be modified by other extensions, you should use attributes, or if it is just class metadata, use a private static variable or something like that. The format of config changed in manifest_version 2.

Manifest version 1

A simple example: 

{
    "config": {
        "FooBarUseExtraFeature": false
    }
}

This is equivalent to writing $wgFooBarUseExtraFeature = false; in PHP. Note that the typical "wg" prefix is not included, as that will be added by default. If your settings start with a different prefix like $eg, you can use the magic _prefix key: 

{
	"config": {
		"_prefix": "eg",
		"FooBarUseExtraFeature": false
	}
}

This is now equivalent to writing $egFooBarUseExtraFeature = false; in PHP.

A more complex example: 

{
	"config": {
		"FooBarEnabledNamespaces": {
			"0": true,
			"2": true,
			"4": true,
			"_merge_strategy": "array_plus"
		},
		"FooBarCoolStuff": {
			"sysop": {
				"foo": true,
				"bar": false
			},
			"_merge_strategy": "array_plus_2d"
		}
	}
}

The first setting, $wgFooBarEnabledNamespaces, has keys that are numbers, so PHP will turn them into integers, even though they are strings in JSON. Because of how PHP treats integer keys when merging arrays, we need to use a different type of merge here, so we set a different "merge strategy" using the magic key. In the second example, we have a nested array, which requires a different type of merging, since we want to allow people to continue writing $wgFooBarCoolStuff['user']['foo'] = true; in their LocalSettings.php.

Changes in manifest version 2

Versão MediaWiki:
≥ 1.29

With MediaWiki 1.29, a new manifest_version (2) was introduced. In this version, the config section is improved in several ways. To support these changes, the signature of a set of configuration option and configuration value changed a bit. The key of the config object is still the configuration name; however, the value of that key is an object, which describes this configuration option, where one of the values is the value. You can find information about what the specific keys and values for a configuration option are on the extension registration documentation page. An easy example of the new schema, which simply is one configuration option and its value, would look like: 

{
	"config": {
		"FooBarUseExtraFeature": {
			"value": false
		}
	},
	"manifest_version": 2
}

A more complex one would look like: 

{
	"config_prefix": "eg",
	"config": {
		"MyExtSetting": {
			"value": true,
			"path": false,
			"description": "The description for the configuration",
			"descriptionmsg": "myextension-config-myextsetting",
			"public": true
		},
		"FooBarCoolStuff": {
			"value": {
				"sysop": {
					"foo": true,
					"bar": false
				}
			},
		    "merge_strategy": "array_plus_2d"
		}
	},
	"manifest_version": 2
}
The version 2 of the schema is incompatible with version 1. Thus you will have to convert your existing "extension.json" file to the new format using the updateExtensionJsonSchema.php script.

path

As demonstrated in the example above, a configuration option can have the path key defined. When present and set to true, the value of the setting will be interpreted as a path local to the extension. For example, an extension might define its configuration as 

{
	"config": {
		"Setting": {
			"value": "some_file.txt",
			"path": true
		}
	},
	"manifest_version": 2
}

The value for the configuration option "Setting" will be resolved to $wgExtensionDirectory/FooBar/some_file.txt.

merge strategy

The merge strategy defines how to merge the default value of the configuration setting with the global value (the value of the $wgXXX global variable). This only makes sense for array-valued configuration settings. The following merge strategies are available:

  • array_merge – Uses the array_merge PHP command: array elements with numeric keys will be interpreted as non-associative list items and concatenated to the array (with the keys renumbered if needed), array elements with non-numeric keys will be interpreted as hashmap items and overwrite items with the same key.
  • array_plus – Uses the + PHP operator, so fields of the default value will only be used when the corresponding field is not set in the global value. This is useful for associative arrays with integer keys (such as namespace IDs).
  • array_plus_2d – Uses wfArrayPlus2d to handles nested arrays to a depth of 2 properly (e.g. $wgGroupPermissions ).
  • array_merge_recursive – Handles arrays even deeper than 2 with array_merge_recursive. Given the unintuitive behavior of this method (example), this strategy is not recommended. A configuration setting that is more than 2 levels deep suggests too many things are being configured in one setting, and splitting it into multiple settings might be a good idea.
  • array_replace_recursive – Uses array_replace_recursive, basically the recursive version of array_plus. Unlike array_merge_recursive, this will handle non-array fields the way one would expect.
  • provide_default (since MW 1.35.3) – no merging; the default will only be used when no global value is set.

When not explicitly set, the merge strategy defaults to array_merge. When at least one of the global value and the default is not an array, the merge strategy is ignored and the global value will simply override the default.

config_prefix

Versão MediaWiki:
≥ 1.28

Prefix to put in front of configuration settings when exporting them to $GLOBALS.

The default is "wg", so a configuration setting "Example" corresponds to a PHP global $wgExample. Note that choosing a different config prefix can make it more difficult to find the extension setting corresponding to a given global.

ParsoidModules

Versão MediaWiki:
≥ 1.35
Gerrit change 597639

An array of Parsoid extension module specifiers. A Parsoid extension module is a class implementing Wikimedia\Parsoid\Ext\ExtensionModule

There are three ways in which a Parsoid extension module can be specified:

  • A direct reference to the class implementing the ExtensionModule class (which is part of Parsoid-PHP, not MediaWiki core). For an example, see the Kartographer extension.
  • An equivalent ObjectFactory representation in JSON. For an example, see the Cite extension.
  • A Parsoid-specific module specification.


TODO: document


ParserTestFiles

Parser test suite files to be run by parserTests.php when no specific filename is passed to it.

This option corresponds directly with the global variable $wgParserTestFiles . Please refer to the documentation there on how to configure it.


ServiceWiringFiles

Array of filenames of service wiring files to be loaded by the default instance of MediaWikiServices.

This option corresponds directly with the global variable $wgServiceWiringFiles . Please refer to the documentation there on how to configure it.


attributes

Registration information for other extensions. This allows one extension to register things with other extensions. Attribute values must be JSON arrays or objects, and they will be merged together when retrieved in PHP.

In manifest_version 1 these were top level keys that could be arbitrarily named: 

"EventLoggingSchemas": {
    "MySchema": 123
}

In manifest_version 2, these are now under the top level attributes key, and then nested under the extension name that the attribute belongs towards.

The full attribute name is the concatenation of the extension name and attribute name (EventLoggingSchemas in the example below). Each key set directly under attributes must match the extension name (arbitrary top-level attribute keys are not supported). If an extension (EventLogging in this example) is not installed, the attributes won't be loaded into the registry. 

"attributes": {
    "EventLogging": {
        "Schemas": {
            "MySchema": 123
        }
    }
}

To access the value of an attribute in PHP, you can use the ExtensionRegistry: 

$schemas = ExtensionRegistry::getInstance()->getAttribute( 'EventLoggingSchemas' );

load_composer_autoloader

Load the composer autoloader for this extension, if one is present. This should be used if the extension has dependencies on libraries that are specified in composer.json. It is basically equivalent to the following code: 

if ( file_exists( __DIR__ . '/vendor/autoload.php' ) ) {
	require_once __DIR__ . '/vendor/autoload.php';
}
Retrieved from "https://www.mediawiki.org/w/index.php?title=Manual:Extension.json/Schema/pt&oldid=6931682"