Manual:$wgResourceModules

From Linux Web Expert

Revision as of 04:39, 20 December 2023 by imported>Cavila (→‎== Loading module ==: dev note)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

<translate> ResourceLoader</translate>: $wgResourceModules
Array of all extra defined modules that can later be loaded during the output.
<translate> Introduced in version:</translate>1.17.0 (r72349)
<translate> Removed in version:</translate><translate> still in use</translate>
<translate> Allowed values:</translate>(multi-dimensional array)
<translate> Default value:</translate>[]

Examples

Below is an example of how to use this in an extension. You would put this in your extension.json file.

"ResourceModules": {
    "ext.MyExtension": {
        "localBasePath": "modules/ext.MyExtension",
        "remoteExtPath": "MyExtension/modules/ext.MyExtension",
        "styles": [
            "foo.css",
            "bar.css"
        ],
        "packageFiles": [
            "index.js",
            "foo.js"
        ],
        "messages": [
            "myextension-foo-label"
        ],
        "dependencies": [
            "jquery.cookie",
            "mediawiki.util"
        ]
    }
},

Options

See MainConfigSchema::ResourceModules.

Loading module

See ResourceLoader/Migration guide (developers)#Adding a module to the page :

Note

If you require a list of all registered modules, it is not recommended to call $GLOBALS[ 'wgResourceModules' ] from a skin or extension. The list may not be complete at the time of the request. See ResourceLoader::getModuleNames() instead.

ResourceLoader/See also