File: ResourceLoaderModifyEmbeddedSourceUrlsHook.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 (33 lines) | stat: -rw-r--r-- 1,234 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
32
33
<?php

namespace MediaWiki\ResourceLoader\Hook;

/**
 * This is a hook handler interface, see docs/Hooks.md.
 * Use the hook name "ResourceLoaderModifyEmbeddedSourceUrls" to register handlers implementing this interface.
 *
 * @stable to implement
 * @ingroup ResourceLoaderHooks
 */
interface ResourceLoaderModifyEmbeddedSourceUrlsHook {

	/**
	 * Allow modifying source URLs (i.e. URLs to load.php, see {@link ResourceLoader::getSources()})
	 * when they are used for output that may be embedded in the page HTML, rather than referenced
	 * using `<link>` etc., and thus the URL will be expanded relative to index.php URLs, rather than
	 * other load.php URLs.
	 *
	 * The hook must not add or remove sources, and calling the new URL should have a roughly similar
	 * outcome to calling the old URL. It is mainly intended to support serving index.php and load.php
	 * from different domains.
	 *
	 * This hook is currently called from StartUpModule and ImageModule.
	 *
	 * @since 1.43
	 *
	 * @param string[] &$urls An array of source name => URL; the URL might be relative.
	 * @return void This hook must not abort, it must return no value
	 */
	public function onResourceLoaderModifyEmbeddedSourceUrls( array &$urls ): void;

}