MediaWiki  master
MediaWiki\Hook\MakeGlobalVariablesScriptHook Interface Reference

This is a hook handler interface, see docs/Hooks.md. More...

Inheritance diagram for MediaWiki\Hook\MakeGlobalVariablesScriptHook:

Public Member Functions

 onMakeGlobalVariablesScript (&$vars, $out)
 This hook is called at end of OutputPage::getJSVars. More...
 

Detailed Description

This is a hook handler interface, see docs/Hooks.md.

Use the hook name "MakeGlobalVariablesScript" to register handlers implementing this interface.

Stable to implement

Definition at line 14 of file MakeGlobalVariablesScriptHook.php.

Member Function Documentation

◆ onMakeGlobalVariablesScript()

MediaWiki\Hook\MakeGlobalVariablesScriptHook::onMakeGlobalVariablesScript ( $vars,
  $out 
)

This hook is called at end of OutputPage::getJSVars.

Ideally, this hook should only be used to add variables that depend on the current page/request; static configuration should be added through ResourceLoaderGetConfigVars instead.

Since
1.35
Parameters
array&$varsVariable (or multiple variables)
OutputPage$outOutputPage which called the hook, can be used to get the real title
Returns
bool|void True or no return value to continue or false to abort

Implemented in MediaWiki\HookContainer\HookRunner.


The documentation for this interface was generated from the following file: