c44488f725
Edited doc comments for hook interfaces to improve consistency and add type hints. Bug: T246855 Change-Id: I38fa802463cd6f39bf5946dbbeb1b3ebaea604b2
26 lines
786 B
PHP
26 lines
786 B
PHP
<?php
|
|
|
|
namespace MediaWiki\Hook;
|
|
|
|
use OutputPage;
|
|
|
|
/**
|
|
* @stable for implementation
|
|
* @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) to be added into the output of
|
|
* Skin::makeVariablesScript
|
|
* @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 );
|
|
}
|