MediaWiki  master
Page\Hook\ArticlePurgeHook Interface Reference

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

Inheritance diagram for Page\Hook\ArticlePurgeHook:

Public Member Functions

 onArticlePurge ( $wikiPage)
 This hook is called before executing "&action=purge". More...
 

Detailed Description

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

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

Stable to implement

Definition at line 14 of file ArticlePurgeHook.php.

Member Function Documentation

◆ onArticlePurge()

Page\Hook\ArticlePurgeHook::onArticlePurge (   $wikiPage)

This hook is called before executing "&action=purge".

Since
1.35
Parameters
WikiPage$wikiPageWikiPage to purge
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: