includes/page/Hook/WikiPageDeletionUpdatesHook.php

   1 <?php
   2
   3 namespace MediaWiki\Page\Hook;
   4
   5 use MediaWiki\Content\Content;
   6 use MediaWiki\Deferred\DeferrableUpdate;
   7 use WikiPage;
   8
   9 /**
  10  * This is a hook handler interface, see docs/Hooks.md.
  11  * Use the hook name "WikiPageDeletionUpdates" to register handlers implementing this interface.
  12  *
  13  * @deprecated since 1.32 Use PageDeletionDataUpdates or override
  14  *   ContentHandler::getDeletionDataUpdates instead
  15  * @ingroup Hooks
  16  */
  17 interface WikiPageDeletionUpdatesHook {
  18         /**
  19          * Use this hook to manipulate the list of DeferrableUpdates to be applied
  20          * when a page is deleted.
  21          *
  22          * @since 1.35
  23          *
  24          * @param WikiPage $page
  25          * @param Content|null $content Content to generate updates for, or null in
  26          *   case the page revision could not be loaded. The delete will succeed
  27          *   despite this.
  28          * @param DeferrableUpdate[] &$updates Array of objects that implement
  29          *   DeferrableUpdate. Hook function may want to add to it.
  30          * @return bool|void True or no return value to continue or false to abort
  31          */
  32         public function onWikiPageDeletionUpdates( $page, $content, &$updates );
  33 }