wiki.techinc.nl/includes/cache/Hook/HtmlCacheUpdaterVaryUrlsHook.php
daniel 2e57447c58 Document hook names in hook interfaces.
Bug: T258665
Change-Id: Ifddbf57f8aa2e3eb0d5845601376cbafa08ed407
2020-09-27 12:03:12 +02:00

27 lines
828 B
PHP

<?php
namespace MediaWiki\Cache\Hook;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "HtmlCacheUpdaterVaryUrls" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface HtmlCacheUpdaterVaryUrlsHook {
/**
* 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
*
* @param array $urls Canonical URLs
* @param array &$append Append alternative URLs for $urls
* @return bool|void True or no return value to continue or false to abort
*/
public function onHtmlCacheUpdaterVaryUrls( $urls, &$append );
}