MediaWiki\Cache\Hook\HtmlCacheUpdaterVaryUrlsHook Interface Reference

This is a hook handler interface, see docs/Hooks.md. More...

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions
	onHtmlCacheUpdaterVaryUrls ( $urls, &$append)
	This hook is used to add variants of URLs to purge from HTTP caches.

Detailed Description

This is a hook handler interface, see docs/Hooks.md.

Use the hook name "HtmlCacheUpdaterVaryUrls" to register handlers implementing this interface.

Stability: stable

to implement

Definition at line 12 of file HtmlCacheUpdaterVaryUrlsHook.php.

Member Function Documentation

onHtmlCacheUpdaterVaryUrls()

MediaWiki\Cache\Hook\HtmlCacheUpdaterVaryUrlsHook::onHtmlCacheUpdaterVaryUrls	(		$urls,
		&	$append )

This hook is used to add variants of URLs to purge from HTTP caches.

Extensions that provide site-wide variants of all URLs, such as by serving from an alternate domain or path, can use this hook to append alternative URLs for each url in $urls.

Since

1.35

Parameters

array	$urls	Canonical URLs
array	&$append	Append alternative URLs for $urls

Returns

bool|void True or no return value to continue or false to abort

Implemented in MediaWiki\HookContainer\HookRunner.

---

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

• includes/cache/Hook/HtmlCacheUpdaterVaryUrlsHook.php