Manual:Hooks/MakeGlobalVariablesScript
| MakeGlobalVariablesScript | |
|---|---|
| Available from version 1.14.0 right before OutputPage->getJSVars returns the vars. | |
| Define function: | public static function onMakeGlobalVariablesScript( array &$vars, OutputPage $out ) { ... }
|
| Attach hook: | In extension.json:
{
"Hooks": {
"MakeGlobalVariablesScript": "MediaWiki\\Extension\\MyExtension\\Hooks::onMakeGlobalVariablesScript"
}
}
|
| Called from: | File(s): OutputPage.php |
| Interface: | MakeGlobalVariablesScriptHook.php |
For more information about attaching hooks, see Manual:Hooks.
For examples of extensions using this hook, see Category:MakeGlobalVariablesScript extensions.
Details
[edit]This hook is fired via getJsVars(), from OutputPage::headElement(). This hook should only be used to add variables that depend on the current page/request; static configuration should be added through ResourceLoaderGetConfigVars instead.
- &$vars: variable (or multiple variables) to be added into the output of OutputPage::headElement.
- $out (r96015): OutputPage instance calling the hook
See also
[edit]- ResourceLoaderGetConfigVars
addJsConfigVars()method of OutputPage