Manual:Hooks/SpecialSearchSetupEngine

Category:MediaWiki hooks#SpecialSearchSetupEngine Category:Hooks added in MediaWiki 1.18.0#SpecialSearchSetupEngine
SpecialSearchSetupEngine
Available from version 1.18.0 (r86714, CodeReview archive)
allows passing custom data to search engine
Define function:
public static function onSpecialSearchSetupEngine( $search, $profile, $engine ) { ... }
Attach hook: In extension.json:
{
	"Hooks": {
		"SpecialSearchSetupEngine": "MediaWiki\\Extension\\MyExtension\\Hooks::onSpecialSearchSetupEngine"
	}
}
Called from: File(s): specials/SpecialSearch.phpCategory:MediaWiki hooks included in SpecialSearch.php#SpecialSearchSetupEngine
Interface: SpecialSearchSetupEngineHook.php

For more information about attaching hooks, see Manual:Hooks .
For examples of extensions using this hook, see Category:SpecialSearchSetupEngine extensions.

Details

  • $search: special page object
  • $profile: String: current search profile
  • $engine: the search engine

See also

Category:Hooks added in MediaWiki 1.18.0 Category:MediaWiki hooks Category:MediaWiki hooks included in SpecialSearch.php