includes/api/Hook/ApiParseMakeOutputPageHook.php

   1 <?php
   2
   3 namespace MediaWiki\Api\Hook;
   4
   5 use MediaWiki\Api\ApiBase;
   6 use MediaWiki\Output\OutputPage;
   7
   8 /**
   9  * This is a hook handler interface, see docs/Hooks.md.
  10  * Use the hook name "ApiParseMakeOutputPage" to register handlers implementing this interface.
  11  *
  12  * @stable to implement
  13  * @ingroup Hooks
  14  */
  15 interface ApiParseMakeOutputPageHook {
  16         /**
  17          * This hook is called when preparing the OutputPage object for
  18          * ApiParse. This is mainly intended for calling OutputPage::addContentOverride()
  19          * or OutputPage::addContentOverrideCallback().
  20          *
  21          * @since 1.35
  22          *
  23          * @param ApiBase $module ApiBase (which is also a ContextSource)
  24          * @param OutputPage $output
  25          * @return bool|void True or no return value to continue or false to abort
  26          */
  27         public function onApiParseMakeOutputPage( $module, $output );
  28 }