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

27 lines
758 B
PHP

<?php
namespace MediaWiki\Hook;
use TitleArray;
use Wikimedia\Rdbms\IResultWrapper;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "TitleArrayFromResult" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface TitleArrayFromResultHook {
/**
* This hook is called when creating a TitleArray object from a
* database result.
*
* @since 1.35
*
* @param TitleArray &$titleArray Set this to an object to override the default object returned
* @param IResultWrapper $res Database result used to create the object
* @return bool|void True or no return value to continue or false to abort
*/
public function onTitleArrayFromResult( &$titleArray, $res );
}