MediaWiki  master
MediaWiki\Cache\Hook\HtmlCacheUpdaterAppendUrlsHook Interface Reference

Stable for implementation. More...

Inheritance diagram for MediaWiki\Cache\Hook\HtmlCacheUpdaterAppendUrlsHook:

Public Member Functions

 onHtmlCacheUpdaterAppendUrls ( $title, $mode, &$append)
 This hook is used to declare extra URLs to purge from HTTP caches. More...

Detailed Description

Stable for implementation.

Definition at line 11 of file HtmlCacheUpdaterAppendUrlsHook.php.

Member Function Documentation

◆ onHtmlCacheUpdaterAppendUrls()

MediaWiki\Cache\Hook\HtmlCacheUpdaterAppendUrlsHook::onHtmlCacheUpdaterAppendUrls (   $title,

This hook is used to declare extra URLs to purge from HTTP caches.

Use $mode to decide whether to gather all related URLs or only those affected by a re-render of the same content. For example, after a direct revision to the content the history page will need to be purged. However when re-rendering after a cascading change from a template, only URLs that render content need purging. The $mode will be either HtmlCacheUpdater::PURGE_URLS_LINKSUPDATE_ONLY or 0.

Title$titleTitle of the page being updated
array&$appendAppend URLs relating to the title
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: