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."
75 "patternProperties": {
78 "description": "Required PHP extension.",
85 "description": "Set of version constraint strings against specific extensions."
89 "description": "Set of version constraint strings against specific skins."
93 "ResourceFileModulePaths": {
95 "description": "Default paths to use for all ResourceLoader file modules",
96 "additionalProperties": false,
100 "description": "Base path to prepend to all local paths, relative to current directory"
104 "description": "Base path to prepend to all remote paths, relative to $wgExtensionAssetsPath"
108 "description": "Base path to prepend to all remote paths, relative to $wgStylePath"
114 "description": "ResourceLoader modules to register",
115 "patternProperties": {
116 "^[a-zA-Z0-9-\\.]+$": {
120 "description": "A ResourceLoaderFileModule definition",
121 "additionalProperties": false,
125 "description": "Base path to prepend to all local paths in $options. Defaults to $IP"
129 "description": "Base path to prepend to all remote paths in $options. Defaults to $wgScriptPath"
133 "description": "Equivalent of remoteBasePath, but relative to $wgExtensionAssetsPath"
137 "description": "Path to a file containing a JavaScript \"skip function\", if desired."
140 "type": ["string", "array"],
141 "description": "Scripts to always include (array of file paths)",
148 "description": "Scripts to include in specific language contexts (mapping of language code to file path(s))",
149 "patternProperties": {
150 "^[a-zA-Z0-9-]{2,}$": {
163 "description": "Scripts to include in specific skin contexts (mapping of skin name to script(s)",
164 "patternProperties": {
177 "type": ["string", "array"],
178 "description": "Scripts to include in debug contexts",
184 "type": ["string", "array"],
185 "description": "Scripts to include in the startup module",
191 "type": ["string", "array"],
192 "description": "Modules which must be loaded before this module",
198 "type": ["string", "array", "object"],
199 "description": "Styles to always load",
206 "description": "Styles to include in specific skin contexts (mapping of skin name to style(s))",
207 "patternProperties": {
220 "type": ["string", "array"],
221 "description": "Messages to always load",
228 "description": "Group which this module should be loaded together with"
231 "type": ["object", "string", "boolean"],
232 "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."
236 "description": "Position on the page to load this module at",
243 "type": ["object", "array"],
244 "description": "Templates to be loaded for client-side usage"
247 "type": ["string", "array"],
248 "description": "ResourceLoader target the module can run on",
255 "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."
258 "type": ["object", "array"],
259 "description": "Package files that can be require()d"
264 "description": "A ResourceLoaderWikiModule definition",
265 "additionalProperties": false,
268 "enum": ["ResourceLoaderWikiModule"]
272 "description": "Group which this module should be loaded together with"
276 "description": "Position on the page to load this module at",
283 "type": ["string", "array"],
284 "description": "ResourceLoader target the module can run on",
304 "description": "A ResourceLoaderImageModule definition",
305 "additionalProperties": false,
308 "enum": ["ResourceLoaderImageModule"]
322 "selectorWithoutVariant": {
325 "selectorWithVariant": {
346 "description": "An arbitrary ResourceLoaderModule definition",
350 "pattern": "^((?!ResourceLoader(File|Image)Module).)*$"
353 "required": ["class"]
359 "ResourceModuleSkinStyles": {
361 "description": "ResourceLoader modules for custom skin styles"
363 "ResourceLoaderSources": {
365 "description": "ResourceLoader sources to register"
369 "description": "A ResourceLoaderFileModule definition registered only when wgEnableJavaScriptTest is true."
373 "description": "Registry of factory functions to create Config objects"
375 "SessionProviders": {
377 "description": "Session providers"
379 "AuthManagerAutoConfig": {
381 "description": "AuthManager auto-configuration",
382 "additionalProperties": false,
386 "description": "Pre-authentication providers"
390 "description": "Primary authentication providers"
394 "description": "Secondary authentication providers"
398 "CentralIdLookupProviders": {
400 "description": "Central ID lookup providers"
404 "description": "Method to add extra namespaces",
436 "defaultcontentmodel": {
440 "type": ["string", "array"],
441 "description": "Userright(s) required to edit in this namespace"
443 "capitallinkoverride": {
445 "description": "Set $wgCapitalLinks on a per-namespace basis"
449 "description": "Whether the namespace is conditional upon configuration and should not be registered (requires separate registration via a hook)",
453 "required": ["id", "constant", "name"]
456 "TrackingCategories": {
458 "description": "Tracking category message keys",
463 "DefaultUserOptions": {
465 "description": "Default values of user options"
469 "description": "Preferences users cannot set",
474 "GroupPermissions": {
476 "description": "Default permissions to give to user groups",
477 "patternProperties": {
480 "patternProperties": {
488 "RevokePermissions": {
490 "description": "Default permissions to revoke from user groups",
491 "patternProperties": {
494 "patternProperties": {
502 "GrantPermissions": {
504 "description": "Map of permissions granted to authorized consumers to their bundles, called 'grants'",
505 "patternProperties": {
508 "patternProperties": {
516 "GrantPermissionGroups": {
518 "description": "Map of grants to their UI grouping",
519 "patternProperties": {
527 "description": "Implicit groups"
531 "description": "Groups a user can add to themselves"
533 "GroupsRemoveFromSelf": {
535 "description": "Groups a user can remove from themselves"
539 "description": "Groups a user can add to users"
543 "description": "Groups a user can remove from users"
547 "description": "User rights added by the extension",
554 "description": "Mapping of model ID to class name",
555 "patternProperties": {
563 "description": "Rate limits"
565 "RecentChangesFlags": {
567 "description": "Flags (letter symbols) shown on RecentChanges pages"
571 "description": "Plugins for media file type handling. Each entry in the array maps a MIME type to a PHP class name."
573 "ExtensionFunctions": {
578 "description": "Function to call after setup has finished",
583 "ExtensionMessagesFiles": {
585 "description": "File paths containing PHP internationalization data"
589 "description": "Directory paths containing JSON internationalization data"
591 "ExtensionEntryPointListFiles": {
596 "description": "SpecialPages implemented in this extension (mapping of page name to class name)"
598 "AutoloadNamespaces": {
600 "description": "Mapping of PSR-4 compliant namespace to directory for autoloading",
601 "patternProperties": {
602 "^[A-Za-z0-9\\\\]+\\\\$": {
606 "additionalProperties": false
612 "type": [ "string", "object" ],
613 "description": "Hooks this extension uses (mapping of hook name to callback)"
617 "description": "Job types this extension implements (mapping of job type to class name or factory function)"
621 "description": "List of new log types this extension uses"
629 "ActionFilteredLogs": {
631 "description": "List of log types which can be filtered by log actions",
632 "patternProperties": {
635 "patternProperties": {
655 "LogActionsHandlers": {
664 "APIFormatModules": {
681 "description": "Available feeds objects"
688 "description": "Password policies"
692 "description": "Preferred file extensions for uploading",
699 "description": "Messages which are rendered as raw HTML",
704 "ReauthenticateTime": {
706 "patternProperties": {
717 "description": "A function to be called right after MediaWiki processes this file"
721 "description": "Configuration options for this extension",
726 "description": "Prefix to put in front of configuration settings when exporting them to $GLOBALS"
729 "patternProperties": {
730 "^[a-zA-Z_\u007f-\u00ff][a-zA-Z0-9_\u007f-\u00ff]*$": {
735 "array_merge_recursive",
736 "array_replace_recursive",
741 "default": "array_merge"
749 "description": "Parser test suite files to be run by parserTests.php when no specific filename is passed to it"
751 "ServiceWiringFiles": {
753 "description": "List of service wiring files to be loaded by the default instance of MediaWikiServices"
755 "load_composer_autoloader": {
757 "description": "Load the composer autoloader for this extension, if one is present"