Manual:Hooks/MakeGlobalVariablesScript

From MediaWiki.org
Jump to: navigation, search
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:
$wgHooks['MakeGlobalVariablesScript'][] = 'MyExtensionHooks::onMakeGlobalVariablesScript';
Called from: File(s): OutputPage.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