function MigrateIdMapInterface::delete

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

Deletes the map and message entries for a given source record.

Parameters

array $source_id_values: The source identifier keyed values of the record, e.g. ['nid' => 5].

bool $messages_only: (optional) TRUE to only delete the migrate messages. Defaults to FALSE.

2 methods override MigrateIdMapInterface::delete()
NullIdMap::delete in core/modules/migrate/src/Plugin/migrate/id_map/NullIdMap.php
Deletes the map and message entries for a given source record.
Sql::delete in core/modules/migrate/src/Plugin/migrate/id_map/Sql.php
Deletes the map and message entries for a given source record.

File

core/modules/migrate/src/Plugin/MigrateIdMapInterface.php, line 183

Class

MigrateIdMapInterface
Defines an interface for migrate ID mappings.

Namespace

Drupal\migrate\Plugin

Code

public function delete(array $source_id_values, $messages_only = FALSE);

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