MediaWiki  master
MediaWiki\Hook\SpecialSearchResultsAppendHook Interface Reference

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

Inheritance diagram for MediaWiki\Hook\SpecialSearchResultsAppendHook:

Public Member Functions

 onSpecialSearchResultsAppend ( $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 "SpecialSearchResultsAppend" to register handlers implementing this interface.

Stable to implement

Definition at line 15 of file SpecialSearchResultsAppendHook.php.

Member Function Documentation

◆ onSpecialSearchResultsAppend()

MediaWiki\Hook\SpecialSearchResultsAppendHook::onSpecialSearchResultsAppend (   $specialSearch,
  $output,
  $term 
)

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

Useful for including a feedback link.

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: