MediaWiki  master
MediaWiki\Hook\TitleSquidURLsHook Interface Reference

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

Inheritance diagram for MediaWiki\Hook\TitleSquidURLsHook:

Public Member Functions

 onTitleSquidURLs ( $title, &$urls)
 This hook is called to determine which URLs to purge from HTTP caches. More...
 

Detailed Description

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

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

Stable to implement

Definition at line 14 of file TitleSquidURLsHook.php.

Member Function Documentation

◆ onTitleSquidURLs()

MediaWiki\Hook\TitleSquidURLsHook::onTitleSquidURLs (   $title,
$urls 
)

This hook is called to determine which URLs to purge from HTTP caches.

Since
1.35
Parameters
Title$titleTitle object to purge
string[]&$urlsArray of URLs to purge from the caches, to be manipulated
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: