File: ResourceLoaderGetConfigVarsHook.php

package info (click to toggle)
mediawiki 1%3A1.43.3%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 417,464 kB
  • sloc: php: 1,062,949; javascript: 664,290; sql: 9,714; python: 5,458; xml: 3,489; sh: 1,131; makefile: 64
file content (31 lines) | stat: -rw-r--r-- 1,010 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
<?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 ResourceLoaderStartUpModule.
	 *
	 * @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;
}