MediaWiki REL1_35
Public Member Functions | List of all members
MediaWiki\Search\Hook\SearchResultsAugmentHook Interface Reference
Hooks

Stable to implement. More...

Inheritance diagram for MediaWiki\Search\Hook\SearchResultsAugmentHook:
Inheritance graph
[legend]

Public Member Functions

 onSearchResultsAugment (&$setAugmentors, &$rowAugmentors)
 Use this hook to add code to the list of search result augmentors.
 

Detailed Description

Stable to implement.

Definition at line 12 of file SearchResultsAugmentHook.php.

Member Function Documentation

◆ onSearchResultsAugment()

MediaWiki\Search\Hook\SearchResultsAugmentHook::onSearchResultsAugment ( &  $setAugmentors,
&  $rowAugmentors 
)

Use this hook to add code to the list of search result augmentors.

Since
1.35
Parameters
ResultSetAugmentor[]&$setAugmentorsList of whole-set augmentor objects, must implement ResultSetAugmentor
ResultAugmentor[]&$rowAugmentorsList of per-row augmentor objects, must implement ResultAugmentor. Note that lists should be in the format name => object and the names in both lists should be distinct.
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: