function hook_search_api_solr_documents_alter in Search API Solr 8

Same name and namespace in other branches

1. 8.3 search_api_solr.api.php \hook_search_api_solr_documents_alter()
2. 8.2 search_api_solr.api.php \hook_search_api_solr_documents_alter()
3. 7 search_api_solr.api.php \hook_search_api_solr_documents_alter()
4. 4.x search_api_solr.api.php \hook_search_api_solr_documents_alter()

Alter Solr documents before they are sent to Solr for indexing.

Parameters

\Solarium\QueryType\Update\Query\Document\Document[] $documents: An array of \Solarium\QueryType\Update\Query\Document\Document objects ready to be indexed, generated from $items array.

\Drupal\search_api\IndexInterface $index: The search index for which items are being indexed.

\Drupal\search_api\Item\ItemInterface[] $items: An array of items to be indexed, keyed by their item IDs.

1 invocation of hook_search_api_solr_documents_alter()

SearchApiSolrBackend::getDocuments in src/Plugin/search_api/backend/SearchApiSolrBackend.php

Retrieves Solr documents from search api index items.

File

./search_api_solr.api.php, line 56

Hooks provided by the Search API Solr search module.

Code

function hook_search_api_solr_documents_alter(&$documents, \Drupal\search_api\IndexInterface $index, array $items) {

  // Adds a "foo" field with value "bar" to all documents.
  foreach ($documents as $document) {
    $document
      ->setField('foo', 'bar');
  }
}