array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'en', ), 'this' => array ( 0 => 'solrquery.gethighlightquery.php', 1 => 'SolrQuery::getHighlightQuery', 2 => 'Return the highlight query', ), 'up' => array ( 0 => 'class.solrquery.php', 1 => 'SolrQuery', ), 'prev' => array ( 0 => 'solrquery.gethighlightmergecontiguous.php', 1 => 'SolrQuery::getHighlightMergeContiguous', ), 'next' => array ( 0 => 'solrquery.gethighlightregexmaxanalyzedchars.php', 1 => 'SolrQuery::getHighlightRegexMaxAnalyzedChars', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'reference/solr/solrquery/gethighlightquery.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

SolrQuery::getHighlightQuery

(PECL solr >= 2.7.0)

SolrQuery::getHighlightQuery — Return the highlight query

Description

public function SolrQuery::getHighlightQuery(): ?string

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

This function has no 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