MediaWiki REL1_39
MediaWiki\Api\Hook\ApiQueryBaseProcessRowHook Interface Reference

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

Inheritance diagram for MediaWiki\Api\Hook\ApiQueryBaseProcessRowHook:

Public Member Functions

 onApiQueryBaseProcessRow ( $module, $row, &$data, &$hookData)
 This hook is called for (some) API query modules as each row of the database result is processed.
 

Detailed Description

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

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

Stability: stable
to implement

Definition at line 15 of file ApiQueryBaseProcessRowHook.php.

Member Function Documentation

◆ onApiQueryBaseProcessRow()

MediaWiki\Api\Hook\ApiQueryBaseProcessRowHook::onApiQueryBaseProcessRow ( $module,
$row,
& $data,
& $hookData )

This hook is called for (some) API query modules as each row of the database result is processed.

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
stdClass$rowDatabase result row
array&$dataArray to be included in the ApiResult
array&$hookDataArray that was be passed to the ApiQueryBaseBeforeQuery and ApiQueryBaseAfterQuery hooks, intended for inter-hook communication
Returns
bool|void True or no return value to continue, or false to stop processing the result set

Implemented in MediaWiki\Api\ApiHookRunner.


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