includes/page/Hook/ImagePageShowTOCHook.php

   1 <?php
   2
   3 namespace MediaWiki\Page\Hook;
   4
   5 use ImagePage;
   6
   7 /**
   8  * This is a hook handler interface, see docs/Hooks.md.
   9  * Use the hook name "ImagePageShowTOC" to register handlers implementing this interface.
  10  *
  11  * @stable to implement
  12  * @ingroup Hooks
  13  */
  14 interface ImagePageShowTOCHook {
  15         /**
  16          * This hook is called when the file toc on an image page is generated.
  17          *
  18          * @since 1.35
  19          *
  20          * @param ImagePage $page
  21          * @param string[] &$toc Array of `<li>` strings
  22          * @return bool|void True or no return value to continue or false to abort
  23          */
  24         public function onImagePageShowTOC( $page, &$toc );
  25 }