function MigrateStubInterface::createStub

Same name in other branches
  1. 8.9.x core/modules/migrate/src/MigrateStubInterface.php \Drupal\migrate\MigrateStubInterface::createStub()
  2. 10 core/modules/migrate/src/MigrateStubInterface.php \Drupal\migrate\MigrateStubInterface::createStub()
  3. 11.x core/modules/migrate/src/MigrateStubInterface.php \Drupal\migrate\MigrateStubInterface::createStub()

Creates a stub.

Parameters

string $migration_id: The migration to stub.

array $source_ids: An array of source ids.

array $default_values: (optional) An array of default values to add to the stub.

Return value

array|false An array of destination ids for the new stub, keyed by destination id key, or false if the stub failed.

1 method overrides MigrateStubInterface::createStub()
MigrateStub::createStub in core/modules/migrate/src/MigrateStub.php
Creates a stub.

File

core/modules/migrate/src/MigrateStubInterface.php, line 24

Class

MigrateStubInterface
Provides an interface for the migrate stub service.

Namespace

Drupal\migrate

Code

public function createStub($migration_id, array $source_ids, array $default_values = []);

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