public function SearchIndexingInterface::indexStatus in Drupal 9

Same name and namespace in other branches

1. 8 core/modules/search/src/Plugin/SearchIndexingInterface.php \Drupal\search\Plugin\SearchIndexingInterface::indexStatus()
2. 10 core/modules/search/src/Plugin/SearchIndexingInterface.php \Drupal\search\Plugin\SearchIndexingInterface::indexStatus()

Reports the status of indexing.

The core search module only invokes this method on active module plugins. Implementing modules do not need to check whether they are active when calculating their return values.

Return value

array An associative array with the key-value pairs:

• remaining: The number of items left to index.
• total: The total number of items to index.

2 methods override SearchIndexingInterface::indexStatus()

HelpSearch::indexStatus in core/modules/help_topics/src/Plugin/Search/HelpSearch.php

Reports the status of indexing.

NodeSearch::indexStatus in core/modules/node/src/Plugin/Search/NodeSearch.php

Reports the status of indexing.

File

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

Class

SearchIndexingInterface

Defines an optional interface for SearchPlugin objects using an index.

Namespace

Drupal\search\Plugin

Code

public function indexStatus();