Manual:Hooks/ApiQueryWatchlistPrepareWatchedItemQueryServiceOptions

From Linux Web Expert

ApiQueryWatchlistPrepareWatchedItemQueryServiceOptions
<translate> Available from <tvar name=1><translate> version <tvar (Gerrit change 315521)</tvar></translate>
Populate the options to be passed from ApiQueryWatchlist to WatchedItemQueryService.
<translate> Define function:</translate>
public static function onApiQueryWatchlistPrepareWatchedItemQueryServiceOptions( ApiQueryWatchlist $module, array $params, array &$options ) { ... }
<translate> Attach hook:</translate> <translate> In <tvar name=1>extension.json</tvar>:</translate>
{
	"Hooks": {
		"ApiQueryWatchlistPrepareWatchedItemQueryServiceOptions": "MediaWiki\\Extension\\MyExtension\\Hooks::onApiQueryWatchlistPrepareWatchedItemQueryServiceOptions"
	}
}
<translate> Called from:</translate> <translate> File(s):</translate> api/ApiQueryWatchlist.php
<translate> Interface:</translate> ApiQueryWatchlistPrepareWatchedItemQueryServiceOptionsHook.php

<translate> For more information about attaching hooks, see <tvar name=1>Manual:Hooks </tvar>.</translate>
<translate> For examples of extensions using this hook, see <tvar name=cat>Category:ApiQueryWatchlistPrepareWatchedItemQueryServiceOptions extensions</tvar>.</translate>


Details

  • $module: ApiQueryWatchlist instance
  • $params: Array of parameters, as would be returned by $module->extractRequestParams()
  • &$options: Array of options for WatchedItemQueryService::getWatchedItemsWithRecentChangeInfo()


See also