function MigratePluginManagerInterface::createInstance

Same name in other branches
  1. 9 core/modules/migrate/src/Plugin/MigratePluginManagerInterface.php \Drupal\migrate\Plugin\MigratePluginManagerInterface::createInstance()
  2. 8.9.x core/modules/migrate/src/Plugin/MigratePluginManagerInterface.php \Drupal\migrate\Plugin\MigratePluginManagerInterface::createInstance()
  3. 11.x core/modules/migrate/src/Plugin/MigratePluginManagerInterface.php \Drupal\migrate\Plugin\MigratePluginManagerInterface::createInstance()

Creates a pre-configured instance of a migration plugin.

A specific createInstance method is necessary to pass the migration on.

Parameters

string $plugin_id: The ID of the plugin being instantiated.

array $configuration: An array of configuration relevant to the plugin instance.

\Drupal\migrate\Plugin\MigrationInterface $migration: The migration context in which the plugin will run.

Return value

object A fully configured plugin instance.

Throws

\Drupal\Component\Plugin\Exception\PluginException If the instance cannot be created, such as if the ID is invalid.

File

core/modules/migrate/src/Plugin/MigratePluginManagerInterface.php, line 27

Class

MigratePluginManagerInterface

Namespace

Drupal\migrate\Plugin

Code

public function createInstance($plugin_id, array $configuration = [], ?MigrationInterface $migration = NULL);

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