This is a hook handler interface, see docs/Hooks.md. More...
Public Member Functions | |
| onMakeGlobalVariablesScript (&$vars, $out) | |
Export user- or page-specific mw.config variables to JavaScript. | |
Detailed Description
This is a hook handler interface, see docs/Hooks.md.
Use the hook name "MakeGlobalVariablesScript" to register handlers implementing this interface.
- Stability: stable
- to implement
Definition at line 14 of file MakeGlobalVariablesScriptHook.php.
Member Function Documentation
◆ onMakeGlobalVariablesScript()
| MediaWiki\Hook\MakeGlobalVariablesScriptHook::onMakeGlobalVariablesScript | ( | & | $vars, |
| $out | |||
| ) |
Export user- or page-specific mw.config variables to JavaScript.
When using this hook, be as selective as possible about when the data is set. Reduce the cost by setting values only for specific titles, namespaces, or user-rights.
Data exported here is transmitted with the highest possible bandwidth priority (ahead of page content even). Any data that is not dependant on the current request, should go through MediaWiki\ResourceLoader\Hook\ResourceLoaderGetConfigVarsHook instead.
This hook is called from OutputPage::getJSVars.
- Since
- 1.35
- Parameters
-
array &$vars Variable (or multiple variables) OutputPage $out OutputPage which called the hook, can be used to get the real title
- Returns
- void This hook must not abort, it must return no value
Implemented in MediaWiki\HookContainer\HookRunner.
The documentation for this interface was generated from the following file:
- includes/Hook/MakeGlobalVariablesScriptHook.php
