includes/page/Hook/PageDeleteCompleteHook.php

   1 <?php
   2
   3 namespace MediaWiki\Page\Hook;
   4
   5 use ManualLogEntry;
   6 use MediaWiki\Page\ProperPageIdentity;
   7 use MediaWiki\Permissions\Authority;
   8 use MediaWiki\Revision\RevisionRecord;
   9
  10 /**
  11  * This is a hook handler interface, see docs/Hooks.md.
  12  * Use the hook name "PageDeleteComplete" to register handlers implementing this interface.
  13  *
  14  * @stable to implement
  15  * @ingroup Hooks
  16  */
  17 interface PageDeleteCompleteHook {
  18         /**
  19          * This hook is called after a page is deleted.
  20          *
  21          * @since 1.37
  22          *
  23          * @param ProperPageIdentity $page Page that was deleted.
  24          *   This object represents state before deletion (e.g. $page->exists() will return true).
  25          * @param Authority $deleter Who deleted the page
  26          * @param string $reason Reason the page was deleted
  27          * @param int $pageID ID of the page that was deleted
  28          * @param RevisionRecord $deletedRev Last revision of the deleted page
  29          * @param ManualLogEntry $logEntry ManualLogEntry used to record the deletion
  30          * @param int $archivedRevisionCount Number of revisions archived during the deletion
  31          * @return true|void
  32          */
  33         public function onPageDeleteComplete(
  34                 ProperPageIdentity $page,
  35                 Authority $deleter,
  36                 string $reason,
  37                 int $pageID,
  38                 RevisionRecord $deletedRev,
  39                 ManualLogEntry $logEntry,
  40                 int $archivedRevisionCount
  41         );
  42 }