includes/content/Hook/GetSlotDiffRendererHook.php

   1 <?php
   2
   3 namespace MediaWiki\Content\Hook;
   4
   5 use MediaWiki\Content\ContentHandler;
   6 use MediaWiki\Context\IContextSource;
   7 use SlotDiffRenderer;
   8
   9 /**
  10  * This is a hook handler interface, see docs/Hooks.md.
  11  * Use the hook name "GetSlotDiffRenderer" to register handlers implementing this interface.
  12  *
  13  * @stable to implement
  14  * @ingroup Hooks
  15  */
  16 interface GetSlotDiffRendererHook {
  17         /**
  18          * Use this hook to replace or wrap the standard SlotDiffRenderer for some content type.
  19          *
  20          * @since 1.35
  21          *
  22          * @param ContentHandler $contentHandler ContentHandler for which the slot diff renderer is fetched
  23          * @param SlotDiffRenderer &$slotDiffRenderer SlotDiffRenderer to change or replace
  24          * @param IContextSource $context
  25          * @return bool|void True or no return value to continue or false to abort
  26          */
  27         public function onGetSlotDiffRenderer( $contentHandler, &$slotDiffRenderer,
  28                 $context
  29         );
  30 }