1	<?php
2
3	namespace MediaWiki\Search\Hook;
4
5	use ResultAugmentor;
6	use ResultSetAugmentor;
7
8	/**
9	* This is a hook handler interface, see docs/Hooks.md.
10	* Use the hook name "SearchResultsAugment" to register handlers implementing this interface.
11	*
12	* @stable to implement
13	* @ingroup Hooks
14	*/
15	interface SearchResultsAugmentHook {
16	/**
17	* Use this hook to add code to the list of search result augmentors.
18	*
19	* @since 1.35
20	*
21	* @param ResultSetAugmentor[] &$setAugmentors List of whole-set augmentor objects,
22	*   must implement ResultSetAugmentor
23	* @param ResultAugmentor[] &$rowAugmentors List of per-row augmentor objects,
24	*   must implement ResultAugmentor. Note that lists should be in the format
25	*   name => object and the names in both lists should be distinct.
26	* @return bool|void True or no return value to continue or false to abort
27	*/
28	public function onSearchResultsAugment( &$setAugmentors, &$rowAugmentors );
29	}