MediaWiki\Search\Hook\ShowSearchHitTitleHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions
	onShowSearchHitTitle (&$title, &$titleSnippet, $result, $terms, $specialSearch, &$query, &$attributes)
	Use this hook to customise display of search hit title/link.

Detailed Description

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

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

Stability: stable

to implement

Definition at line 17 of file ShowSearchHitTitleHook.php.

Member Function Documentation

onShowSearchHitTitle()

MediaWiki\Search\Hook\ShowSearchHitTitleHook::onShowSearchHitTitle	(	&	$title,
		&	$titleSnippet,
			$result,
			$terms,
			$specialSearch,
		&	$query,
		&	$attributes )

Use this hook to customise display of search hit title/link.

Since

1.35

Parameters

Title	&$title	Title to link to
string | HtmlArmor | null	&$titleSnippet	Label for the link representing the search result. Typically the article title.
SearchResult	$result
array	$terms	Array of search terms extracted by SearchDatabase search engines (may not be populated by other search engines)
SpecialSearch	$specialSearch
string[]	&$query	Array of query string parameters for the link representing the search result
string[]	&$attributes	Array of title link attributes, can be modified by extension

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/ShowSearchHitTitleHook.php