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 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": "Set of version constraint strings against specific extensions."
71 "description": "Set of version constraint strings against specific skins."
75 "ResourceFileModulePaths": {
77 "description": "Default paths to use for all ResourceLoader file modules",
78 "additionalProperties": false,
82 "description": "Base path to prepend to all local paths, relative to current directory"
86 "description": "Base path to prepend to all remote paths, relative to $wgExtensionAssetsPath"
90 "description": "Base path to prepend to all remote paths, relative to $wgStylePath"
96 "description": "ResourceLoader modules to register",
97 "patternProperties": {
98 "^[a-zA-Z0-9-\\.]+$": {
102 "description": "A ResourceLoaderFileModule definition",
103 "additionalProperties": false,
107 "description": "Base path to prepend to all local paths in $options. Defaults to $IP"
111 "description": "Base path to prepend to all remote paths in $options. Defaults to $wgScriptPath"
115 "description": "Equivalent of remoteBasePath, but relative to $wgExtensionAssetsPath"
119 "description": "Path to a file containing a JavaScript \"skip function\", if desired."
122 "type": ["string", "array"],
123 "description": "Scripts to always include (array of file paths)",
130 "description": "Scripts to include in specific language contexts (mapping of language code to file path(s))",
131 "patternProperties": {
132 "^[a-zA-Z0-9-]{2,}$": {
145 "description": "Scripts to include in specific skin contexts (mapping of skin name to script(s)",
146 "patternProperties": {
159 "type": ["string", "array"],
160 "description": "Scripts to include in debug contexts",
166 "type": ["string", "array"],
167 "description": "Scripts to include in the startup module",
173 "type": ["string", "array"],
174 "description": "Modules which must be loaded before this module",
180 "type": ["string", "array", "object"],
181 "description": "Styles to always load",
188 "description": "Styles to include in specific skin contexts (mapping of skin name to style(s))",
189 "patternProperties": {
202 "type": ["string", "array"],
203 "description": "Messages to always load",
210 "description": "Group which this module should be loaded together with"
213 "type": ["object", "string", "boolean"],
214 "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."
218 "description": "Position on the page to load this module at",
225 "type": ["object", "array"],
226 "description": "Templates to be loaded for client-side usage"
229 "type": ["string", "array"],
230 "description": "ResourceLoader target the module can run on",
237 "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."
242 "description": "A ResourceLoaderWikiModule definition",
243 "additionalProperties": false,
246 "enum": ["ResourceLoaderWikiModule"]
250 "description": "Group which this module should be loaded together with"
254 "description": "Position on the page to load this module at",
261 "type": ["string", "array"],
262 "description": "ResourceLoader target the module can run on",
282 "description": "A ResourceLoaderImageModule definition",
283 "additionalProperties": false,
286 "enum": ["ResourceLoaderImageModule"]
300 "selectorWithoutVariant": {
303 "selectorWithVariant": {
324 "description": "An arbitrary ResourceLoaderModule definition",
328 "pattern": "^((?!ResourceLoader(File|Image)Module).)*$"
331 "required": ["class"]
337 "ResourceModuleSkinStyles": {
339 "description": "ResourceLoader modules for custom skin styles"
341 "ResourceLoaderSources": {
343 "description": "ResourceLoader sources to register"
345 "ResourceLoaderLESSVars": {
347 "description": "ResourceLoader LESS variables"
351 "description": "Registry of factory functions to create Config objects"
353 "SessionProviders": {
355 "description": "Session providers"
357 "AuthManagerAutoConfig": {
359 "description": "AuthManager auto-configuration",
360 "additionalProperties": false,
364 "description": "Pre-authentication providers"
368 "description": "Primary authentication providers"
372 "description": "Secondary authentication providers"
376 "CentralIdLookupProviders": {
378 "description": "Central ID lookup providers"
382 "description": "Method to add extra namespaces",
414 "defaultcontentmodel": {
418 "type": ["string", "array"],
419 "description": "Userright(s) required to edit in this namespace"
421 "capitallinkoverride": {
423 "description": "Set $wgCapitalLinks on a per-namespace basis"
427 "description": "Whether the namespace is conditional upon configuration and should not be registered (requires separate registration via a hook)",
431 "required": ["id", "constant", "name"]
434 "TrackingCategories": {
436 "description": "Tracking category message keys",
441 "DefaultUserOptions": {
443 "description": "Default values of user options"
447 "description": "Preferences users cannot set",
452 "GroupPermissions": {
454 "description": "Default permissions to give to user groups",
455 "patternProperties": {
458 "patternProperties": {
466 "RevokePermissions": {
468 "description": "Default permissions to revoke from user groups",
469 "patternProperties": {
472 "patternProperties": {
480 "GrantPermissions": {
482 "description": "Map of permissions granted to authorized consumers to their bundles, called 'grants'",
483 "patternProperties": {
486 "patternProperties": {
494 "GrantPermissionGroups": {
496 "description": "Map of grants to their UI grouping",
497 "patternProperties": {
505 "description": "Implicit groups"
509 "description": "Groups a user can add to themselves"
511 "GroupsRemoveFromSelf": {
513 "description": "Groups a user can remove from themselves"
517 "description": "Groups a user can add to users"
521 "description": "Groups a user can remove from users"
525 "description": "User rights added by the extension",
532 "description": "Mapping of model ID to class name",
533 "patternProperties": {
541 "description": "Rate limits"
543 "RecentChangesFlags": {
545 "description": "Flags (letter symbols) shown on RecentChanges pages"
549 "description": "Plugins for media file type handling. Each entry in the array maps a MIME type to a PHP class name."
551 "ExtensionFunctions": {
556 "description": "Function to call after setup has finished",
561 "ExtensionMessagesFiles": {
563 "description": "File paths containing PHP internationalization data"
567 "description": "Directory paths containing JSON internationalization data"
569 "ExtensionEntryPointListFiles": {
574 "description": "SpecialPages implemented in this extension (mapping of page name to class name)"
576 "AutoloadNamespaces": {
578 "description": "Mapping of PSR-4 compliant namespace to directory for autoloading",
579 "patternProperties": {
580 "^[A-Za-z0-9\\\\]+\\\\$": {
584 "additionalProperties": false
590 "type": [ "string", "object" ],
591 "description": "Hooks this extension uses (mapping of hook name to callback)"
595 "description": "Job types this extension implements (mapping of job type to class name or factory function)"
599 "description": "List of new log types this extension uses"
607 "ActionFilteredLogs": {
609 "description": "List of log types which can be filtered by log actions",
610 "patternProperties": {
613 "patternProperties": {
633 "LogActionsHandlers": {
642 "APIFormatModules": {
659 "description": "Available feeds objects"
666 "description": "Password policies"
670 "description": "Preferred file extensions for uploading",
680 "description": "A function to be called right after MediaWiki processes this file"
684 "description": "Configuration options for this extension",
689 "description": "Prefix to put in front of configuration settings when exporting them to $GLOBALS"
692 "patternProperties": {
693 "^[a-zA-Z_\u007f-\u00ff][a-zA-Z0-9_\u007f-\u00ff]*$": {
698 "array_merge_recursive",
699 "array_replace_recursive",
704 "default": "array_merge"
712 "description": "Parser test suite files to be run by parserTests.php when no specific filename is passed to it"
714 "ServiceWiringFiles": {
716 "description": "List of service wiring files to be loaded by the default instance of MediaWikiServices"
718 "load_composer_autoloader": {
720 "description": "Load the composer autoloader for this extension, if one is present"