includes/parser/Hook/AfterParserFetchFileAndTitleHook.php

   1 <?php
   2
   3 namespace MediaWiki\Hook;
   4
   5 use ImageGalleryBase;
   6 use MediaWiki\Parser\Parser;
   7
   8 /**
   9  * This is a hook handler interface, see docs/Hooks.md.
  10  * Use the hook name "AfterParserFetchFileAndTitle" to register handlers implementing this interface.
  11  *
  12  * @stable to implement
  13  * @ingroup Hooks
  14  */
  15 interface AfterParserFetchFileAndTitleHook {
  16         /**
  17          * This hook is called after an image gallery is formed by Parser,
  18          * just before adding its HTML to parser output.
  19          *
  20          * @since 1.35
  21          *
  22          * @param Parser $parser Parser that called the hook
  23          * @param ImageGalleryBase $ig Gallery, an object of one of the gallery classes (inheriting from
  24          *   ImageGalleryBase)
  25          * @param string &$html HTML generated by the gallery
  26          * @return bool|void True or no return value to continue or false to abort
  27          */
  28         public function onAfterParserFetchFileAndTitle( $parser, $ig, &$html );
  29 }