includes/page/Hook/PageDeletionDataUpdatesHook.php

   1 <?php
   2
   3 namespace MediaWiki\Page\Hook;
   4
   5 use MediaWiki\Deferred\DeferrableUpdate;
   6 use MediaWiki\Revision\RevisionRecord;
   7 use MediaWiki\Title\Title;
   8
   9 /**
  10  * This is a hook handler interface, see docs/Hooks.md.
  11  * Use the hook name "PageDeletionDataUpdates" to register handlers implementing this interface.
  12  *
  13  * @stable to implement
  14  * @ingroup Hooks
  15  */
  16 interface PageDeletionDataUpdatesHook {
  17         /**
  18          * This hook is called when constructing a list of DeferrableUpdate to be
  19          * executed when a page is deleted.
  20          *
  21          * @since 1.35
  22          *
  23          * @param Title $title Title of the page being deleted
  24          * @param RevisionRecord $revision RevisionRecord representing the page's
  25          *   current revision at the time of deletion
  26          * @param DeferrableUpdate[] &$updates List of DeferrableUpdate that can be
  27          *   manipulated by the hook handler
  28          * @return bool|void True or no return value to continue or false to abort
  29          */
  30         public function onPageDeletionDataUpdates( $title, $revision, &$updates );
  31 }