includes/page/Hook/ArticlePurgeHook.php

   1 <?php
   2
   3 namespace MediaWiki\Page\Hook;
   4
   5 use WikiPage;
   6
   7 /**
   8  * This is a hook handler interface, see docs/Hooks.md.
   9  * Use the hook name "ArticlePurge" to register handlers implementing this interface.
  10  *
  11  * @stable to implement
  12  * @ingroup Hooks
  13  */
  14 interface ArticlePurgeHook {
  15         /**
  16          * This hook is called before executing "&action=purge".
  17          *
  18          * @since 1.35
  19          *
  20          * @param WikiPage $wikiPage WikiPage to purge
  21          * @return bool|void True or no return value to continue or false to abort
  22          */
  23         public function onArticlePurge( $wikiPage );
  24 }