wiki.techinc.nl/includes/Hook/CategoryViewer__doCategoryQueryHook.php
daniel 2e57447c58 Document hook names in hook interfaces.
Bug: T258665
Change-Id: Ifddbf57f8aa2e3eb0d5845601376cbafa08ed407
2020-09-27 12:03:12 +02:00

27 lines
881 B
PHP

<?php
namespace MediaWiki\Hook;
use Wikimedia\Rdbms\IResultWrapper;
// phpcs:disable Squiz.Classes.ValidClassName.NotCamelCaps
/**
* 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
* @ingroup Hooks
*/
interface CategoryViewer__doCategoryQueryHook {
/**
* 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
*
* @param string $type Category type, either 'page', 'file', or 'subcat'
* @param IResultWrapper $res Query result from Wikimedia\Rdbms\IDatabase::select()
* @return bool|void True or no return value to continue or false to abort
*/
public function onCategoryViewer__doCategoryQuery( $type, $res );
}