MediaWiki  master
MediaWiki\Hook\SpecialSearchResultsPrependHook Interface Reference

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

Inheritance diagram for MediaWiki\Hook\SpecialSearchResultsPrependHook:

Public Member Functions

 onSpecialSearchResultsPrepend ( $specialSearch, $output, $term)
 This hook is called immediately before returning HTML on the search results page. More...
 

Detailed Description

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

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

Stable to implement

Definition at line 15 of file SpecialSearchResultsPrependHook.php.

Member Function Documentation

◆ onSpecialSearchResultsPrepend()

MediaWiki\Hook\SpecialSearchResultsPrependHook::onSpecialSearchResultsPrepend (   $specialSearch,
  $output,
  $term 
)

This hook is called immediately before returning HTML on the search results page.

Useful for including an external search provider. To disable the output of MediaWiki search output, return false.

Since
1.35
Parameters
SpecialSearch$specialSearchSpecialSearch object ($this)
OutputPage$output$wgOut
string$termSearch term specified by the user
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: