php8.5
Home/ Manual/ solr / solrquery/ SolrQuery::getHighlightQuery

SolrQuery::getHighlightQuery

PHP function Edit on GitHub ✎

(PECL solr >= 2.7.0)

Return the highlight query

Description

SolrQuery::getHighlightQuery(): string|null

Returns previously set highlight query from the hl.q parameter. This parameter allows you to highlight different terms or fields than those being used to retrieve documents. See the Highlighting section for more details.

Parameters Parameters

Return Values

Returns a string that contains the highlight query of the current SolrQuery, or null if highlight query is not set.

See Also

  • SolrQuery::setHighlightQuery
  • SolrQuery::getHighlightFields
  • SolrQuery::setHighlightFields

Source: reference/solr/solrquery/gethighlightquery.xml · from the official PHP manual (php/doc-en)