1<?php
2
3namespace MediaWiki\Hook;
4
5use SearchEngine;
6use SpecialSearch;
7
8/**
9 * This is a hook handler interface, see docs/Hooks.md.
10 * Use the hook name "SpecialSearchSetupEngine" to register handlers implementing this interface.
11 *
12 * @stable to implement
13 * @ingroup Hooks
14 */
15interface SpecialSearchSetupEngineHook {
16	/**
17	 * Use this hook for passing custom data to the search engine.
18	 *
19	 * @since 1.35
20	 *
21	 * @param SpecialSearch $search
22	 * @param string $profile Current search profile
23	 * @param SearchEngine $engine
24	 * @return bool|void True or no return value to continue or false to abort
25	 */
26	public function onSpecialSearchSetupEngine( $search, $profile, $engine );
27}
28