API Reference / API Parameters / highlightPreTag
Feb. 26, 2019

highlightPreTag

Type: string
Engine default: "<em>"
Parameter syntax
'highlightPreTag' => 'opening_tag'

Can be used in these methods:
search, setSettings, browseObjects, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey

About this parameter#

The HTML string to insert before the highlighted parts in all highlight and snippet results.

Usage notes:#

Examples#

Set default highlight pre tag#

Edit
1
2
3
$index->setSettings([
  'highlightPreTag' => '<em>'
]);

Override default highlight pre tag for the current search#

Edit
1
2
3
$results = $index->search('query', [
  'highlightPreTag' => '<strong>'
]);

Did you find this page helpful?

PHP