MediaWiki master
MediaWiki\Api\Hook\ApiQueryWatchlistPrepareWatchedItemQueryServiceOptionsHook Interface Reference

This is a hook handler interface, see docs/Hooks.md. More...

Inherited by MediaWiki\Api\ApiHookRunner.

Public Member Functions

 onApiQueryWatchlistPrepareWatchedItemQueryServiceOptions ( $module, $params, &$options)
 Use this hook to populate the options to be passed from ApiQueryWatchlist to WatchedItemQueryService.
 

Detailed Description

This is a hook handler interface, see docs/Hooks.md.

Use the hook name "ApiQueryWatchlistPrepareWatchedItemQueryServiceOptions" to register handlers implementing this interface.

Stability: stable
to implement

Definition at line 15 of file ApiQueryWatchlistPrepareWatchedItemQueryServiceOptionsHook.php.

Member Function Documentation

◆ onApiQueryWatchlistPrepareWatchedItemQueryServiceOptions()

MediaWiki\Api\Hook\ApiQueryWatchlistPrepareWatchedItemQueryServiceOptionsHook::onApiQueryWatchlistPrepareWatchedItemQueryServiceOptions (   $module,
  $params,
$options 
)

Use this hook to populate the options to be passed from ApiQueryWatchlist to WatchedItemQueryService.

Since
1.35
Parameters
ApiQueryWatchlist$module
array$paramsArray of parameters, as would be returned by $module->extractRequestParams()
array&$optionsArray of options for WatchedItemQueryService::getWatchedItemsWithRecentChangeInfo()
Returns
bool|void True or no return value to continue or false to abort

Implemented in MediaWiki\Api\ApiHookRunner.


The documentation for this interface was generated from the following file: