MediaWiki  master
MediaWiki\Cache\Hook\HtmlCacheUpdaterAppendUrlsHook Interface Reference

This is a hook handler interface, see docs/Hooks.md. 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

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

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

Stable to implement

Definition at line 14 of file HtmlCacheUpdaterAppendUrlsHook.php.

Member Function Documentation

◆ onHtmlCacheUpdaterAppendUrls()

MediaWiki\Cache\Hook\HtmlCacheUpdaterAppendUrlsHook::onHtmlCacheUpdaterAppendUrls (   $title,
  $mode,
$append 
)

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.

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