Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
Total | n/a |
0 / 0 |
n/a |
0 / 0 |
CRAP | n/a |
0 / 0 |
1 | <?php |
2 | |
3 | namespace MediaWiki\Hook; |
4 | |
5 | use MediaWiki\Output\OutputPage; |
6 | use MediaWiki\Specials\SpecialSearch; |
7 | |
8 | /** |
9 | * This is a hook handler interface, see docs/Hooks.md. |
10 | * Use the hook name "SpecialSearchResultsPrepend" to register handlers implementing this interface. |
11 | * |
12 | * @stable to implement |
13 | * @ingroup Hooks |
14 | */ |
15 | interface SpecialSearchResultsPrependHook { |
16 | /** |
17 | * This hook is called immediately before returning HTML on the search results page. |
18 | * |
19 | * Useful for including an external search provider. |
20 | * To disable the output of MediaWiki search output, return false. |
21 | * |
22 | * @since 1.35 |
23 | * |
24 | * @param SpecialSearch $specialSearch SpecialSearch object ($this) |
25 | * @param OutputPage $output $wgOut |
26 | * @param string $term Search term specified by the user |
27 | * @return bool|void True or no return value to continue or false to abort |
28 | */ |
29 | public function onSpecialSearchResultsPrepend( $specialSearch, $output, $term ); |
30 | } |