MediaWiki\Hook\SpecialSearchResultsHook Interface Reference

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

Inheritance diagram for MediaWiki\Hook\SpecialSearchResultsHook:

Public Member Functions
	onSpecialSearchResults ( $term, &$titleMatches, &$textMatches)
	This hook is called before search result display.

Detailed Description

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

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

Stability: stable

to implement

Definition at line 14 of file SpecialSearchResultsHook.php.

Member Function Documentation

onSpecialSearchResults()

MediaWiki\Hook\SpecialSearchResultsHook::onSpecialSearchResults	(		$term,
		&	$titleMatches,
		&	$textMatches
	)

This hook is called before search result display.

Since

1.35

Parameters

string	$term	Search term
	?ISearchResultSet	&$titleMatches Empty or ISearchResultSet object
	?ISearchResultSet	&$textMatches Empty or ISearchResultSet object

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/specials/Hook/SpecialSearchResultsHook.php