MediaWiki\Widget\Search\SearchResultWidget Interface Reference

Renders a single search result to HTML. More...

Inheritance diagram for MediaWiki\Widget\Search\SearchResultWidget:

Public Member Functions
	render (SearchResult $result, $terms, $position)

Detailed Description

Renders a single search result to HTML.

Definition at line 10 of file SearchResultWidget.php.

Member Function Documentation

render()

MediaWiki\Widget\Search\SearchResultWidget::render	(	SearchResult	$result,
			$terms,
			$position
	)

Parameters

SearchResult	$result	The result to render
string	$terms	Terms to be highlighted (

See also

SearchResult::getTextSnippet)

Parameters

int

$position

The zero indexed result position, including offset

Returns

string HTML

Implemented in MediaWiki\Widget\Search\FullSearchResultWidget, MediaWiki\Widget\Search\SimpleSearchResultWidget, and MediaWiki\Widget\Search\InterwikiSearchResultWidget.

---

The documentation for this interface was generated from the following file:

• includes/widget/search/SearchResultWidget.php