Merge "(Bug 41580) Hook for custom search hit rendering."
authorAaron Schulz <aschulz@wikimedia.org>
Wed, 7 Nov 2012 00:55:41 +0000 (00:55 +0000)
committerGerrit Code Review <gerrit@wikimedia.org>
Wed, 7 Nov 2012 00:55:41 +0000 (00:55 +0000)
1  2 
docs/hooks.txt

diff --combined docs/hooks.txt
@@@ -1831,6 -1831,21 +1831,21 @@@ $result: The search resul
  $terms: The search terms entered
  $page: The SpecialSearch object.
  
+ 'ShowSearchHit': Customize display of search hit.
+ $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.
  'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
  &$siteNotice: HTML returned as the sitenotice
  $skin: Skin object
@@@ -2110,7 -2125,7 +2125,7 @@@ $result: Boolean; whether MediaWiki cur
  Allows overriding default behaviour for determining if a page exists.
  If $isKnown is kept as null, regular checks happen. If it's a boolean, this value is returned by the isKnown method.
  $title: Title object that is being checked
 -$result: Boolean|null; whether MediaWiki currently thinks this page is known
 +&$isKnown: Boolean|null; whether MediaWiki currently thinks this page is known
  
  'TitleIsMovable': Called when determining if it is possible to move a page.
  Note that this hook is not called for interwiki pages or pages in immovable namespaces: for these, isMovable() always returns false.