MediaWiki  master
MediaWiki\Hook\SpecialSearchSetupEngineHook Interface Reference

This is a hook handler interface, see docs/Hooks.md. More...

Inheritance diagram for MediaWiki\Hook\SpecialSearchSetupEngineHook:

Public Member Functions

 onSpecialSearchSetupEngine ( $search, $profile, $engine)
 Use this hook for passing custom data to the search engine. More...
 

Detailed Description

This is a hook handler interface, see docs/Hooks.md.

Use the hook name "SpecialSearchSetupEngine" to register handlers implementing this interface.

Stable to implement

Definition at line 15 of file SpecialSearchSetupEngineHook.php.

Member Function Documentation

◆ onSpecialSearchSetupEngine()

MediaWiki\Hook\SpecialSearchSetupEngineHook::onSpecialSearchSetupEngine (   $search,
  $profile,
  $engine 
)

Use this hook for passing custom data to the search engine.

Since
1.35
Parameters
SpecialSearch$search
string$profileCurrent search profile
SearchEngine$engine
Returns
bool|void True or no return value to continue or false to abort

Implemented in MediaWiki\HookContainer\HookRunner.


The documentation for this interface was generated from the following file: