wiki.techinc.nl/includes/Hook/MakeGlobalVariablesScriptHook.php
daniel 2e57447c58 Document hook names in hook interfaces.
Bug: T258665
Change-Id: Ifddbf57f8aa2e3eb0d5845601376cbafa08ed407
2020-09-27 12:03:12 +02:00

28 lines
875 B
PHP

<?php
namespace MediaWiki\Hook;
use OutputPage;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "MakeGlobalVariablesScript" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface MakeGlobalVariablesScriptHook {
/**
* 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
*
* @param array &$vars Variable (or multiple variables)
* @param OutputPage $out OutputPage which called the hook, can be used to get the real title
* @return bool|void True or no return value to continue or false to abort
*/
public function onMakeGlobalVariablesScript( &$vars, $out );
}