Public Member Functions | |
| __construct (HookContainer $container) | |
| 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. | |
| onResourceLoaderTestModules (array &$testModules, ResourceLoader $rl) | |
| Use this hook to register ResourceLoader modules that are only available when $wgEnableJavaScriptTest is true. | |
Private Attributes | |
| HookContainer | $container |
Detailed Description
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.
References MediaWiki\ResourceLoader\HookRunner\$container.
Member Function Documentation
◆ 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 ResourceLoaderContext | null $context
- Returns
- void This hook must not abort, it must return no value
Implements MediaWiki\ResourceLoader\Hook\ResourceLoaderForeignApiModulesHook.
Definition at line 26 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 34 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 ResourceLoaderSiteModule.
- 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 42 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 50 of file HookRunner.php.
◆ onResourceLoaderTestModules()
| MediaWiki\ResourceLoader\HookRunner::onResourceLoaderTestModules | ( | array & | $testModules, |
| ResourceLoader | $rl | ||
| ) |
Use this hook to register ResourceLoader modules that are only available when $wgEnableJavaScriptTest is true.
Use this for test suites and other test-only resources.
- Since
- 1.35
- Parameters
-
array &$testModules One array of modules per test framework. The modules array follows the same format as $wgResourceModules. For example: $testModules['qunit']['ext.Example.test'] = [ 'localBasePath' => DIR . '/tests/qunit', 'remoteExtPath' => 'Example/tests/qunit', 'script' => [ 'tests/qunit/foo.js' ], 'dependencies' => [ 'ext.Example.foo' ] ];ResourceLoader $rl
- Returns
- void This hook must not abort, it must return no value
Implements MediaWiki\ResourceLoader\Hook\ResourceLoaderTestModulesHook.
Definition at line 58 of file HookRunner.php.
Member Data Documentation
◆ $container
|
private |
Definition at line 20 of file HookRunner.php.
Referenced by MediaWiki\ResourceLoader\HookRunner\__construct().
The documentation for this class was generated from the following file:
- includes/resourceloader/HookRunner.php
