You are here

public function NodeSearch::indexClear in Drupal 8

Same name and namespace in other branches
  1. 9 core/modules/node/src/Plugin/Search/NodeSearch.php \Drupal\node\Plugin\Search\NodeSearch::indexClear()
  2. 10 core/modules/node/src/Plugin/Search/NodeSearch.php \Drupal\node\Plugin\Search\NodeSearch::indexClear()

Clears the search index for this plugin.

When a request is made to clear all items from the search index related to this plugin, this method will be called. If this plugin uses the default search index, this method can call clear($type) method on the search.index service class to remove indexed items from the search database.

Overrides SearchIndexingInterface::indexClear

See also

\Drupal\search\SearchIndexInterface::clear()

File

core/modules/node/src/Plugin/Search/NodeSearch.php, line 553

Class

NodeSearch
Handles searching for node entities using the Search module index.

Namespace

Drupal\node\Plugin\Search

Code

public function indexClear() {

  // All NodeSearch pages share a common search index "type" equal to
  // the plugin ID.
  $this->searchIndex
    ->clear($this
    ->getPluginId());
}