Manual:Hooks/ShowSearchHit

From MediaWiki.org
Jump to: navigation, search
ShowSearchHit
Available from version 1.21.0 (Gerrit change 32040)
Customize display of search hit.
Define function:
public static function onShowSearchHit( $searchPage, $result, $terms, &$link, 
&$redirect, &$section, &$extract, &$score, &$size, &$date, &$related, &$html ) { ... }
Attach hook:

In extension.json:

{
	"Hooks": {
		"ShowSearchHit": "MyExtensionHooks::onShowSearchHit"
	}
}

For MediaWiki ≤1.25:

$wgHooks['ShowSearchHit'][] = 'MyExtensionHooks::onShowSearchHit';
Called from: File(s): SpecialSearch.php

For more information about attaching hooks, see Manual:Hooks.
For examples of extensions using this hook, see Category:ShowSearchHit extensions.

Details[edit]

  • $searchPage: The SpecialSearch instance.
  • $result: The SearchResult to show
  • $terms: Search terms, for highlighting
  • &$link: HTML of link to the matching page. May be modified.
  • &$redirect: HTML of redirect info. May be modified.
  • &$section: HTML of matching section. May be modified.
  • &$extract: HTML of content extract. May be modified.
  • &$score: HTML of score. May be modified.
  • &$size: HTML of page size. May be modified.
  • &$date: HTML of of page modification date. May be modified.
  • &$related: HTML of additional info for the matching page. May be modified.
  • &$html: May be set to the full HTML that should be used to represent the search hit. Must include the <li> ... </li> tags. Will only be used if the hook function returned false.