wiki.techinc.nl/includes/resourceloader/Hook/ResourceLoaderGetConfigVarsHook.php
apaskulin c44488f725 docs: Hook interface doc comment review
Edited doc comments for hook interfaces to improve
consistency and add type hints.

Bug: T246855
Change-Id: I38fa802463cd6f39bf5946dbbeb1b3ebaea604b2
2020-04-21 09:10:08 +10:00

28 lines
789 B
PHP

<?php
namespace MediaWiki\Hook;
use Config;
use Skin;
/**
* @stable for implementation
* @ingroup Hooks
*/
interface ResourceLoaderGetConfigVarsHook {
/**
* This hook is called at the end of
* ResourceLoaderStartUpModule::getConfigSettings(). Use this hook to export static
* configuration variables to JavaScript. Things that depend on the current page
* or request state must be added through MakeGlobalVariablesScript instead.
* Skin is made available for skin specific config.
*
* @since 1.35
*
* @param array &$vars [ variable name => value ]
* @param Skin $skin
* @param Config $config since 1.34
* @return bool|void True or no return value to continue or false to abort
*/
public function onResourceLoaderGetConfigVars( &$vars, $skin, $config );
}