MediaWiki\ResourceLoader\HookRunner Class Reference

Inherits MediaWiki\ResourceLoader\Hook\ResourceLoaderExcludeUserOptionsHook, MediaWiki\ResourceLoader\Hook\ResourceLoaderForeignApiModulesHook, MediaWiki\ResourceLoader\Hook\ResourceLoaderRegisterModulesHook, MediaWiki\ResourceLoader\Hook\ResourceLoaderSiteModulePagesHook, and MediaWiki\ResourceLoader\Hook\ResourceLoaderSiteStylesModulePagesHook.

Collaboration diagram for MediaWiki\ResourceLoader\HookRunner:

Public Member Functions
	__construct (HookContainer $container)
	onResourceLoaderExcludeUserOptions (array &$keysToExclude, Context $context)
	Exclude a user option from the preloaded data for client-side mw.user.options.
	onResourceLoaderForeignApiModules (&$dependencies, $context)
	Add dependencies to the mediawiki.ForeignApi module when you wish to override its behavior.
	onResourceLoaderRegisterModules (ResourceLoader $rl)
	This hook is called right before modules information is required, such as when responding to a resource loader request or generating HTML output.
	onResourceLoaderSiteModulePages ( $skin, array &$pages)
	Change which wiki pages comprise the site module in given skin.
	onResourceLoaderSiteStylesModulePages ( $skin, array &$pages)
	Change which wiki pages comprise the site.styles module in given skin.

Detailed Description

Access: internal

Definition at line 12 of file HookRunner.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\ResourceLoader\HookRunner::__construct

(

HookContainer

$container

)

Definition at line 22 of file HookRunner.php.

Member Function Documentation

onResourceLoaderExcludeUserOptions()

MediaWiki\ResourceLoader\HookRunner::onResourceLoaderExcludeUserOptions	(	array &	$keysToExclude,
		Context	$context )

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

Parameters

array	&$keysToExclude
Context	$context

Returns

void

Implements MediaWiki\ResourceLoader\Hook\ResourceLoaderExcludeUserOptionsHook.

Definition at line 26 of file HookRunner.php.

onResourceLoaderForeignApiModules()

MediaWiki\ResourceLoader\HookRunner::onResourceLoaderForeignApiModules	(	&	$dependencies,
			$context )

Add dependencies to the mediawiki.ForeignApi module when you wish to override its behavior.

See the JS docs for more information.

This hook is called from ResourceLoaderForeignApiModule.

Since

1.35

Parameters

string[]	&$dependencies	List of modules that mediawiki.ForeignApi should depend on
Context | null	$context

Returns

void This hook must not abort, it must return no value

Implements MediaWiki\ResourceLoader\Hook\ResourceLoaderForeignApiModulesHook.

Definition at line 34 of file HookRunner.php.

onResourceLoaderRegisterModules()

MediaWiki\ResourceLoader\HookRunner::onResourceLoaderRegisterModules

(

ResourceLoader

$rl

)

This hook is called right before modules information is required, such as when responding to a resource loader request or generating HTML output.

Since

1.35

Parameters

ResourceLoader

$rl

Returns

void This hook must not abort, it must return no value

Implements MediaWiki\ResourceLoader\Hook\ResourceLoaderRegisterModulesHook.

Definition at line 42 of file HookRunner.php.

onResourceLoaderSiteModulePages()

MediaWiki\ResourceLoader\HookRunner::onResourceLoaderSiteModulePages	(		$skin,
		array &	$pages )

Change which wiki pages comprise the site module in given skin.

This hook is called from MediaWiki\ResourceLoader\SiteModule.

Since

1.35

Parameters

string	$skin	Current skin key
array	&$pages	Array of pages and their types

Returns

void This hook must not abort, it must return no value

Implements MediaWiki\ResourceLoader\Hook\ResourceLoaderSiteModulePagesHook.

Definition at line 50 of file HookRunner.php.

onResourceLoaderSiteStylesModulePages()

MediaWiki\ResourceLoader\HookRunner::onResourceLoaderSiteStylesModulePages	(		$skin,
		array &	$pages )

Change which wiki pages comprise the site.styles module in given skin.

This hook is called from ResourceLoaderSiteStylesModule.

Since

1.35

Parameters

string	$skin	Current skin key
array	&$pages	Array of pages and their types

Returns

void This hook must not abort, it must return no value

Implements MediaWiki\ResourceLoader\Hook\ResourceLoaderSiteStylesModulePagesHook.

Definition at line 58 of file HookRunner.php.

---

The documentation for this class was generated from the following file:

• includes/ResourceLoader/HookRunner.php