Change record status: 
Introduced in branch: 
8.x-7.x
Introduced in version: 
8.x-7.0-alpha6
Description: 

The hook_elasticsearch_connector_load_library_options_alter() hook is used to modify the connector library options in the elasticsearch_connector:8.x-7.x release series.

hook_elasticsearch_connector_load_library_options_alter() has been deprecated in elasticsearch_connector:8.x-7.0-alpha6 and has been removed from elasticsearch_connector:8.0.0.

To modify the connector library options, Elasticsearch Connector 8.0.0 uses Drupal's plugin API to define connection types.

Define a new connection type

To define a new connection type, create a class that implements \Drupal\elasticsearch_connector\Connector\ElasticSearchConnectorInterface and is annotated with the \Drupal\elasticsearch_connector\Annotation\ElasticSearchConnector annotation. For example...

Elasticsearch Connector 8.x-7.x code Elasticsearch Connector 8.0.x code

Old code in mymodule.module:

function mymodule_elasticsearch_connector_load_library_options_alter(&$options, &$cluster) {
  $options['my_connector'] = [
    ... // Define connection parameters here.
  ];
}

New code in src/Plugin/ElasticSearch/Connector/MyConnector.php:


namespace Drupal\mymodule\Plugin\ElasticSearch\Connector;

/**
 * @ElasticSearchConnector(
 *   id = "my_connector",
 *   label = @Translation("My connector"),
 *   description = @Translation("Lorem ipsum dolor sit amet."),
 * )
 */
class MyConnector extends PluginBase implements ElasticSearchConnectorInterface {
  ... // Define connection parameters here.
}

Two additional examples are present in the Elasticsearch Connector 8.0.x branch's src/Plugin/ElasticSearch/Connector/ folder

Impacts: 
Site builders, administrators, editors
Module developers