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

26 lines
732 B
PHP

<?php
namespace MediaWiki\Hook;
use ISearchResultSet;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "SpecialSearchResults" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface SpecialSearchResultsHook {
/**
* This hook is called before search result display
*
* @since 1.35
*
* @param string $term Search term
* @param ?ISearchResultSet &$titleMatches Empty or ISearchResultSet object
* @param ?ISearchResultSet &$textMatches Empty or ISearchResultSet object
* @return bool|void True or no return value to continue or false to abort
*/
public function onSpecialSearchResults( $term, &$titleMatches, &$textMatches );
}