MigrateProcessPlugin::$handle_multiples

Same name in other branches
  1. 8.9.x core/modules/migrate/src/Annotation/MigrateProcessPlugin.php \Drupal\migrate\Annotation\MigrateProcessPlugin::handle_multiples
  2. 10 core/modules/migrate/src/Annotation/MigrateProcessPlugin.php \Drupal\migrate\Annotation\MigrateProcessPlugin::handle_multiples
  3. 11.x core/modules/migrate/src/Annotation/MigrateProcessPlugin.php \Drupal\migrate\Annotation\MigrateProcessPlugin::handle_multiples

Whether the plugin handles multiples itself.

This property is optional and it does not need to be declared.

Typically these plugins will expect an array as input and iterate over it themselves, changing the whole array. For example the 'sub_process' and the 'flatten' plugins. If the plugin only need to change a single value it can skip setting this attribute and let \Drupal\migrate\MigrateExecutable::processRow() handle the iteration.

Type: bool

File

core/modules/migrate/src/Annotation/MigrateProcessPlugin.php, line 48

Class

MigrateProcessPlugin
Defines a migration process plugin annotation object.

Namespace

Drupal\migrate\Annotation

Code

public $handle_multiples = FALSE;

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