MediaWiki  master
MediaWiki\Hook\CategoryViewer__doCategoryQueryHook Interface Reference

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

Inheritance diagram for MediaWiki\Hook\CategoryViewer__doCategoryQueryHook:

Public Member Functions

 onCategoryViewer__doCategoryQuery ( $type, $res)
 This hook is called after querying for pages to be displayed in a Category page. More...
 

Detailed Description

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

Use the hook name "CategoryViewer::doCategoryQuery" to register handlers implementing this interface.

Stable to implement

Definition at line 15 of file CategoryViewer__doCategoryQueryHook.php.

Member Function Documentation

◆ onCategoryViewer__doCategoryQuery()

MediaWiki\Hook\CategoryViewer__doCategoryQueryHook::onCategoryViewer__doCategoryQuery (   $type,
  $res 
)

This hook is called after querying for pages to be displayed in a Category page.

Use this hook to batch load any related data about the pages.

Since
1.35
Parameters
string$typeCategory type, either 'page', 'file', or 'subcat'
IResultWrapper$resQuery result from Wikimedia\Rdbms\IDatabase::select()
Returns
bool|void True or no return value to continue or false to abort

Implemented in MediaWiki\HookContainer\HookRunner.


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