includes/Hook/PageMoveCompletingHook.php

   1 <?php
   2
   3 namespace MediaWiki\Hook;
   4
   5 use MediaWiki\Linker\LinkTarget;
   6 use MediaWiki\Revision\RevisionRecord;
   7 use MediaWiki\User\UserIdentity;
   8
   9 /**
  10  * This is a hook handler interface, see docs/Hooks.md.
  11  * Use the hook name "PageMoveCompleting" to register handlers implementing this interface.
  12  *
  13  * @stable to implement
  14  * @ingroup Hooks
  15  */
  16 interface PageMoveCompletingHook {
  17         /**
  18          * This hook is called after moving an article (title), pre-commit
  19          *
  20          * @since 1.35
  21          *
  22          * @param LinkTarget $old Old title
  23          * @param LinkTarget $new New title
  24          * @param UserIdentity $user User who did the move
  25          * @param int $pageid Database ID of the page that's been moved
  26          * @param int $redirid Database ID of the created redirect
  27          * @param string $reason Reason for the move
  28          * @param RevisionRecord $revision RevisionRecord created by the move
  29          * @return bool|void True or no return value to continue or false stop other hook handlers,
  30          *     doesn't abort the move itself
  31          */
  32         public function onPageMoveCompleting( $old, $new, $user, $pageid, $redirid,
  33                 $reason, $revision
  34         );
  35 }