View source for Manual:Extension.json/Schema/ar

<languages/>
{{MW file|extension.schema.v2.json|docs/}}
<span lang="en" dir="ltr" class="mw-content-ltr">This page documents the schema used by [[Manual:Extension registration|extension.json]].</span>
<span lang="en" dir="ltr" class="mw-content-ltr">All fields are optional unless otherwise specified.</span>
حاليا هو غير كامل.

<div lang="en" dir="ltr" class="mw-content-ltr">
For the first iteration of this schema see {{git file |file=docs/extension.schema.v1.json}} (MW 1.25+), for the second see {{git file |file=docs/extension.schema.v2.json}} (MW 1.29+).
</div>

== manifest_version ==
{{MW 1.25|and after|gerrit change=212239}}

'''<span lang="en" dir="ltr" class="mw-content-ltr">This field is required.</span>'''

<span lang="en" dir="ltr" class="mw-content-ltr">This specifies the version of the extension.json file format that is being used.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">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.</span> 

<span lang="en" dir="ltr" class="mw-content-ltr">Currently the following values are supported:</span>
* <code>1</code>: 1.25+
* <code>2</code>: 1.29+

<span lang="en" dir="ltr" class="mw-content-ltr">v2 provides stronger developer validation features, and is recommended if your extension already requires MediaWiki 1.29+.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">It is not recommended to break MediaWiki compatibility with older versions just to upgrade to a newer manifest_version.</span> 

<span lang="en" dir="ltr" class="mw-content-ltr">Currently new features are added to both v1 and v2, but it has been proposed to freeze and soft deprecate v1 in the MediaWiki 1.38 release ([[phab:T258668|discuss on Phabricator]]).</span>

<span lang="en" dir="ltr" class="mw-content-ltr">Example:</span>

<syntaxhighlight lang="json">
{
	"manifest_version": 2
}
</syntaxhighlight>
{{note|1=<span lang="en" dir="ltr" class="mw-content-ltr">This field is typically placed at the bottom of extension.json files.</span>}}

== name ==
{{MW 1.25|and after|gerrit change=166705}}

'''<span lang="en" dir="ltr" class="mw-content-ltr">This field is required.</span>'''

<span lang="en" dir="ltr" class="mw-content-ltr">This is the extension's canonical name.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">It should not be changed once set, as it is used as an API for other extensions to detect what is installed.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">The <code>name</code> field does ''not'' have to match an extension's directory name nor the name of its page in the Extension namespace on MediaWiki.org.</span>

<syntaxhighlight lang="json">
{
	"name": "FooBar"
}
</syntaxhighlight>

== namemsg ==
{{MW 1.25|and after|gerrit change=166705}}

<span lang="en" dir="ltr" class="mw-content-ltr">A localized version of the extension's name.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">Typically the message key is named in the format &lt;name>-extensionname or &lt;name>-skinname.</span>

<syntaxhighlight lang="json">
{
	"namemsg": "foobar-extensionname"
}
</syntaxhighlight>

== type ==
{{MW 1.25|and after|gerrit change=166705}}

<span lang="en" dir="ltr" class="mw-content-ltr">The type of extension it is, for sorting on Special:Version.</span> <span lang="en" dir="ltr" class="mw-content-ltr">The following types are supported:</span>
* <code>api</code> &mdash; <span lang="en" dir="ltr" class="mw-content-ltr">[[Special:MyLanguage/API:Extensions|API extensions]]</span>
* <code>antispam</code> &mdash; <span lang="en" dir="ltr" class="mw-content-ltr">[[Special:MyLanguage/Category:Spam management extensions|antispam]] extensions</span>
* <code>editor</code> &mdash; <span lang="en" dir="ltr" class="mw-content-ltr">extensions for editing content (since 1.31, {{git|8de958444f1d36ecb95d3a53d96cc1404e95468e}})</span>
* <code>media</code> &mdash; <span lang="en" dir="ltr" class="mw-content-ltr">[[Special:MyLanguage/Category:Media handling extensions|media handlers]]</span>
* <code>parserhook</code> &mdash; <span lang="en" dir="ltr" class="mw-content-ltr">extensions that modify, add or replace functionality in the MediaWiki [[Special:MyLanguage/Category:Parser extensions|parser]]</span>
* <code>skin</code> &mdash; <span lang="en" dir="ltr" class="mw-content-ltr">extensions that modify [[Special:MyLanguage/Manual:Skins|skins]]</span>
* <code>specialpage</code> &mdash; <span lang="en" dir="ltr" class="mw-content-ltr">extensions that add [[Special:MyLanguage/Manual:Special pages|special pages]]</span>
* <code>variable</code> &mdash; <span lang="en" dir="ltr" class="mw-content-ltr">make a new [[Special:MyLanguage/Manual:Variables|variable]]</span>
* <code>other</code> &mdash; <span lang="en" dir="ltr" class="mw-content-ltr">does something else</span>

<span lang="en" dir="ltr" class="mw-content-ltr">Custom types can be added by using the {{Hook|ExtensionTypes}} hook.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Known ones include:</span>
* <code>semantic</code> &mdash; <span lang="en" dir="ltr" class="mw-content-ltr">[[Special:MyLanguage/Category:Semantic MediaWiki extensions|Semantic MediaWiki]] extensions</span>
* <code>wikibase</code> &mdash; <span lang="en" dir="ltr" class="mw-content-ltr">[[Special:MyLanguage/Category:Wikibase extensions|Wikibase extensions]]</span>
<span lang="en" dir="ltr" class="mw-content-ltr">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.</span>

<syntaxhighlight lang="json">
{
	"type": "specialpage"
}
</syntaxhighlight>

== author ==
{{MW 1.25|and after|gerrit change=166705}}
<span lang="en" dir="ltr" class="mw-content-ltr">The authors of the extension, may contain wikitext.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">This can either be a single string, or an array of strings.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">Additionally, the special string <code>...</code> may be used to add a generic "{{int|version-poweredby-others}}" suffix using the <code>version-poweredby-others</code> message.</span>

