MediaWiki REL1_35
Public Member Functions | List of all members
MediaWiki\Api\Hook\ApiQueryBaseAfterQueryHook Interface Reference
Hooks

Stable to implement. More...

Inheritance diagram for MediaWiki\Api\Hook\ApiQueryBaseAfterQueryHook:
Inheritance graph
[legend]

Public Member Functions

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

Detailed Description

Stable to implement.

Definition at line 12 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 | bool$resultResultWrapper or bool returned from the IDatabase::select()
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: