includes/page/Hook/ArticleFromTitleHook.php

   1 <?php
   2
   3 namespace MediaWiki\Page\Hook;
   4
   5 use Article;
   6 use MediaWiki\Context\IContextSource;
   7 use MediaWiki\Title\Title;
   8
   9 /**
  10  * This is a hook handler interface, see docs/Hooks.md.
  11  * Use the hook name "ArticleFromTitle" to register handlers implementing this interface.
  12  *
  13  * @stable to implement
  14  * @ingroup Hooks
  15  */
  16 interface ArticleFromTitleHook {
  17         /**
  18          * This hook is called when creating an article object from a title object using
  19          * Wiki::articleFromTitle().
  20          *
  21          * @since 1.35
  22          *
  23          * @param Title $title Title used to create the article object
  24          * @param Article &$article Article that will be returned
  25          * @param IContextSource $context
  26          * @return bool|void True or no return value to continue or false to abort
  27          */
  28         public function onArticleFromTitle( $title, &$article, $context );
  29 }