MediaWiki  master
MediaWiki\Search\Hook\ShowSearchHitTitleHook Interface Reference

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

Inheritance diagram for MediaWiki\Search\Hook\ShowSearchHitTitleHook:

Public Member Functions

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

Detailed Description

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

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

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&$titleTitle to link to
string | HtmlArmor | null&$titleSnippetLabel for the link representing the search result. Typically the article title.
SearchResult$result
array$termsArray of search terms extracted by SearchDatabase search engines (may not be populated by other search engines)
SpecialSearch$specialSearch
string[]&$queryArray of query string parameters for the link representing the search result
string[]&$attributesArray 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: