API Reference / API Parameters / highlightPostTag

Feb. 26, 2019

highlightPostTag

Type: string

Engine default: "</em>"

Parameter syntax

'highlightPostTag' => 'closing_tag'

highlightPostTag: 'closing_tag'

highlightPostTag: 'closing_tag'

'highlightPostTag': 'closing_tag'

"highlightPostTag": "closing_tag"

highlightPostTag: String = "closing_tag"

new JSONObject()
  .put("highlightPostTag", "closing_tag")

IndexSettings settings = new IndexSettings()
settings.HighlightPostTag = "closing_tag";

.setHighlightPostTag("closing_tag")

opt.HighlightPostTag("closing_tag")

highlightPostTag = Some("closing_tag")

Can be used in these methods:
search, setSettings, browseObjects, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, set_settings, browse, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, setSettings, browse, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, set_settings, browse_objects, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, setSettings, browse, searchForFacetValues search, setSettings, browseObjects, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey searchAsync, setSettingsAsync, browseAsync, searchForFacetValues Search, SetSettings, Browse, SearchForFacetValues, GenerateSecuredApiKey, AddApiKey, UpdateApiKey Search, setSettings, browse, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey Search, SetSettings, BrowseObjects, SearchForFacetValues, GenerateSecuredAPIKey, AddAPIKey, UpdateAPIKey search, setSettings, browse index, search into facet values, generateSecuredApiKey, add key, update key

See code examples

About this parameter

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

Usage notes:

highlightPostTag needs to be used along with highlightPreTag.

Examples

Set default highlight post tag

Copy

$index->setSettings([
  'highlightPostTag' => '</em>'
]);

Override default highlight post tag for the current search

Copy

$results = $index->search('query', [
  'highlightPostTag' => '</strong>'
]);

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

PHP

Ruby

JavaScript

Python

iOS

Kotlin

Android

.NET

Java

Golang

Scala

InstantSearch.js

React InstantSearch

Vue InstantSearch

Angular InstantSearch

iOS InstantSearch

Android InstantSearch

Index settings and search parameters

A full reference of API Endpoints

Rails

Symfony

Django

Laravel

Magento 1

Magento 2

WordPress

Shopify

highlightPostTag

About this parameter

Usage notes:

Examples

Set default highlight post tag

Override default highlight post tag for the current search

Did you find this page helpful?

On this page