MediaWiki\Search\Hook\SearchResultsAugmentHook Interface Reference

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

Inheritance diagram for MediaWiki\Search\Hook\SearchResultsAugmentHook:

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

Detailed Description

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

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

Stability: stable

to implement

Definition at line 15 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[]	&$setAugmentors	List of whole-set augmentor objects, must implement ResultSetAugmentor
ResultAugmentor[]	&$rowAugmentors	List 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:

• includes/search/Hook/SearchResultsAugmentHook.php