class ProcessPluginBase

Same name in this branch
  1. 11.x core/modules/migrate/tests/src/Unit/process/ProcessPluginBaseTest.php \Drupal\Tests\migrate\Unit\process\ProcessPluginBase
Same name and namespace in other branches
  1. 9 core/modules/migrate/src/ProcessPluginBase.php \Drupal\migrate\ProcessPluginBase
  2. 8.9.x core/modules/migrate/src/ProcessPluginBase.php \Drupal\migrate\ProcessPluginBase
  3. 10 core/modules/migrate/src/ProcessPluginBase.php \Drupal\migrate\ProcessPluginBase
  4. 10 core/modules/migrate/tests/src/Unit/process/ProcessPluginBaseTest.php \Drupal\Tests\migrate\Unit\process\ProcessPluginBase

The base class for all migrate process plugins.

Migrate process plugins are taking a value and transform them. For example, transform a human provided name into a machine name, look up an identifier in a previous migration and so on.

Process plugins extending this class can use any number of methods, thus offering different alternative ways of processing. In this case, the transform() method should not be implemented, and the plugin configuration must provide the name of the method to be called via the "method" key. Each method must have the same signature as transform().


Expanded class hierarchy of ProcessPluginBase

See also






Plugin API

Related topics

75 files declare their use of ProcessPluginBase
ArrayBuild.php in core/modules/migrate/src/Plugin/migrate/process/ArrayBuild.php
BlockPluginId.php in core/modules/block/src/Plugin/migrate/process/BlockPluginId.php
BlockSettings.php in core/modules/block/src/Plugin/migrate/process/BlockSettings.php
BlockTheme.php in core/modules/block/src/Plugin/migrate/process/BlockTheme.php
BlockVisibility.php in core/modules/block/src/Plugin/migrate/process/BlockVisibility.php

... See full list


core/modules/migrate/src/ProcessPluginBase.php, line 31


View source
abstract class ProcessPluginBase extends PluginBase implements MigrateProcessInterface {
     * Determines if processing of the pipeline is stopped.
     * @var bool
    protected bool $stopPipeline = FALSE;
     * {@inheritdoc}
    public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
        // Do not call this method from children.
        if (isset($this->configuration['method'])) {
            if (method_exists($this, $this->configuration['method'])) {
                return $this->{$this->configuration['method']}($value, $migrate_executable, $row, $destination_property);
            throw new \BadMethodCallException(sprintf('The %s method does not exist in the %s plugin.', $this->configuration['method'], $this->pluginId));
        else {
            throw new \BadMethodCallException(sprintf('The "method" key in the plugin configuration must to be set for the %s plugin.', $this->pluginId));
     * {@inheritdoc}
    public function multiple() {
        return FALSE;
     * {@inheritdoc}
    public function isPipelineStopped() : bool {
        return $this->stopPipeline;
     * {@inheritdoc}
    public function reset() : void {
        $this->stopPipeline = FALSE;
     * Stops pipeline processing after this plugin finishes.
    protected function stopPipeline() : void {
        $this->stopPipeline = TRUE;



Title Sort descending Modifiers Object type Summary Overriden Title Overrides
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
ProcessPluginBase::$stopPipeline protected property Determines if processing of the pipeline is stopped.
ProcessPluginBase::isPipelineStopped public function Determines if the pipeline should stop processing. Overrides MigrateProcessInterface::isPipelineStopped
ProcessPluginBase::multiple public function Indicates whether the returned value requires multiple handling. Overrides MigrateProcessInterface::multiple 3
ProcessPluginBase::reset public function Resets the internal data of a plugin. Overrides MigrateProcessInterface::reset
ProcessPluginBase::stopPipeline protected function Stops pipeline processing after this plugin finishes.
ProcessPluginBase::transform public function Performs the associated process. Overrides MigrateProcessInterface::transform 74

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