public function SearchIndexingInterface::indexStatus in Drupal 10

Same name and namespace in other branches

1. 8 core/modules/search/src/Plugin/SearchIndexingInterface.php \Drupal\search\Plugin\SearchIndexingInterface::indexStatus()
2. 9 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.

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();