function SearchIndexingInterface::indexClear

Same name in other branches
  1. 9 core/modules/search/src/Plugin/SearchIndexingInterface.php \Drupal\search\Plugin\SearchIndexingInterface::indexClear()
  2. 8.9.x core/modules/search/src/Plugin/SearchIndexingInterface.php \Drupal\search\Plugin\SearchIndexingInterface::indexClear()
  3. 10 core/modules/search/src/Plugin/SearchIndexingInterface.php \Drupal\search\Plugin\SearchIndexingInterface::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.

See also

\Drupal\search\SearchIndexInterface::clear()

2 methods override SearchIndexingInterface::indexClear()
HelpSearch::indexClear in core/modules/help/src/Plugin/Search/HelpSearch.php
Clears the search index for this plugin.
NodeSearch::indexClear in core/modules/node/src/Plugin/Search/NodeSearch.php
Clears the search index for this plugin.

File

core/modules/search/src/Plugin/SearchIndexingInterface.php, line 57

Class

SearchIndexingInterface
Defines an optional interface for SearchPlugin objects using an index.

Namespace

Drupal\search\Plugin

Code

public function indexClear();

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.