Manual:Extension.json/Schema: Difference between revisions

This page documents the schema used by extension.json. All fields are optional unless otherwise specified. It is currently incomplete.

Schema

manifest_version

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.

• 1: 1.25+
• 2: 1.29+

{
    "manifest_version": 1
}

Note: This field is typically placed at the bottom of extension.json files.

name

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.

{
    "name": "FooBar"
}

namemsg

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

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

• api — API extensions
• antispam — antispam extensions
• media — media handlers
• parserhook — extensions that modify, add or replace functionality in the MediaWiki parser
• skin — extensions that modify skins
• specialpage — extensions that add special pages
• variable — make a new variable
• other — does something else

Note: custom types can be added by using the ExtensionTypes hook. If not set, the extension will default to the "other" section.

{
    "type": "specialpage"
}

author

The authors of the extension, may contain wikitext. This can either be a single string, or a list of strings. Additionally, the special string ... may be used to add a generic "and others" suffix using the version-poweredby-others message.

version

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

url

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

description

Description of the extension, may contain wikitext. Note: it is recommended to use descriptionmsg instead.

descriptionmsg

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

license-name

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

requires

The requires section allows you to document dependencies on versions of MediaWiki core and other extensions.

{
    "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.

ResourceFileModulePaths

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

The allowed properties are:

• localBasePath
• remoteExtPath
• 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

ResourceLoader modules to register.

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

ResourceModuleSkinStyles

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

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

ResourceLoader LESS variables.

ConfigRegistry

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

Session providers

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

AuthManagerAutoConfig

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

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

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

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

Method to add extra namespaces.

The following properties are available:

• id: An integer.
• constant: A string.
• name: A string.
• gender: Gender object. Properties are either "male" or "female."
• subpages: Boolean. Default is false.
• content: Boolean. Default is false.
• defaultcontentmodel: A string.
• protection: Userright(s) required to edit in this namespace. An array or string.
• capitallinkoverride: Set $wgCapitalLinks on a per-namespace basis. Boolean.
• conditional: Whether the namespace is conditional upon configuration and should not be registered (requires separate registration via a hook). Boolean. Default is false.

TrackingCategories

Tracking category message keys.

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

DefaultUserOption

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

HiddenPrefs

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

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.

RevokePermissions

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

Rate limis.

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

RecentChangesFlags

Flags (letter symbols) down on RecentChanges pages.

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.

ExtensionMessagesFiles

File paths containing PHP internationalization files.

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

MessageDirs

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.

ExtensionEntryPointListFiles

An object.

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

An object.

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

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.

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

An object.

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

An object.

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

LogHeaders

An object.

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

LogActions

An object.

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

LogActionsHandlers

An object.

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

Actions

An object.

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

APIModules

An object.

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

APIFormatModules

An object.

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

APIMetaModules

An object.

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

APIPropModules

An object.

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

APIListModules

An object.

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

ValidSkinNames

An object.

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

An object.

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.

callback

A function to be called right after MediaWiki processes this file.

config

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, this documentation covers its usage in 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.

Merge strategies

The following merge strategies are available:

• array_merge: Default, does not need to be explicitly set. Any keys that are integers will be re-numbered when merging.
• array_plus: Handles keys with integers properly.
• array_plus_2d: Handles nested arrays to a depth of 2 properly (e.g. $wgGroupPermissions).
• array_plus_recursive: Handles arrays even deeper than 2, though realistically, a configuration setting that is nested more than 2 arrays suggests too many things are being configured in one setting, and splitting it into multiple might be a good idea.
• array_replace_recursive: TODO why should this be used?

config_prefix

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

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

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

load_composer_autoloader

Load the composer autoloader for this extension, if one is present.

See Also

• [extension.schema.v2.json|This page documents the schema used by extension.json. All fields are optional unless otherwise specified. It is currently incomplete.

Schema

manifest_version

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.

• 1: 1.25+
• 2: 1.29+

{
    "manifest_version": 1
}

Note: This field is typically placed at the bottom of extension.json files.

name

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.

{
    "name": "FooBar"
}

namemsg

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

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

• api — API extensions
• antispam — antispam extensions
• media — media handlers
• parserhook — extensions that modify, add or replace functionality in the MediaWiki parser
• skin — extensions that modify skins
• specialpage — extensions that add special pages
• variable — make a new variable
• other — does something else

Note: custom types can be added by using the ExtensionTypes hook. If not set, the extension will default to the "other" section.

{
    "type": "specialpage"
}

author

The authors of the extension, may contain wikitext. This can either be a single string, or a list of strings. Additionally, the special string ... may be used to add a generic "and others" suffix using the version-poweredby-others message.

version

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

url

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

description

Description of the extension, may contain wikitext. Note: it is recommended to use descriptionmsg instead.

descriptionmsg

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

license-name

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

requires

The requires section allows you to document dependencies on versions of MediaWiki core and other extensions.

{
    "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.

ResourceFileModulePaths

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

The allowed properties are:

• localBasePath
• remoteExtPath
• 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

ResourceLoader modules to register.

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

ResourceModuleSkinStyles

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

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

ResourceLoader LESS variables.

ConfigRegistry

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

Session providers

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

AuthManagerAutoConfig

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

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

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

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

Method to add extra namespaces.

The following properties are available:

• id: An integer.
• constant: A string.
• name: A string.
• gender: Gender object. Properties are either "male" or "female."
• subpages: Boolean. Default is false.
• content: Boolean. Default is false.
• defaultcontentmodel: A string.
• protection: Userright(s) required to edit in this namespace. An array or string.
• capitallinkoverride: Set $wgCapitalLinks on a per-namespace basis. Boolean.
• conditional: Whether the namespace is conditional upon configuration and should not be registered (requires separate registration via a hook). Boolean. Default is false.

TrackingCategories

Tracking category message keys.

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

DefaultUserOption

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

HiddenPrefs

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

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.

RevokePermissions

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

Rate limis.

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

RecentChangesFlags

Flags (letter symbols) down on RecentChanges pages.

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.

ExtensionMessagesFiles

File paths containing PHP internationalization files.

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

MessageDirs

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.

ExtensionEntryPointListFiles

An object.

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

An object.

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

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.

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

An object.

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

An object.

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

LogHeaders

An object.

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

LogActions

An object.

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

LogActionsHandlers

An object.

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

Actions

An object.

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

APIModules

An object.

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

APIFormatModules

An object.

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

APIMetaModules

An object.

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

APIPropModules

An object.

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

APIListModules

An object.

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

ValidSkinNames

An object.

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

An object.

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.

callback

A function to be called right after MediaWiki processes this file.

config

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, this documentation covers its usage in 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.

Merge strategies

The following merge strategies are available:

• array_merge: Default, does not need to be explicitly set. Any keys that are integers will be re-numbered when merging.
• array_plus: Handles keys with integers properly.
• array_plus_2d: Handles nested arrays to a depth of 2 properly (e.g. $wgGroupPermissions).
• array_plus_recursive: Handles arrays even deeper than 2, though realistically, a configuration setting that is nested more than 2 arrays suggests too many things are being configured in one setting, and splitting it into multiple might be a good idea.
• array_replace_recursive: TODO why should this be used?

config_prefix

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

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

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

load_composer_autoloader

Load the composer autoloader for this extension, if one is present.

See Also

• extension.schema.v1.json
• extension.schema.v2.json