2020-03-03 22:50:34 +00:00
|
|
|
<?php
|
|
|
|
|
|
|
|
|
|
namespace MediaWiki\Hook;
|
|
|
|
|
|
2020-03-16 23:31:05 +00:00
|
|
|
use OutputPage;
|
|
|
|
|
|
2020-03-03 22:50:34 +00:00
|
|
|
/**
|
2020-09-26 13:18:43 +00:00
|
|
|
* This is a hook handler interface, see docs/Hooks.md.
|
|
|
|
|
* Use the hook name "MakeGlobalVariablesScript" to register handlers implementing this interface.
|
|
|
|
|
*
|
2020-07-13 09:05:49 +00:00
|
|
|
* @stable to implement
|
2020-03-03 22:50:34 +00:00
|
|
|
* @ingroup Hooks
|
|
|
|
|
*/
|
|
|
|
|
interface MakeGlobalVariablesScriptHook {
|
|
|
|
|
/**
|
2020-03-16 23:31:05 +00:00
|
|
|
* This hook is called at end of OutputPage::getJSVars.
|
2020-03-03 22:50:34 +00:00
|
|
|
* 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
|
|
|
|
|
*
|
2020-08-18 11:51:48 +00:00
|
|
|
* @param array &$vars Variable (or multiple variables)
|
2020-03-16 23:31:05 +00:00
|
|
|
* @param OutputPage $out OutputPage which called the hook, can be used to get the real title
|
2020-03-03 22:50:34 +00:00
|
|
|
* @return bool|void True or no return value to continue or false to abort
|
|
|
|
|
*/
|
|
|
|
|
public function onMakeGlobalVariablesScript( &$vars, $out );
|
|
|
|
|
}
|