MediaWiki\Api\Hook\ApiQueryBaseBeforeQueryHook Interface Reference
Stable to implement. More...
Inheritance diagram for MediaWiki\Api\Hook\ApiQueryBaseBeforeQueryHook:
Public Member Functions | |
| onApiQueryBaseBeforeQuery ( $module, &$tables, &$fields, &$conds, &$query_options, &$join_conds, &$hookData) | |
| This hook is called for (some) API query modules before a database query is made. | |
Detailed Description
Stable to implement.
Definition at line 11 of file ApiQueryBaseBeforeQueryHook.php.
Member Function Documentation
◆ onApiQueryBaseBeforeQuery()
| MediaWiki\Api\Hook\ApiQueryBaseBeforeQueryHook::onApiQueryBaseBeforeQuery | ( | $module, | |
| & | $tables, | ||
| & | $fields, | ||
| & | $conds, | ||
| & | $query_options, | ||
| & | $join_conds, | ||
| & | $hookData | ||
| ) |
This hook is called for (some) API query modules before a database query is made.
WARNING: It would be very easy to misuse this hook and break the module! Any joins added must join on a unique key of the target table unless you really know what you're doing. An API query module wanting to use this hook should see the ApiQueryBase::select() and ApiQueryBase::processRow() documentation.
- Since
- 1.35
- Parameters
-
ApiQueryBase $module Module in question array &$tables Array of tables to be queried array &$fields Array of columns to select array &$conds Array of WHERE conditionals for query array &$query_options Array of options for the database request array &$join_conds Join conditions for the tables array &$hookData Array that will be passed to the ApiQueryBaseAfterQuery and ApiQueryBaseProcessRow hooks, 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:
- includes/api/Hook/ApiQueryBaseBeforeQueryHook.php
