includes/api/Hook/ApiQueryWatchlistExtractOutputDataHook.php

   1 <?php
   2
   3 namespace MediaWiki\Api\Hook;
   4
   5 use MediaWiki\Api\ApiQueryWatchlist;
   6 use MediaWiki\Watchlist\WatchedItem;
   7
   8 /**
   9  * This is a hook handler interface, see docs/Hooks.md.
  10  * Use the hook name "ApiQueryWatchlistExtractOutputData" to register handlers implementing this interface.
  11  *
  12  * @stable to implement
  13  * @ingroup Hooks
  14  */
  15 interface ApiQueryWatchlistExtractOutputDataHook {
  16         /**
  17          * Use this hook to extract row data for ApiQueryWatchlist.
  18          *
  19          * @since 1.35
  20          *
  21          * @param ApiQueryWatchlist $module
  22          * @param WatchedItem $watchedItem
  23          * @param array $recentChangeInfo Array of recent change info data
  24          * @param array &$vals Associative array of data to be output for the row
  25          * @return bool|void True or no return value to continue or false to abort
  26          */
  27         public function onApiQueryWatchlistExtractOutputData( $module, $watchedItem,
  28                 $recentChangeInfo, &$vals
  29         );
  30 }