2 "$schema": "http://json-schema.org/schema#",
3 "description": "MediaWiki extension.json schema",
8 "description": "Version of the extension.json schema the extension.json file is in.",
13 "description": "The extension's canonical name.",
18 "description": "i18n message key of the extension's name."
22 "description": "The extension's type, as an index to $wgExtensionCredits.",
30 "description": "Extension's authors.",
37 "description": "The version of this release of the extension."
41 "description": "URL to the homepage for the extension.",
42 "format": "uri-reference"
46 "description": "Raw description of the extension."
50 "description": "Message key for a i18n message describing the extension."
54 "description": "SPDX identifier for the license under which the extension is released."
58 "description": "Indicates what versions of PHP, MediaWiki core or extensions are required. This syntax may be extended in the future, for example to check dependencies between other services.",
59 "additionalProperties": false,
63 "description": "Version constraint string against MediaWiki core."
67 "description": "Indicates version constraints against platform services.",
68 "additionalProperties": false,
72 "description": "Version constraint string against PHP."
77 "description": "Whether this extension requires shell access."
80 "patternProperties": {
83 "description": "Required PHP extension.",
90 "description": "Set of version constraint strings against specific extensions."
94 "description": "Set of version constraint strings against specific skins."
98 "ResourceFileModulePaths": {
100 "description": "Default paths to use for all ResourceLoader file modules",
101 "additionalProperties": false,
105 "description": "Base path to prepend to all local paths, relative to current directory"
109 "description": "Base path to prepend to all remote paths, relative to $wgExtensionAssetsPath"
113 "description": "Base path to prepend to all remote paths, relative to $wgStylePath"
119 "description": "ResourceLoader modules to register",
120 "patternProperties": {
121 "^[a-zA-Z0-9-\\.]+$": {
125 "description": "A ResourceLoaderFileModule definition",
126 "additionalProperties": false,
130 "description": "Base path to prepend to all local paths in $options. Defaults to $IP"
134 "description": "Base path to prepend to all remote paths in $options. Defaults to $wgScriptPath"
138 "description": "Equivalent of remoteBasePath, but relative to $wgExtensionAssetsPath"
142 "description": "Path to a file containing a JavaScript \"skip function\", if desired."
145 "type": ["string", "array"],
146 "description": "Scripts to always include (array of file paths)",
153 "description": "Scripts to include in specific language contexts (mapping of language code to file path(s))",
154 "patternProperties": {
155 "^[a-zA-Z0-9-]{2,}$": {
168 "description": "Scripts to include in specific skin contexts (mapping of skin name to script(s)",
169 "patternProperties": {
182 "type": ["string", "array"],
183 "description": "Scripts to include in debug contexts",
189 "type": ["string", "array"],
190 "description": "Scripts to include in the startup module",
196 "type": ["string", "array"],
197 "description": "Modules which must be loaded before this module",
203 "type": ["string", "array", "object"],
204 "description": "Styles to always load",
211 "description": "Styles to include in specific skin contexts (mapping of skin name to style(s))",
212 "patternProperties": {
225 "type": ["string", "array"],
226 "description": "Messages to always load",
233 "description": "Group which this module should be loaded together with"
236 "type": ["object", "string", "boolean"],
237 "description": "Whether the module is deprecated and usage is discouraged. Either a boolean, or a string or an object with key message can be used to customise deprecation message."
241 "description": "Position on the page to load this module at",
248 "type": ["object", "array"],
249 "description": "Templates to be loaded for client-side usage"
252 "type": ["string", "array"],
253 "description": "ResourceLoader target the module can run on",
260 "description": "Whether to skip CSSJanus LTR-to-RTL flipping for this module. Recommended for styles imported from libraries that already properly handle their RTL styles. Default is false, meaning CSSJanus will be applied on RTL-mode output."
263 "type": ["object", "array"],
264 "description": "Package files that can be require()d"
269 "description": "A ResourceLoaderWikiModule definition",
270 "additionalProperties": false,
273 "enum": ["ResourceLoaderWikiModule"]
277 "description": "Group which this module should be loaded together with"
281 "description": "Position on the page to load this module at",
288 "type": ["string", "array"],
289 "description": "ResourceLoader target the module can run on",
309 "description": "A ResourceLoaderImageModule definition",
310 "additionalProperties": false,
313 "enum": ["ResourceLoaderImageModule"]
327 "selectorWithoutVariant": {
330 "selectorWithVariant": {
351 "description": "An arbitrary ResourceLoaderModule definition",
355 "pattern": "^(?!ResourceLoader(File|Image|Wiki)Module).*$"
358 "required": ["class"]
364 "ResourceModuleSkinStyles": {
366 "description": "ResourceLoader modules for custom skin styles"
368 "ResourceLoaderSources": {
370 "description": "ResourceLoader sources to register"
374 "description": "A ResourceLoaderFileModule definition registered only when wgEnableJavaScriptTest is true."
378 "description": "Registry of factory functions to create Config objects"
380 "SessionProviders": {
382 "description": "Session providers"
384 "AuthManagerAutoConfig": {
386 "description": "AuthManager auto-configuration",
387 "additionalProperties": false,
391 "description": "Pre-authentication providers"
395 "description": "Primary authentication providers"
399 "description": "Secondary authentication providers"
403 "CentralIdLookupProviders": {
405 "description": "Central ID lookup providers"
409 "description": "Method to add extra namespaces",
441 "defaultcontentmodel": {
445 "type": ["string", "array"],
446 "description": "Userright(s) required to edit in this namespace"
448 "capitallinkoverride": {
450 "description": "Set $wgCapitalLinks on a per-namespace basis"
454 "description": "Whether the namespace is conditional upon configuration and should not be registered (requires separate registration via a hook)",
458 "required": ["id", "constant", "name"]
461 "TrackingCategories": {
463 "description": "Tracking category message keys",
468 "DefaultUserOptions": {
470 "description": "Default values of user options"
474 "description": "Preferences users cannot set",
479 "GroupPermissions": {
481 "description": "Default permissions to give to user groups",
482 "patternProperties": {
485 "patternProperties": {
493 "RevokePermissions": {
495 "description": "Default permissions to revoke from user groups",
496 "patternProperties": {
499 "patternProperties": {
507 "GrantPermissions": {
509 "description": "Map of permissions granted to authorized consumers to their bundles, called 'grants'",
510 "patternProperties": {
513 "patternProperties": {
521 "GrantPermissionGroups": {
523 "description": "Map of grants to their UI grouping",
524 "patternProperties": {
532 "description": "Implicit groups"
536 "description": "Groups a user can add to themselves"
538 "GroupsRemoveFromSelf": {
540 "description": "Groups a user can remove from themselves"
544 "description": "Groups a user can add to users"
548 "description": "Groups a user can remove from users"
552 "description": "User rights added by the extension",
559 "description": "Mapping of model ID to class name",
560 "patternProperties": {
568 "description": "Rate limits"
570 "RecentChangesFlags": {
572 "description": "Flags (letter symbols) shown on RecentChanges pages"
576 "description": "Plugins for media file type handling. Each entry in the array maps a MIME type to a PHP class name."
578 "ExtensionFunctions": {
583 "description": "Function to call after setup has finished",
588 "ExtensionMessagesFiles": {
590 "description": "File paths containing PHP internationalization data"
594 "description": "Directory paths containing JSON internationalization data"
596 "ExtensionEntryPointListFiles": {
601 "description": "SpecialPages implemented in this extension (mapping of page name to class name)"
603 "AutoloadNamespaces": {
605 "description": "Mapping of PSR-4 compliant namespace to directory for autoloading",
606 "patternProperties": {
607 "^[A-Za-z0-9\\\\]+\\\\$": {
611 "additionalProperties": false
617 "type": [ "string", "object" ],
618 "description": "Hooks this extension uses (mapping of hook name to callback)"
622 "description": "Job types this extension implements (mapping of job type to class name or factory function)"
626 "description": "List of new log types this extension uses"
634 "ActionFilteredLogs": {
636 "description": "List of log types which can be filtered by log actions",
637 "patternProperties": {
640 "patternProperties": {
660 "LogActionsHandlers": {
669 "APIFormatModules": {
686 "description": "Available feeds objects"
693 "description": "Password policies"
697 "description": "Preferred file extensions for uploading",
704 "description": "Messages which are rendered as raw HTML",
709 "ReauthenticateTime": {
711 "patternProperties": {
722 "description": "A function to be called right after MediaWiki processes this file"
726 "description": "Configuration options for this extension",
731 "description": "Prefix to put in front of configuration settings when exporting them to $GLOBALS"
734 "patternProperties": {
735 "^[a-zA-Z_\u007f-\u00ff][a-zA-Z0-9_\u007f-\u00ff]*$": {
740 "array_merge_recursive",
741 "array_replace_recursive",
746 "default": "array_merge"
754 "description": "Parser test suite files to be run by parserTests.php when no specific filename is passed to it"
756 "ServiceWiringFiles": {
758 "description": "List of service wiring files to be loaded by the default instance of MediaWikiServices"
760 "load_composer_autoloader": {
762 "description": "Load the composer autoloader for this extension, if one is present"