Manual:$wgResourceModules

From MediaWiki.org
Jump to: navigation, search
This page is a translated version of the page Manual:$wgResourceModules and the translation is 19% complete.

Other languages:
English • ‎français • ‎日本語 • ‎polski
Resource loader: $wgResourceModules
Array of all extra defined modules that can later be loaded during the output.
導入されたバージョン: 1.17.0 (r72349)
除去されたバージョン: 使用中
可能な値: 多次元配列
既定値: array()
他の設定: アルファベット順 | 機能順

[edit]

Here is a basic example for usage in an extension. You would put this in your extension.jsonManual:Extension registration file.

"ResourceModules": {
    "ext.myExtension.foo": {
        "scripts": "modules/ext.MyExtension.foo.js",
        "styles": [
            "modules/ext.MyExtension.foo.css",
            "modules/ext.MyExtension.bar.css"
        ],
        "messages": [
            "myextension-foo-label"
        ],
        "dependencies": [
            "jquery.cookie",
            "jquery.tabIndex"
        ]
    }
},
"ResourceFileModulePaths": {
    "localBasePath": "",
    "remoteExtPath": "MyExtension"
},

The above example will create a module called 'ext.MyExtension.foo', which includes the script /extensions/MyExtension/modules/myExtension.foo.js, the style /extensions/MyExtension/modules/myExtension.foo.css, and so on. It also ensures that two modules 'jquery.cookie' and 'jquery.tabIndex' are available before execution.


詳細[edit]

By default modules are registered as an instance of ResourceLoaderFileModule. You find the according code in resources/Resources.php. Here is the documentation:

scripts
Scripts to always include.
File path string or array of file path strings.
languageScripts
Scripts to include in specific language contexts.
Array keyed by language code containing file path string or array of file path strings.
skinScripts
Scripts to include in specific skin contexts.
Array keyed by skin name containing file path string or array of file path strings.
debugScripts
Scripts to include in debug contexts.
File path string or array of file path strings.
loaderScripts
Scripts to include in the startup module.
File path string or array of file path strings.
警告: This parameter does not do what you think it does. Using loaderScripts requires that you register your module before you can do anything else with it. Specifying a script here will load the script in the header, but it will otherwise leave you with a crippled module. See this bug for more information.
dependencies
Modules which must be loaded before this module.
Module name string or array of module name strings.
styles
Styles to always load.
File path string or array of file path strings.
skinStyles
Styles to include in specific skin contexts.
Array keyed by skin name containing file path string or array of file path strings.
messages
Messages to always load
Array of message key strings.
group
Group which this module should be loaded together with
Group name string.
See detailed documentation before using this.
position
Position on the page to load this module at.
'bottom' または 'top'。 Until MediaWiki 1.26, 'bottom' was the default. In MediaWiki 1.26, the default went away and this value had to be defined explicitly.
class
Alternate subclass of ResourceLoader (rather than default ResourceLoaderFileModule). If this is used, some of the other properties may not apply, and you can specify your own arguments
Class name of alternate subclass
skipFunction
Function that returns true when the module should be skipped. Intended for when the module provides a polyfill that is not required in modern browsers
Filename of a JavaScript file with a top-level return (it should not be wrapped in a function)
localBasePath
Base path to prepend to all local paths in $options. 既定値は $IPManual:$IP です。
Base path
remoteBasePath
Base path to prepend to all remote paths in $options. 既定値は $wgScriptPath です。
Base path
remoteExtPath
Equivalent of remoteBasePath, but relative to $wgExtensionAssetsPath.
Base path

モジュールの読み込み[edit]

ResourceLoader/Migration guide (developers)#Adding a module to the pageResourceLoader/Migration guide (developers)#Adding a module to the page も参照してください:

$this->getOutput()->addModules( 'ext.myExtension' );

関連項目[edit]