SolrQuery::setHighlightQuery
PHP Manual
PHP Manual»SolrQuery»SolrQuery::setHighlightQuery

SolrQuery::setHighlightQuery

(PECL solr >= 2.7.0)

SolrQuery::setHighlightQuery — A query designated for highlighting

Description

public function SolrQuery::setHighlightQuery(string $q): SolrQuery

A query to use for highlighting and which will be set as the value of the Solr hl.q parameter. This parameter allows one to highlight different terms or fields than those being used to retrieve documents.

Default value when not set: the value of the request's q parameter.

See the » Highlighting section for more details about the Solr hl.q parameter.

Parameters

q

Highlight Query.

Return Values

Returns the current SolrQuery object.

See Also

To Top