includes/page/Hook/ArticlePageDataBeforeHook.php

   1 <?php
   2
   3 namespace MediaWiki\Page\Hook;
   4
   5 use WikiPage;
   6
   7 /**
   8  * This is a hook handler interface, see docs/Hooks.md.
   9  * Use the hook name "ArticlePageDataBefore" to register handlers implementing this interface.
  10  *
  11  * @stable to implement
  12  * @ingroup Hooks
  13  */
  14 interface ArticlePageDataBeforeHook {
  15         /**
  16          * This hook is called before loading data of an article from the database.
  17          *
  18          * @since 1.35
  19          *
  20          * @param WikiPage $wikiPage WikiPage whose data will be loaded
  21          * @param array &$fields Fields to load from the database
  22          * @param array &$tables Tables to load from the database
  23          * @param array &$joinConds Join conditions to load from the database
  24          * @return bool|void True or no return value to continue or false to abort
  25          */
  26         public function onArticlePageDataBefore( $wikiPage, &$fields, &$tables,
  27                 &$joinConds
  28         );
  29 }