From: Thiemo Mättig <thiemo.maettig@wikimedia.de>
Date: Fri, 20 Jan 2017 09:40:28 +0000 (+0100)
Subject: Update docs/hooks.txt for ShowSearchHitTitle
X-Git-Tag: 1.31.0-rc.0~4270^2
X-Git-Url: http://git.cyclocoop.org///%22%40url%40//%22?a=commitdiff_plain;h=fa6ade726260374fb2b1febb162ccfcd8c4a6058;p=lhc%2Fweb%2Fwiklou.git

Update docs/hooks.txt for ShowSearchHitTitle

Reasons:
* $text is vague. It's the label of the link. There is a function named
  getTitleSnippet, which is what I'm reusing for the variable name.
* $page is vague. It's not the page of the search result, but the search
  special page.
* $queryString is not a string but an array of strings.

I also updated https://www.mediawiki.org/wiki/Manual:Hooks/ShowSearchHitTitle
accordingly.

Change-Id: Ia18dbf5ccf7f9fcc8890ad01641d0b7ff3e6eee8
---

diff --git a/docs/hooks.txt b/docs/hooks.txt
index c5b112dd37..803c20da66 100644
--- a/docs/hooks.txt
+++ b/docs/hooks.txt
@@ -2823,11 +2823,11 @@ $terms: Search terms, for highlighting
 
 'ShowSearchHitTitle': Customise display of search hit title/link.
 &$title: Title to link to
-&$text: Text to use for the link
-$result: The search result
-$terms: The search terms entered
-$page: The SpecialSearch object
-&$query: Query string to be appended to the link
+&$titleSnippet: Label for the link representing the search result. Typically the article title.
+$result: The SearchResult object
+$terms: String of the search terms entered
+$specialSearch: The SpecialSearch object
+&$query: Array of query string parameters for the link representing the search result.
 
 'SidebarBeforeOutput': Allows to edit sidebar just before it is output by skins.
 Warning: This hook is run on each display. You should consider to use
diff --git a/includes/widget/search/FullSearchResultWidget.php b/includes/widget/search/FullSearchResultWidget.php
index 69bfa6d85c..0d0fa12411 100644
--- a/includes/widget/search/FullSearchResultWidget.php
+++ b/includes/widget/search/FullSearchResultWidget.php
@@ -131,16 +131,16 @@ class FullSearchResultWidget implements SearchResultWidget {
 
 		// clone to prevent hook from changing the title stored inside $result
 		$title = clone $result->getTitle();
-		$queryString = [];
+		$query = [];
 
 		Hooks::run( 'ShowSearchHitTitle',
-			[ &$title, &$snippet, $result, $terms, $this->specialPage, &$queryString ] );
+			[ &$title, &$snippet, $result, $terms, $this->specialPage, &$query ] );
 
 		$link = $this->linkRenderer->makeLink(
 			$title,
 			$snippet,
 			[ 'data-serp-pos' => $position ],
-			$queryString
+			$query
 		);
 
 		return $link;