blob: f73e65579d32655842dff6965a053216e1856fd8 (
plain) (
blame)
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
32
33
34
35
36
37
|
<?php
namespace MediaWiki\ResourceLoader\Hook;
use MediaWiki\ResourceLoader\Context;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "ResourceLoaderExcludeUserOptions" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup ResourceLoaderHooks
*/
interface ResourceLoaderExcludeUserOptionsHook {
/**
* Exclude a user option from the preloaded data for client-side mw.user.options.
*
* This hook is called on every index.php pageview (via ResourceLoaderUserOptionsModule),
* and when building responses for the "mediawiki.base" module. Avoid database queries
* or other expensive operations as that would increase page load time.
*
* Use this hook to optimize pageview HTML size by omitting user preference
* values from the export JavaScript data for `mw.user.options`. For example,
* when an extension stores large values in a user preference, and rarely or never
* needs these client-side, you can exclude it via this hook. (T251994)
*
* This will exclude both the default value (via mediawiki.base module) and
* the current user's value (via pageview HTML).
*
* @since 1.38
* @param array &$keysToExclude
* @param Context $context
* @return void
*/
public function onResourceLoaderExcludeUserOptions( array &$keysToExclude, Context $context ): void;
}
|
