Extension:WikiSearch/Hooks/WikiSearchOnLoadFrontend

From mediawiki.org
WikiSearchOnLoadFrontend
Available from version 4.0.0
This hook must be implemented by any WikiSearch frontend. It gets called when the #WikiSearchFrontend parser function is called.
Define function:
public static function onWikiSearchOnLoadFrontend( array &$results ) { ... }
Attach hook:
$wgHooks['WikiSearchOnLoadFrontend'][] = 'MyExtensionHooks::onWikiSearchOnLoadFrontend';
Called from:File(s): WikiSearch / src/WikiSearchHooks.php
Function(s): searchEngineFrontendCallback

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

Details[edit]

  • string &$result: The result of the call to the parser function. This is the text that will be transcluded on the page.
  • SearchEngineConfig $config: The SearchEngineConfig object of the current page.
  • Parser $parser: The current Parser object
  • array $parameters: The parameters passed to the #WikiSearchFrontend call