ResourceLoaderGetConfigVarsHook.php
No OneTemporary
Actions

Size

1021 B

Referenced Files

None

Subscribers

None

ResourceLoaderGetConfigVarsHook.php
View Options

	<?php

	namespace MediaWiki\ResourceLoader\Hook;

	use MediaWiki\Config\Config;

	/**
	* This is a hook handler interface, see docs/Hooks.md.
	* Use the hook name "ResourceLoaderGetConfigVars" to register handlers implementing this interface.
	*
	* @stable to implement
	* @ingroup ResourceLoaderHooks
	*/
	interface ResourceLoaderGetConfigVarsHook {
	/**
	* Export static site-wide `mw.config` variables to JavaScript.
	*
	* Variables that depend on the current page or request state must be added
	* through MediaWiki\Hook\MakeGlobalVariablesScriptHook instead.
	* The skin name is made available to send skin-specific config only when needed.
	*
	* This hook is called from MediaWiki\ResourceLoader\StartUpModule.
	*
	* @since 1.35
	* @param array &$vars `[ variable name => value ]`
	* @param string $skin
	* @param Config $config since 1.34
	* @return void This hook must not abort, it must return no value
	*/
	public function onResourceLoaderGetConfigVars( array &$vars, $skin, Config $config ): void;
	}