Manual:Extension.json/Schema

From MediaWiki.org
Jump to navigation Jump to search

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

For the first iteration of this schema see docs/extension.schema.v1.json (MW 1.25+), for the second see docs/extension.schema.v2.json (MW 1.29+).

manifest_version[edit]

MediaWiki version: 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+

Unless you need to use one of the features implemented in v2, there's no reason to upgrade away from v1.

Example:

{
	"manifest_version": 1
}

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

name[edit]

MediaWiki version: 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.

{
	"name": "FooBar"
}

namemsg[edit]

MediaWiki version: 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[edit]

MediaWiki version: 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.

{
	"type": "specialpage"
}

author[edit]

MediaWiki version: 1.25
Gerrit change 166705

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

version[edit]

MediaWiki version: 1.25
Gerrit change 166705

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

url[edit]

MediaWiki version: 1.25
Gerrit change 166705

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

description[edit]

MediaWiki version: 1.25
Gerrit change 166705

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

descriptionmsg[edit]

MediaWiki version: 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[edit]

MediaWiki version: 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[edit]

MediaWiki version: 1.26
Gerrit change 210856
MediaWiki version: 1.29
Gerrit change 250060

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.

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[edit]

MediaWiki version: 1.32
Gerrit change 458940

You can also express a dependency on platform settings, currently limited to PHP version. Note that most extensions are expected to follow the PHP version requirements for the versions of MediaWiki core they support, and this should only be used in exceptional cases.

{
	"requires": {
		"MediaWiki": ">= 1.31.0",
		"platform": {
			"php": ">= 7.1"
		}
	}
}

In this example, the extension requires 1.31 (which had 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.

ResourceFileModulePaths[edit]

MediaWiki version: 1.25
Gerrit change 188996

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[edit]

MediaWiki version: 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.

ResourceModuleSkinStyles[edit]

MediaWiki version: 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[edit]

MediaWiki version: 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[edit]

MediaWiki version: 1.25
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.

ConfigRegistry[edit]

MediaWiki version: 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[edit]

MediaWiki version: 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[edit]

MediaWiki version: 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[edit]

MediaWiki version: 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[edit]

MediaWiki version: 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[edit]

MediaWiki version: 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[edit]

MediaWiki version: 1.25.3
Gerrit change 237973

Method to add extra namespaces.

The following properties are available:

  • id: An 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.
  • constant: A string. The name of the constant that the extension code uses to refer to the namespace ID.
  • name: A string. The name of the namespace, as used in titles.
  • gender: Gender object. Properties are either "male" or "female". See gender support.
  • subpages: Boolean. Default is false.
  • content: Boolean. Default is false.
  • defaultcontentmodel: A string. See ContentHandler.
  • 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[edit]

MediaWiki version: 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[edit]

MediaWiki version: 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[edit]

MediaWiki version: 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[edit]

MediaWiki version: 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.

RevokePermissions[edit]

MediaWiki version: 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[edit]

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[edit]

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[edit]

Implicit groups.

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

GroupsAddToSelf[edit]

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[edit]

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[edit]

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[edit]

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[edit]

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[edit]

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[edit]

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[edit]

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[edit]

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[edit]

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[edit]

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.

MessagesDirs[edit]

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 direcory layout with localized messages in the i18n/ directory, you can specify:

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

ExtensionEntryPointListFiles[edit]

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[edit]

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[edit]

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.

AutoloadNamespaces[edit]

MediaWiki version: 1.31
Gerrit change 373626

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

{
	"AutoloadNamespaces": {
		"MediaWiki\\Linter\\": "includes/"
	}
}

In this case all of the PHP classes are under the MediaWiki\Linter\ namespace, and the naming of the classes directly maps to the files located in the includes/ directory. 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.

Hooks[edit]

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"
		]
	}
}

JobClasses[edit]

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[edit]

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[edit]

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[edit]

An object.

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

ActionFilteredLogs[edit]

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[edit]

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[edit]

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[edit]

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[edit]

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[edit]

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[edit]

API module extensions.

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

APIFormatModules[edit]

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[edit]

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[edit]

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[edit]

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.

ValidSkinNames[edit]

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[edit]

Available feed objects.

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

SkinOOUIThemes[edit]

Map of skin names to OOUI themes to use.

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

PasswordPolicy[edit]

Password policies.

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

FileExtensions[edit]

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[edit]

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.

callback[edit]

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

config[edit]

MediaWiki version: 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, 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.

Changes in manifest version 2[edit]

MediaWiki version: 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 it's 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
}

Merge strategies[edit]

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[edit]

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

ParserTestFiles[edit]

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[edit]

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[edit]

Registration information for other extensions. This allows one extension to register things with other extensions. Attributes must be PHP arrays, either a list (JSON array) or associative (JSON object)

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 attribute name is still EventLoggingSchemas. If that 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[edit]

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';
}