MediaWiki  master
MediaWiki\Api\Hook\ApiQueryBaseAfterQueryHook Interface Reference

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

Inheritance diagram for MediaWiki\Api\Hook\ApiQueryBaseAfterQueryHook:

Public Member Functions

 onApiQueryBaseAfterQuery ( $module, $result, &$hookData)
 This hook is called for (some) API query modules after the database query has returned. More...
 

Detailed Description

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

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

Stable to implement

Definition at line 15 of file ApiQueryBaseAfterQueryHook.php.

Member Function Documentation

◆ onApiQueryBaseAfterQuery()

MediaWiki\Api\Hook\ApiQueryBaseAfterQueryHook::onApiQueryBaseAfterQuery (   $module,
  $result,
$hookData 
)

This hook is called for (some) API query modules after the database query has returned.

An API query module wanting to use this hook should see the ApiQueryBase::select() and ApiQueryBase::processRow() documentation.

Since
1.35
Parameters
ApiQueryBase$moduleModule in question
IResultWrapper$resultResultWrapper
array&$hookDataArray that was passed to the ApiQueryBaseBeforeQuery hook and will be passed to the ApiQueryBaseProcessRow hook, intended for inter-hook communication
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: