includes/page/Hook/RollbackCompleteHook.php

   1 <?php
   2
   3 namespace MediaWiki\Page\Hook;
   4
   5 use MediaWiki\Revision\RevisionRecord;
   6 use MediaWiki\User\UserIdentity;
   7 use WikiPage;
   8
   9 /**
  10  * This is a hook handler interface, see docs/Hooks.md.
  11  * Use the hook name "RollbackComplete" to register handlers implementing this interface.
  12  *
  13  * @deprecated since 1.36, use PageSaveComplete
  14  * @ingroup Hooks
  15  */
  16 interface RollbackCompleteHook {
  17         /**
  18          * After an article rollback is completed.
  19          *
  20          * @since 1.35
  21          *
  22          * @param WikiPage $wikiPage the WikiPage that was edited
  23          * @param UserIdentity $user UserIdentity for the user who did the rollback
  24          * @param RevisionRecord $revision RevisionRecord for the revision the page was reverted back to
  25          * @param RevisionRecord $current RevisionRecord for the reverted revision
  26          * @return bool|void True or no return value to continue or false to abort
  27          */
  28         public function onRollbackComplete( $wikiPage, $user, $revision,
  29                 $current
  30         );
  31 }