== version ==
{{MW 1.25|and after|gerrit change=166705}}

<span lang="en" dir="ltr" class="mw-content-ltr">The current version of the extension.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Should be in a format supported by [https://getcomposer.org/doc/articles/versions.md Composer].</span>

== url ==
{{MW 1.25|and after|gerrit change=166705}}

<span lang="en" dir="ltr" class="mw-content-ltr">URL to the extension's "homepage" or documentation.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Typically points to <code><nowiki>https://www.mediawiki.org/wiki/Extension</nowiki>:&lt;extensionname></code>.</span>

== description ==
{{MW 1.25|and after|gerrit change=166705}}

<span lang="en" dir="ltr" class="mw-content-ltr">Description of the extension, may contain wikitext.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">{{note}} It is recommended to use descriptionmsg instead.</span>

== descriptionmsg ==
{{MW 1.25|and after|gerrit change=166705}}

<span lang="en" dir="ltr" class="mw-content-ltr">Localization message key for the extension's description, typically in the format &lt;extensionname>-desc.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">This will override description.</span>

== license-name ==
{{MW 1.25|and after|gerrit change=166705}}
<span lang="en" dir="ltr" class="mw-content-ltr">The [https://spdx.org/licenses/ SPDX license identifier] for the license the source code is licensed as.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">If you create a file named <code>COPYING</code> or <code>LICENSE</code> (with an optional <code>.txt</code> extension) in the extension root directory with the contents of the license, it will also be linked and visible from Special:Version.</span>

== requires ==
{{MW 1.26|and after|gerrit change=210856}}
{{MW 1.29|and after|gerrit change=250060}}

<span lang="en" dir="ltr" class="mw-content-ltr">The requires section allows you to document dependencies on versions of MediaWiki core (1.26+) and other extensions (1.29+).</span>

<syntaxhighlight lang="json">
{
	"requires": {
		"MediaWiki": ">= 1.27.0",
		"extensions": {
			"FooBar": "*",
			"Baz": ">= 1.2.3"
		}
	}
}
</syntaxhighlight>

<span lang="en" dir="ltr" class="mw-content-ltr">You can use any version specifier that [https://getcomposer.org/doc/articles/versions.md composer supports].</span> 
<span lang="en" dir="ltr" class="mw-content-ltr">For MediaWiki, it is best practice to specify a >= for the minimum supported version, unless you know a future version is explicitly broken.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">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.</span>

<span lang="en" dir="ltr" class="mw-content-ltr">If your extension uses Wikimedia [[Special:MyLanguage/Continuous integration|Continuous integration]], you also need to add extension dependencies to {{git file|project=integration/config|file=zuul/parameter_functions.py}} in the <code>integration/config</code> project.</span>

=== platform ===
{{MW 1.32|and after|gerrit change=458940}}
{{MW 1.32|and after|gerrit change=462596}}

<span lang="en" dir="ltr" class="mw-content-ltr">You can also express a dependency on platform settings, currently limited to PHP version and PHP extensions.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">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.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">Checking for PHP extension versions isn't supported right now.</span>

<syntaxhighlight lang="json">
{
	"requires": {
		"MediaWiki": ">= 1.32.0",
		"platform": {
			"php": ">= 7.1",
			"ext-curl": "*"
		}
	}
}
</syntaxhighlight>

<span lang="en" dir="ltr" class="mw-content-ltr">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.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">Furthermore, it required the curl PHP extension to be installed.</span>

== suggests ==
{{MW 1.39|and after|gerrit change=591897}}

<span lang="en" dir="ltr" class="mw-content-ltr">Allows listing suggested but not required dependencies.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">The format is identical to <code>[[#requires|requires]]</code>.</span>

== ResourceFileModulePaths ==
{{MW 1.25|and after|gerrit change=188996}}
<span lang="en" dir="ltr" class="mw-content-ltr">Specifies the default paths to use for all ResourceLoader file modules.</span>

<span lang="en" dir="ltr" class="mw-content-ltr">The allowed properties are:</span>
* <code>localBasePath</code>
* <code>remoteExtPath</code> (must not point to other extension folders)
* <code>remoteSkinPath</code>

<span lang="en" dir="ltr" class="mw-content-ltr">These correspond to the same options in each module definition in <code>ResourceModules</code>.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">If a value is not specified in the module definition, the default value specified here will be used.</span> 
<syntaxhighlight lang="json">
{
	"ResourceFileModulePaths": {
		"localBasePath": "resources",
		"remoteExtPath": "FooBar/resources"
	}
}
</syntaxhighlight>

== ResourceModules ==
{{MW 1.25|and after|gerrit change=166705}}
{{see global|ResourceModules|desc=<span lang="en" dir="ltr" class="mw-content-ltr">ResourceLoader modules to register.</span>}}

== ResourceModuleSkinStyles ==
{{MW 1.25|and after|gerrit change=201661}}
{{see global|ResourceModuleSkinStyles|desc=<span lang="en" dir="ltr" class="mw-content-ltr">ResourceLoader modules for custom skin styles.</span>}}

== ResourceLoaderSources ==
{{MW 1.25|and after|gerrit change=166705}}
{{see global|ResourceLoaderSources|desc=<span lang="en" dir="ltr" class="mw-content-ltr">ResourceLoader sources to register.</span>}}

== ResourceLoaderLESSVars ==
{{MW version|version=1.25|version2=1.30|gerrit change=166705}}
{{see global|ResourceLoaderLESSVars|desc=<span lang="en" dir="ltr" class="mw-content-ltr">An associative array binding variable names to [[Special:MyLanguage/LESS|LESS]] code snippets representing their values.</span>}}

== SkinLessImportPaths ==
{{MW 1.36|and after|gerrit change=434211}}
<span lang="en" dir="ltr" class="mw-content-ltr">Path to the skin-specific LESS import directory, keyed by skin name.</span> 
<span lang="en" dir="ltr" class="mw-content-ltr">Can be used to define skin-specific LESS variables.</span>

== QUnitTestModule ==
{{MW 1.33|and after|gerrit change=485247}}
<span lang="en" dir="ltr" class="mw-content-ltr">A ResourceLoader file module, to loaded when running [[Special:MyLanguage/Manual:JavaScript unit testing|JavaScript unit tests]].</span>
<span lang="en" dir="ltr" class="mw-content-ltr">This follows the same syntax as [[#ResourceModules|ResourceModules]].</span>

<span lang="en" dir="ltr" class="mw-content-ltr">Internally, when {{wg|EnableJavaScriptTest}} is <code>true</code>, this module is automatically registered under the name "<code>test.<var>ExtensionName</var></code>".</span>

== MessagePosterModule ==
{{MW 1.35|and after|gerrit change=542655}}
<span lang="en" dir="ltr" class="mw-content-ltr">Allows extensions to add additional files or dependencies to the <code>mediawiki.messagePoster</code> module bundle.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">This follows the same syntax as [[#ResourceModules|ResourceModules]].</span>

== ConfigRegistry ==
{{MW 1.25|and after|gerrit change=166705}}
{{see global|ConfigRegistry|desc=<span lang="en" dir="ltr" class="mw-content-ltr">Registry of factory functions to create Config objects.</span>}}

== SessionProviders ==
{{MW 1.27|and after|gerrit change=288324}}
{{see global|SessionProviders|desc=<span lang="en" dir="ltr" class="mw-content-ltr">Specifies what providers to use for {{manual|SessionManager and AuthManager|SessionManager}}.</span>}}

== AuthManagerAutoConfig ==
{{MW 1.27|and after|gerrit change=195297}}
{{see global|AuthManagerAutoConfig|desc=<span lang="en" dir="ltr" class="mw-content-ltr">AuthManager auto-configuration.</span>}}

<span lang="en" dir="ltr" class="mw-content-ltr">The following properties are available:</span>
* <code>preauth</code> &mdash; <span lang="en" dir="ltr" class="mw-content-ltr">Pre-authentication providers.</span>
* <code>primaryauth</code> &mdash; <span lang="en" dir="ltr" class="mw-content-ltr">Primary authentication providers.</span>
* <code>secondaryauth</code> &mdash; <span lang="en" dir="ltr" class="mw-content-ltr">Secondary authentication providers.</span>

== CentralIdLookupProviders ==
{{MW 1.27|and after|gerrit change=261909}}
{{see global|CentralIdLookupProviders|desc=<span lang="en" dir="ltr" class="mw-content-ltr">Central ID lookup providers.</span>}}

== ChangeCredentialsBlacklist ==
{{MW 1.28|and after|gerrit change=294859}}
{{see global|ChangeCredentialsBlacklist|desc=<span lang="en" dir="ltr" class="mw-content-ltr">AuthenticationRequest classes which can only be used internally for credential change.</span>}}

== RemoveCredentialsBlacklist ==
{{MW 1.28|and after|gerrit change=294859}}
{{see global|RemoveCredentialsBlacklist|desc=<span lang="en" dir="ltr" class="mw-content-ltr">AuthenticationRequest classes which can only be used internally for credential removal.</span>}}

== namespaces ==
{{MW version|version=1.25.3|comment=and after|gerrit change=237973}}
<span lang="en" dir="ltr" class="mw-content-ltr">Method to add {{ll|Manual:Using custom namespaces#In extensions|extra namespaces}}.</span>

<span lang="en" dir="ltr" class="mw-content-ltr">The following properties are available:</span>

* <code>id</code> &mdash; <span lang="en" dir="ltr" class="mw-content-ltr">An integer.</span> <span lang="en" dir="ltr" class="mw-content-ltr">The numeric identifier of the namespace, as used in the database.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Since MW 1.30, the namespace ID can be overwritten locally, by defining the respective constant in LocalSettings.php before loading the extension.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Extension code must therefore always use the constant for the namespace ID, and never use the ID as a literal in PHP code.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Consider listing your id number used at [[Extension default namespaces]] to avoid conflicts with other extensions.</span>
* <code>constant</code> &mdash; <span lang="en" dir="ltr" class="mw-content-ltr">A string.</span> <span lang="en" dir="ltr" class="mw-content-ltr">The name of the constant that the extension code uses to refer to the namespace ID.</span> 
* <code>name</code> &mdash; <span lang="en" dir="ltr" class="mw-content-ltr">A string. The name of the namespace, as used in titles.</span>
* <code>gender</code> &mdash; <span lang="en" dir="ltr" class="mw-content-ltr">Gender object.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Properties are either "male" or "female".</span> <span lang="en" dir="ltr" class="mw-content-ltr">See ''[[translatewiki:Gender#Gender_in_languages|gender support]]''.</span> 
* <code>subpages</code> &mdash; <span lang="en" dir="ltr" class="mw-content-ltr">Boolean.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Default is <code>false</code>.</span> <span lang="en" dir="ltr" class="mw-content-ltr">See ''{{ll|Manual:$wgNamespacesWithSubpages}}''.</span>
* <code>content</code> &mdash; <span lang="en" dir="ltr" class="mw-content-ltr">Boolean.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Default is <code>false</code>.</span> <span lang="en" dir="ltr" class="mw-content-ltr">See ''{{ll|Manual:$wgContentNamespaces}}''.</span>
* <code>defaultcontentmodel</code> &mdash; <span lang="en" dir="ltr" class="mw-content-ltr">A string.</span> <span lang="en" dir="ltr" class="mw-content-ltr">See ''{{ll|Manual:ContentHandler|ContentHandler}}''.</span>
* <code>protection</code> &mdash; <span lang="en" dir="ltr" class="mw-content-ltr">Userright(s) required to edit in this namespace.</span> <span lang="en" dir="ltr" class="mw-content-ltr">An array or string.</span>
* <code>capitallinkoverride</code> &mdash; <span lang="en" dir="ltr" class="mw-content-ltr">Set $wgCapitalLinks on a per-namespace basis.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Boolean.</span>
* <code>conditional</code> &mdash; <span lang="en" dir="ltr" class="mw-content-ltr">Whether the namespace is conditional upon configuration and should not be registered (requires separate registration via a hook such as {{ll|Manual:Hooks/CanonicalNamespaces|CanonicalNamespaces}}).</span> <span lang="en" dir="ltr" class="mw-content-ltr">Boolean.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Default is <code>false</code>.</span>
* <code>movable</code> &mdash; <span lang="en" dir="ltr" class="mw-content-ltr">Whether it is possible to move pages in this namespace.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Boolean.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Default is <code>true</code>.</span> {{MW version-inline|MW 1.35.2+}}

== TrackingCategories ==
{{MW 1.25|and after|gerrit change=166705}}
{{see global|TrackingCategories|desc=<span lang="en" dir="ltr" class="mw-content-ltr">Tracking category message keys.</span>}}

== DefaultUserOptions ==
{{MW 1.25|and after|gerrit change=166705}}
{{see global|DefaultUserOptions|desc=}}
<syntaxhighlight lang="json">
	"DefaultUserOptions": {
		"math": "png"
	},
</syntaxhighlight>

== HiddenPrefs ==
{{MW 1.25|and after|gerrit change=166705}}
{{see global|HiddenPrefs|desc=<span lang="en" dir="ltr" class="mw-content-ltr">Preferences users cannot set.</span>}}

== GroupPermissions ==
{{MW 1.25|and after|gerrit change=166705}}
{{see global|GroupPermissions|desc=<span lang="en" dir="ltr" class="mw-content-ltr">Default permissions to give to user groups.</span>}}

== PrivilegedGroups ==
{{MW 1.41|and after|gerrit change=954742}}
{{see global|PrivilegedGroups|desc=<span lang="en" dir="ltr" class="mw-content-ltr">User groups that should be considered privileged.</span>}}

== RevokePermissions ==
{{MW 1.25|and after|gerrit change=166705}}
{{see global|RevokePermissions|desc=<span lang="en" dir="ltr" class="mw-content-ltr">Default permissions to revoke from user groups.</span>}}

== GrantPermissions ==
{{see global|GrantPermissions|desc=<span lang="en" dir="ltr" class="mw-content-ltr">Map of permissions granted to authorized consumers to their bundles, called 'grants.'</span>}}

== GrantPermissionGroups ==
{{see global|GrantPermissionGroups|desc=<span lang="en" dir="ltr" class="mw-content-ltr">Map of grants to their UI grouping.</span>}}

== ImplicitGroups ==
{{see global|ImplicitGroups|desc=<span lang="en" dir="ltr" class="mw-content-ltr">Implicit groups.</span>}}

== GroupsAddToSelf ==
{{see global|GroupsAddToSelf|desc=<span lang="en" dir="ltr" class="mw-content-ltr">Groups a user can add to themselves.</span>}}

== GroupsRemoveFromSelf ==
{{see global|GroupsRemoveFromSelf|desc=<span lang="en" dir="ltr" class="mw-content-ltr">Groups a user can remove from themselves.</span>}}

== AddGroups ==
{{see global|AddGroups|desc=<span lang="en" dir="ltr" class="mw-content-ltr">Groups a user can add to users.</span>}}

== RemoveGroups ==
{{see global|RemoveGroups|desc=<span lang="en" dir="ltr" class="mw-content-ltr">Groups a user can remove from users.</span>}}

== AvailableRights ==
{{see global|AvailableRights|desc=<span lang="en" dir="ltr" class="mw-content-ltr">User rights added by the extension.</span>}}

== ContentHandlers ==
{{see global|ContentHandlers|desc=<span lang="en" dir="ltr" class="mw-content-ltr">Mapping of Model ID to class name.</span>}}

== RateLimits ==
{{see global|RateLimits|desc=<span lang="en" dir="ltr" class="mw-content-ltr">Simple rate limiter options to brake edit floods.</span>}}

== RecentChangesFlags ==
{{see global|RecentChangesFlags|desc=<span lang="en" dir="ltr" class="mw-content-ltr">Flags (letter symbols) shown in recent changes and watchlist to indicate certain types of edits.</span>}}

== MediaHandlers ==
{{see global|MediaHandlers|desc=<span lang="en" dir="ltr" class="mw-content-ltr">Plugins for media file type handling. Each entry in the array map maps a MIME type to a PHP class name.</span>}}

== ExtensionFunctions ==
{{see global|ExtensionFunctions|desc=<span lang="en" dir="ltr" class="mw-content-ltr">Function to call after setup has finished.</span>}}

<span lang="en" dir="ltr" class="mw-content-ltr">Note that extension functions cannot be used to programmatically update configuration variables or register hooks.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">For that purpose, a [[#callback|registration callback]] should be used instead.</span>

== ExtensionMessagesFiles ==
{{see global|ExtensionMessagesFiles|desc=<span lang="en" dir="ltr" class="mw-content-ltr">File paths containing PHP internationalization files.</span>}}

== MessagesDirs ==
{{see global|MessagesDirs|desc=<span lang="en" dir="ltr" class="mw-content-ltr">Directory paths containing JSON internationalization data.</span>}}

<span lang="en" dir="ltr" class="mw-content-ltr">If you use the default directory layout with [[Special:MyLanguage/Localization|localized messages]] in the <code>i18n/</code> directory, you can specify:</span>
<syntaxhighlight lang="json">
"MessagesDirs": {
	"ExtensionName": [
		"i18n"
	]
},
</syntaxhighlight>

== ExtensionEntryPointListFiles ==
{{see global|ExtensionEntryPointListFiles|desc=<span lang="en" dir="ltr" class="mw-content-ltr">Array of files with list(s) of extension entry points to be used in {{manual|MergeMessageFileList.php|maintenance/mergeMessageFileList.php}}</span>}}

== SpecialPages ==
{{see global|SpecialPages|desc=<span lang="en" dir="ltr" class="mw-content-ltr">SpecialPages implemented in this extension (mapping of page name to class name).</span>}}

== AutoloadClasses ==
{{see global|AutoloadClasses|desc=<span lang="en" dir="ltr" class="mw-content-ltr">Array mapping class names to filenames, for autoloading.</span>}}
<span lang="en" dir="ltr" class="mw-content-ltr">Example:</span>
<syntaxhighlight lang="json">
{
    ...
    "AutoloadClasses": {
        "MyClassName": "includes/FileContainingMyClassName.php",
        "SomeNamespace\\SpecialHelloWorld": "specials/SpecialHelloWorld.php"
    },
    ...
}
</syntaxhighlight>

== AutoloadNamespaces ==
{{MW 1.31|and after|gerrit change=373626}}
<span lang="en" dir="ltr" class="mw-content-ltr">Array containing mapping of namespaces to directories in a [http://www.php-fig.org/psr/psr-4/ PSR-4] compatible manner.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">Here's an example:</span>
<syntaxhighlight lang="json">
{
	"AutoloadNamespaces": {
		"MediaWiki\\Extension\\BetaFeatures\\": "includes/"
	}
}
</syntaxhighlight>

<span lang="en" dir="ltr" class="mw-content-ltr">In this case all of the PHP classes are under the <code>MediaWiki\Extension\BetaFeatures\</code> namespace, and the naming of the classes directly maps to the files located in the <code>includes/</code> directory (relative to the extension.json file).</span>
<span lang="en" dir="ltr" class="mw-content-ltr">Note that the namespace portion must end with <code>\\</code>.</span>

<span lang="en" dir="ltr" class="mw-content-ltr">Extensions using this feature should require at least MediaWiki 1.31 in <code>extension.json</code> file:</span>

<syntaxhighlight lang="json">
{
	"requires": {
		"MediaWiki": ">= 1.31.0"
	},
}
</syntaxhighlight>

<span lang="en" dir="ltr" class="mw-content-ltr">For example, see Gerrit change [[gerrit:468385|468385]].</span>

== TestAutoloadClasses and TestAutoloadNamespaces ==
{{MW 1.35|and after|gerrit change=556181}}
<span lang="en" dir="ltr" class="mw-content-ltr">Both are the same as [[#AutoloadClasses|AutoloadClasses]] and [[#AutoloadNamespaces|AutoloadNamespaces]], except that they are only used when running tests.</span>

<span lang="en" dir="ltr" class="mw-content-ltr">For example, see Gerrit change [[gerrit:556240|556240]].</span>

== Hooks ==
{{see global|Hooks|desc=<span lang="en" dir="ltr" class="mw-content-ltr">Hooks this extension uses (mapping of hook name to callback).</span>}}

<syntaxhighlight lang="json">
{
	"Hooks": {
		"ParserFirstCallInit": "MassMessageHooks::onParserFirstCallInit"
	}
}
</syntaxhighlight>

<span lang="en" dir="ltr" class="mw-content-ltr">It's possible to register multiple callbacks for the same hook event:</span>
<syntaxhighlight lang="json">
{
	"Hooks": {
		"ParserFirstCallInit": [
			"MassMessageHooks::onParserFirstCallInitOne",
			"MassMessageHooks::onParserFirstCallInitTwo"
		]
	}
}
</syntaxhighlight>

== HookHandlers ==
{{MW 1.35|and after|gerrit change=596914}}
<span lang="en" dir="ltr" class="mw-content-ltr">[[Special:MyLanguage/ObjectFactory|ObjectFactory]] specifications for new-style hook handlers.</span>

<syntaxhighlight lang="json">
{
    "Hooks": {
        "BeforePageDisplay": "main"
    },
    "HookHandlers": {
        "main": {
            "class": "MediaWiki\\Extension\\MyExtension\\HookHandler",
            "services": [ "UserNameUtils" ]
        }
    }
}
</syntaxhighlight>

<span lang="en" dir="ltr" class="mw-content-ltr">There is a difference with the previous approach in that:</span> 
* <span lang="en" dir="ltr" class="mw-content-ltr">Your HookHandler must import the hooks with the <code>use</code> keyword.</span>
* <span lang="en" dir="ltr" class="mw-content-ltr">The HookHandler class must also <code>implement</code> them.</span> 
* <span lang="en" dir="ltr" class="mw-content-ltr">The functions using those hooks in your HookHandler class cannot be called statically, i.e. are dynamic rather than static.</span>

== DeprecatedHooks ==
{{MW 1.35|and after|gerrit change=596914}}
<span lang="en" dir="ltr" class="mw-content-ltr">Deprecated hooks (see [[Special:MyLanguage/Stable interface policy|Stable interface policy]]).</span>
<span lang="en" dir="ltr" class="mw-content-ltr">Maps hook name to an array with <code>deprecatedVersion</code> (MediaWiki version) and <code>component</code> (optional, usually omitted).</span>

== JobClasses ==
{{see global|JobClasses|desc=<span lang="en" dir="ltr" class="mw-content-ltr">Job types this extension implements (mapping of job types to class name).</span>}}

== LogTypes ==
{{see global|LogTypes|desc=<span lang="en" dir="ltr" class="mw-content-ltr">List of new log types this extension uses.</span>}}

== LogRestrictions ==
{{see global|LogRestrictions|desc=<span lang="en" dir="ltr" class="mw-content-ltr">Restricts log access to those who have a certain right.</span>}}

== FilterLogTypes ==
{{see global|FilterLogTypes|desc=<span lang="en" dir="ltr" class="mw-content-ltr">An object.</span>}}

== ActionFilteredLogs ==
{{see global|ActionFilteredLogs|desc=<span lang="en" dir="ltr" class="mw-content-ltr">List of log types which can be filtered by log actions.</span>}}

== LogNames ==
{{see global|LogNames|desc=<span lang="en" dir="ltr" class="mw-content-ltr">Lists the message key string for each log type.</span>}}

== LogHeaders ==
{{see global|LogHeaders|desc=<span lang="en" dir="ltr" class="mw-content-ltr">Lists the message key string for descriptive text to be shown at the top of each log type.</span>}}

== LogActions ==
{{see global|LogActions|desc=<span lang="en" dir="ltr" class="mw-content-ltr">Lists the message key string for formatting individual events of each type and action when listed in the logs.</span>}}

== LogActionsHandlers ==
{{see global|LogActionsHandlers|desc=<span lang="en" dir="ltr" class="mw-content-ltr">Same as {{wg|LogActions}}, but values are functions callbacks.</span>}}

== Actions ==
{{see global|Actions|desc=<span lang="en" dir="ltr" class="mw-content-ltr">Array of allowed values for the "action" parameter for normal pages.</span>}}

== APIModules ==
{{see global|APIModules|desc=<span lang="en" dir="ltr" class="mw-content-ltr">API module extensions.</span>}}

== APIFormatModules ==
{{see global|APIFormatModules|desc=<span lang="en" dir="ltr" class="mw-content-ltr">API format module extensions.</span>}}

== APIMetaModules ==
{{see global|APIMetaModules|desc=<span lang="en" dir="ltr" class="mw-content-ltr">API Query meta module extensions.</span>}}

== APIPropModules ==
{{see global|APIPropModules|desc=<span lang="en" dir="ltr" class="mw-content-ltr">API Query prop module extensions.</span>}}

== APIListModules ==
{{see global|APIListModules|desc=<span lang="en" dir="ltr" class="mw-content-ltr">API Query list module extensions.</span>}}

== RestRoutes ==
{{MW 1.35|and after|gerrit change=508972}}
<span lang="en" dir="ltr" class="mw-content-ltr">List of route specifications to be added to the REST API.</span> <span lang="en" dir="ltr" class="mw-content-ltr">See [[API:REST API/Extensions]].</span>

== ValidSkinNames ==
{{see global|ValidSkinNames|desc=<span lang="en" dir="ltr" class="mw-content-ltr">List of valid skin names.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Skins can optionally use this variable to tell MediaWiki that they are available.</span>}}

== FeedClasses ==
{{see global|FeedClasses|desc=<span lang="en" dir="ltr" class="mw-content-ltr">Available feed objects.</span>}}

== SkinOOUIThemes ==
<span lang="en" dir="ltr" class="mw-content-ltr">Map of skin names to OOUI themes to use.</span>

<syntaxhighlight lang="json">
{
	"SkinOOUIThemes": {
		"yourskinname": "Apex"
	}
}
</syntaxhighlight>

== OOUIThemePaths ==
<span lang="en" dir="ltr" class="mw-content-ltr">Map of custom OOUI theme names to paths to load them from.</span>
<syntaxhighlight lang="json">
{
	"OOUIThemePaths": {
		"YourTheme": {
			"scripts": "resources/ooui/oojs-ui-yourtheme.js",
			"styles": "resources/ooui/oojs-ui-{module}-yourtheme.css",
			"images": "resources/ooui/{module}.json"
		}
	},
}
</syntaxhighlight>

; scripts 
: <span lang="en" dir="ltr" class="mw-content-ltr">Path to script file.</span>
; styles 
: <span lang="en" dir="ltr" class="mw-content-ltr">Path to style files.</span> <span lang="en" dir="ltr" class="mw-content-ltr"><code>{module}</code> will be replaced with the module's name.</span>
; images 
: <span lang="en" dir="ltr" class="mw-content-ltr">Path to image definition files.</span> <span lang="en" dir="ltr" class="mw-content-ltr"><code>{module}</code> will be replaced with the module's name.</span> <span lang="en" dir="ltr" class="mw-content-ltr">If the files don't exist, default theme's images will be used instead.</span>

== PasswordPolicy ==
{{see global|PasswordPolicy|desc=<span lang="en" dir="ltr" class="mw-content-ltr">Password policies.</span>}}

== FileExtensions ==
{{see global|FileExtensions|desc=<span lang="en" dir="ltr" class="mw-content-ltr">Preferred file extensions for uploading.</span>}}

== RawHtmlMessages ==
{{see global|RawHtmlMessages|desc=<span lang="en" dir="ltr" class="mw-content-ltr">List of messages which might contain raw HTML.</span>}}

== LateJSConfigVarNames ==
<span lang="en" dir="ltr" class="mw-content-ltr">Names of JS config vars (as used in {{hook|MakeGlobalVariablesScript}} hook or in {{method doclink|class=ParserOutput|method=ParserOutput::setJsConfigVar|anchor=a7469683b97acf01a04acd9e61cbf3c18}}) that may be set from the end of the HTML body instead of the HTML head, to improve page load time.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">In JavaScript, these variables should be accessed via <syntaxhighlight lang="javascript" inline>mw.hook( 'wikipage.content' )</syntaxhighlight>.</span>

== DatabaseVirtualDomains ==
<span lang="en" dir="ltr" class="mw-content-ltr">Names of virtual domains that are used to get a db connection.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">See {{wg|VirtualDomainsMapping}}.</span>

== ReauthenticateTime ==
{{see global|ReauthenticateTime|desc=<span lang="en" dir="ltr" class="mw-content-ltr">Time frame for re-authentication.</span>}}

== ForeignResourcesDir ==
{{MW 1.41|and after|gerrit change=911307}}
<span lang="en" dir="ltr" class="mw-content-ltr">Directory containing the extension's [[Special:Mylanguage/Foreign resources|foreign resources]] (and the <code>foreign-resources.yaml</code> file defining them). Should be given relative to the extension root.</span>

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

<syntaxhighlight lang="json">
{
	"callback": "FooBarHooks::onRegistration"
}
</syntaxhighlight>

<span lang="en" dir="ltr" class="mw-content-ltr">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 version-inline|MW 1.40+}}.</span>

<span lang="en" dir="ltr" class="mw-content-ltr">The callback isn't a normal hook function, it runs in early initialization.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">See [[Special:MyLanguage/Manual:Extension registration/Limitations|Manual:Extension registration/Limitations]] for what sort of things may require custom registration.</span>

<span lang="en" dir="ltr" class="mw-content-ltr">Registration callbacks are the preferred way for extensions to dynamically set configuration.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">This should be done through the <code>SettingsBuilder</code> object passed to callback, using the <code>getConfig()</code> and <code>overrideConfigValue()</code> methods.</span>

<span lang="en" dir="ltr" class="mw-content-ltr">Registration callbacks do not have access to service objects via <code>MediaWikiServices</code>, and cannot make use of the main <code>RequestContext</code>.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">Neither has been initialized at the time the callback is executed.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">Extensions that need to access the request context or interact with a service object during initialization should register an [[#ExtensionFunctions|ExtensionFunction]] instead.</span>

== config ==
{{MW 1.25|and after}}

<span lang="en" dir="ltr" class="mw-content-ltr">The config section is where you can define configuration settings that sysadmins can change to configure the extension.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">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 [[Special:MyLanguage/Manual:Extension registration#Attributes|attributes]], or if it is just class metadata, use a private static variable or something like that.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">The format of config changed in [[#Changes in manifest version 2|manifest_version 2]].</span>

=== Manifest version 1 ===
<span lang="en" dir="ltr" class="mw-content-ltr">A simple example:</span>

<syntaxhighlight lang="json">
{
    "config": {
        "FooBarUseExtraFeature": false
    }
}
</syntaxhighlight>

<span lang="en" dir="ltr" class="mw-content-ltr">This is equivalent to writing <syntaxhighlight lang="php" inline>$wgFooBarUseExtraFeature = false;</syntaxhighlight> in PHP.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">Note that the typical [[Special:MyLanguage/Manual:Wg variable|"wg" prefix]] is not included, as that will be added by default.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">If your settings start with a different prefix like <code>$eg</code>, you can use the magic <code>_prefix</code> key:</span>

<syntaxhighlight lang="json">
{
	"config": {
		"_prefix": "eg",
		"FooBarUseExtraFeature": false
	}
}
</syntaxhighlight>

<span lang="en" dir="ltr" class="mw-content-ltr">This is now equivalent to writing <syntaxhighlight lang="php" inline>$egFooBarUseExtraFeature = false;</syntaxhighlight> in PHP.</span>

<span lang="en" dir="ltr" class="mw-content-ltr">A more complex example:</span>

<syntaxhighlight lang="json">
{
	"config": {
		"FooBarEnabledNamespaces": {
			"0": true,
			"2": true,
			"4": true,
			"_merge_strategy": "array_plus"
		},
		"FooBarCoolStuff": {
			"sysop": {
				"foo": true,
				"bar": false
			},
			"_merge_strategy": "array_plus_2d"
		}
	}
}
</syntaxhighlight>

<span lang="en" dir="ltr" class="mw-content-ltr">The first setting, <syntaxhighlight lang="php" inline>$wgFooBarEnabledNamespaces</syntaxhighlight>, has keys that are numbers, so PHP will turn them into integers, even though they are strings in JSON.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">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.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">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 <syntaxhighlight lang="php" inline>$wgFooBarCoolStuff['user']['foo'] = true;</syntaxhighlight> in their LocalSettings.php.</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
=== Changes in manifest version 2 ===
</div>
{{MW 1.29|and after}}
<span lang="en" dir="ltr" class="mw-content-ltr">With MediaWiki 1.29, a new manifest_version (2) was introduced.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">In this version, the config section is improved in several ways.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">To support these changes, the signature of a set of configuration option and configuration value changed a bit.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">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.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">You can find information about what the specific keys and values for a configuration option are on the [[Special:MyLanguage/Manual:Extension registration#Configs (Your extension/skins settings)|extension registration documentation page]].</span>
<span lang="en" dir="ltr" class="mw-content-ltr">An easy example of the new schema, which simply is one configuration option and its value, would look like:</span>

<syntaxhighlight lang="json">
{
	"config": {
		"FooBarUseExtraFeature": {
			"value": false
		}
	},
	"manifest_version": 2
}
</syntaxhighlight>

<span lang="en" dir="ltr" class="mw-content-ltr">A more complex one would look like:</span>
<syntaxhighlight lang="json">
{
	"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
}
</syntaxhighlight>
{{Note
 |1=<span lang="en" dir="ltr" class="mw-content-ltr">The version 2 of the schema is incompatible with version 1.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Thus you will have to convert your existing "extension.json" file to the new format using the {{ll|Manual:updateExtensionJsonSchema.php|updateExtensionJsonSchema.php}} script.</span>
 |2=gotcha
}}

==== path ====
<span lang="en" dir="ltr" class="mw-content-ltr">As demonstrated in the example above, a configuration option can have the <code>path</code> key defined.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">When present and set to <code>true</code>, the value of the setting will be interpreted as a path local to the extension.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">For example, an extension might define its configuration as</span>
<syntaxhighlight lang="json">
{
	"config": {
		"Setting": {
			"value": "some_file.txt",
			"path": true
		}
	},
	"manifest_version": 2
}
</syntaxhighlight>
<span lang="en" dir="ltr" class="mw-content-ltr">The value for the configuration option "Setting" will be resolved to <code>$wgExtensionDirectory/FooBar/some_file.txt</code>.</span>

=== merge strategy ===
<span lang="en" dir="ltr" class="mw-content-ltr">The merge strategy defines how to merge the default value of the configuration setting with the global value (the value of the <code>$wgXXX</code> global variable).</span>
<span lang="en" dir="ltr" class="mw-content-ltr">This only makes sense for array-valued configuration settings.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">The following merge strategies are available:</span>
* <code>array_merge</code> &mdash; <span lang="en" dir="ltr" class="mw-content-ltr">Uses the <code>[https://www.php.net/function.array-merge array_merge]</code> 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.</span>
* <code>array_plus</code> &mdash; <span lang="en" dir="ltr" class="mw-content-ltr">Uses the <code>+</code> PHP operator, so fields of the default value will only be used when the corresponding field is not set in the global value.</span> <span lang="en" dir="ltr" class="mw-content-ltr">This is useful for associative arrays with integer keys (such as namespace IDs).</span>
* <code>array_plus_2d</code> &mdash; <span lang="en" dir="ltr" class="mw-content-ltr">Uses <code>wfArrayPlus2d</code> to handles nested arrays to a depth of 2 properly (e.g. {{wg|GroupPermissions}}).</span> 
* <code>array_merge_recursive</code> &mdash; <span lang="en" dir="ltr" class="mw-content-ltr">Handles arrays even deeper than 2 with <code>[https://www.php.net/function.array-merge-recursive array_merge_recursive]</code>.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Given the unintuitive behavior of this method ([https://3v4l.org/0tN7V example]), this strategy is not recommended.</span> <span lang="en" dir="ltr" class="mw-content-ltr">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.</span>
* <code>array_replace_recursive</code> &mdash; <span lang="en" dir="ltr" class="mw-content-ltr">Uses <code>[https://www.php.net/array-replace-recursive array_replace_recursive]</code>, basically the recursive version of <code>array_plus</code>.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Unlike <code>array_merge_recursive</code>, this will handle non-array fields the way one would expect.</span>
*<code>provide_default</code> <span lang="en" dir="ltr" class="mw-content-ltr">(since MW 1.35.3) &mdash; no merging; the default will only be used when no global value is set.</span> 
<span lang="en" dir="ltr" class="mw-content-ltr">When not explicitly set, the merge strategy defaults to <code>array_merge</code>.</span> 
<span lang="en" dir="ltr" class="mw-content-ltr">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.</span>

== config_prefix ==
{{MW 1.28|and after}}
<span lang="en" dir="ltr" class="mw-content-ltr">Prefix to put in front of configuration settings when exporting them to {{phpi|$GLOBALS}}.</span>

<span lang="en" dir="ltr" class="mw-content-ltr">The default is {{phpi|"wg"}}, so a configuration setting {{phpi|"Example"}} corresponds to a PHP global {{phpi|$wgExample}}.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">Note that choosing a different config prefix can make it more difficult to find the extension setting corresponding to a given global.</span>

== ParsoidModules ==
{{MW 1.35|and after|gerrit change=597639}}
<span lang="en" dir="ltr" class="mw-content-ltr">A list of [[Special:MyLanguage/Parsoid|Parsoid]] extension module specifiers.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">A Parsoid extension module is a class implementing {{Class doclink|project=Parsoid-PHP|type=interface|class=Wikimedia\Parsoid\Ext\ExtensionModule}}; a specifier is a class name or {{ll|ObjectFactory}} specification or a Parsoid-specific module specification.</span>
{{todo|document}}

== ParserTestFiles ==

{{deprecated
|1=1.30.0
|2=<span lang="en" dir="ltr" class="mw-content-ltr">Parser test files should be placed in <code>tests/parser/</code>, so they will be automatically run by parserTests.php.</span>
}}
{{see global
|ParserTestFiles
|desc=<span lang="en" dir="ltr" class="mw-content-ltr">Parser test suite files to be run by parserTests.php when no specific filename is passed to it.</span>
}}

== ServiceWiringFiles ==

{{see global
|ServiceWiringFiles
|desc=<span lang="en" dir="ltr" class="mw-content-ltr">Array of filenames of service wiring files to be loaded by the default instance of MediaWikiServices.</span>
}}

== attributes ==

<span lang="en" dir="ltr" class="mw-content-ltr">Registration information for other extensions.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">This allows one extension to register things with other extensions.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">Attribute values must be JSON arrays or objects, and they will be merged together when retrieved in PHP.</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
In manifest_version 1 these were top level keys that could be arbitrarily named:
</div>

<syntaxhighlight lang="json">
"EventLoggingSchemas": {
    "MySchema": 123
}
</syntaxhighlight>

<span lang="en" dir="ltr" class="mw-content-ltr">In manifest_version 2, these are now under the top level <code>attributes</code> key, and then nested under the extension name that the attribute belongs towards.</span>

<span lang="en" dir="ltr" class="mw-content-ltr">The full attribute name is the concatenation of the extension name and attribute name (<code>EventLoggingSchemas</code> in the example below).</span> 
<span lang="en" dir="ltr" class="mw-content-ltr">Each key set directly under <code>attributes</code> '''must''' match the extension name (arbitrary top-level attribute keys are not supported).</span>
<span lang="en" dir="ltr" class="mw-content-ltr">If an extension (EventLogging in this example) is not installed, the attributes won't be loaded into the registry.</span>

<syntaxhighlight lang="json">
"attributes": {
    "EventLogging": {
        "Schemas": {
            "MySchema": 123
        }
    }
}
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
To access the value of an attribute in PHP, you can use the ExtensionRegistry:
</div>

<syntaxhighlight lang="php">
$schemas = ExtensionRegistry::getInstance()->getAttribute( 'EventLoggingSchemas' );
</syntaxhighlight>

== load_composer_autoloader ==

<span lang="en" dir="ltr" class="mw-content-ltr">Load the composer autoloader for this extension, if one is present.</span> 
<span lang="en" dir="ltr" class="mw-content-ltr">This should be used if the extension has dependencies on libraries that are specified in <code>composer.json</code>.</span> 
<span lang="en" dir="ltr" class="mw-content-ltr">It is basically equivalent to the following code:</span>

<syntaxhighlight lang="php">
if ( file_exists( __DIR__ . '/vendor/autoload.php' ) ) {
	require_once __DIR__ . '/vendor/autoload.php';
}
</syntaxhighlight>