MediaWiki  master
MediaWiki\Api\Hook\APIQueryGeneratorAfterExecuteHook Interface Reference

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

Inheritance diagram for MediaWiki\Api\Hook\APIQueryGeneratorAfterExecuteHook:

Public Member Functions

 onAPIQueryGeneratorAfterExecute ( $module, $resultPageSet)
 This hook is called after calling the executeGenerator() method of an action=query submodule. More...
 

Detailed Description

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

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

Stable to implement

Definition at line 15 of file APIQueryGeneratorAfterExecuteHook.php.

Member Function Documentation

◆ onAPIQueryGeneratorAfterExecute()

MediaWiki\Api\Hook\APIQueryGeneratorAfterExecuteHook::onAPIQueryGeneratorAfterExecute (   $module,
  $resultPageSet 
)

This hook is called after calling the executeGenerator() method of an action=query submodule.

Use this hook to extend core API modules.

Since
1.35
Parameters
ApiBase$module
ApiPageSet$resultPageSet
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: