includes/page/Hook/ArticleParserOptionsHook.php

   1 <?php
   2
   3 namespace MediaWiki\Page\Hook;
   4
   5 use Article;
   6 use MediaWiki\Parser\ParserOptions;
   7
   8 /**
   9  * This is a hook handler interface, see docs/Hooks.md.
  10  * Use the hook name "ArticleParserOptions" to register handlers implementing this interface.
  11  *
  12  * @stable to implement
  13  * @ingroup Hooks
  14  */
  15 interface ArticleParserOptionsHook {
  16         /**
  17          * This hook is called before parsing wikitext for an article, and allows
  18          * setting particular parser options based on title, user preferences,
  19          * etc.
  20          *
  21          * @since 1.36
  22          *
  23          * @param Article $article Article about to be parsed
  24          * @param ParserOptions $popts Mutable parser options
  25          * @return bool|void True or no return value to continue or false to abort
  26          */
  27         public function onArticleParserOptions(
  28                 Article $article, ParserOptions $popts
  29         );
  30
  31 }