class MigrateProcessPlugin in Drupal 10

Defines a migration process plugin annotation object.

Plugin Namespace: Plugin\migrate\process

For a working example, see \Drupal\migrate\Plugin\migrate\process\DefaultValue

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\migrate\Annotation\MigrateProcessPlugin

See also

\Drupal\migrate\Plugin\MigratePluginManager

\Drupal\migrate\Plugin\MigrateProcessInterface

\Drupal\migrate\ProcessPluginBase

\Drupal\migrate\Annotation\MigrateSource

\Drupal\migrate\Annotation\MigrateDestination

Plugin API

Related topics

Annotations

Annotations for class discovery and metadata description.

Migrate API

Overview of the Migrate API, which migrates data into Drupal.

1 string reference to 'MigrateProcessPlugin'

migrate.services.yml in core/modules/migrate/migrate.services.yml

core/modules/migrate/migrate.services.yml

78 classes are annotated with MigrateProcessPlugin

ArrayBuild in core/modules/migrate/src/Plugin/migrate/process/ArrayBuild.php

Builds an array based on the key and value configuration.

BlockPluginId in core/modules/block/src/Plugin/migrate/process/BlockPluginId.php

Plugin annotation @MigrateProcessPlugin( id = "block_plugin_id" )

BlockRegion in core/modules/block/src/Plugin/migrate/process/BlockRegion.php

Plugin annotation @MigrateProcessPlugin( id = "block_region" )

BlockSettings in core/modules/block/src/Plugin/migrate/process/BlockSettings.php

Plugin annotation @MigrateProcessPlugin( id = "block_settings" )

BlockTheme in core/modules/block/src/Plugin/migrate/process/BlockTheme.php

Plugin annotation @MigrateProcessPlugin( id = "block_theme" )

... See full list

File

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

Namespace

Drupal\migrate\Annotation

class MigrateProcessPlugin extends Plugin {

  /**
   * A unique identifier for the process plugin.
   *
   * @var string
   */
  public $id;

  /**
   * 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.
   *
   * @var bool
   */
  public $handle_multiples = FALSE;

}

Members

Name	Modifiers	Type	Description	Overrides
MigrateProcessPlugin::$handle_multiples	public	property	Whether the plugin handles multiples itself.
MigrateProcessPlugin::$id	public	property	A unique identifier for the process plugin.
Plugin::$definition	protected	property	The plugin definition read from the class annotation.	1
Plugin::get	public	function	Gets the value of an annotation. Overrides AnnotationInterface::get	6
Plugin::getClass	public	function	Gets the class of the annotated class. Overrides AnnotationInterface::getClass	1
Plugin::getId	public	function	Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider	public	function	Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider	1
Plugin::parse	protected	function	Parses an annotation into its definition.
Plugin::setClass	public	function	Sets the class of the annotated class. Overrides AnnotationInterface::setClass	1
Plugin::setProvider	public	function	Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct	public	function	Constructs a Plugin object.	3