class Get

Same name and namespace in other branches
  1. 9 core/modules/migrate/src/Plugin/migrate/process/Get.php \Drupal\migrate\Plugin\migrate\process\Get
  2. 8.9.x core/modules/migrate/src/Plugin/migrate/process/Get.php \Drupal\migrate\Plugin\migrate\process\Get
  3. 10 core/modules/migrate/src/Plugin/migrate/process/Get.php \Drupal\migrate\Plugin\migrate\process\Get

Gets the source value.

Available configuration keys:

  • source: Source property.

The get plugin returns the value of the property given by the "source" configuration key.


    plugin: get
    source: foo

This copies the source value of foo to the destination property "bar".

Since get is the default process plugin, it can be shorthanded like this:


Get also supports a list of source properties.


    plugin: get
      - foo1
      - foo2

This copies the array of source values [foo1, foo2] to the destination property "bar".

If the list of source properties contains an empty element then the current value will be used. This makes it impossible to reach a source property with an empty string as its name.

Get also supports copying destination values. These are indicated by a starting @ sign. Values using @ must be wrapped in quotes.

    plugin: machine_name
    source: baz
    plugin: get
    source: '@foo'

This will simply copy the destination value of foo to the destination property bar. foo configuration is included for illustration purposes.

Because of this, if the source or destination property actually starts with a "@", that character must be escaped with "@@". The referenced property becomes, for example, "@@@foo".

    plugin: machine_name
    source: baz
    plugin: get
    source: '@@@foo'

This should occur extremely rarely.


Expanded class hierarchy of Get

See also


3 files declare their use of Get
GetTest.php in core/modules/migrate/tests/src/Unit/process/GetTest.php
MigrateProcessErrorMessagesTest.php in core/modules/migrate/tests/src/Kernel/MigrateProcessErrorMessagesTest.php
SubProcessTest.php in core/modules/migrate/tests/src/Unit/process/SubProcessTest.php
314 string references to 'Get'
AcceptHeaderMatcherTest::testAcceptFiltering in core/tests/Drupal/Tests/Core/Routing/AcceptHeaderMatcherTest.php
Tests that requests using Accept headers get filtered correctly.
AcceptHeaderMatcherTest::testNoRouteFound in core/tests/Drupal/Tests/Core/Routing/AcceptHeaderMatcherTest.php
Confirms that the AcceptHeaderMatcher throws an exception for no-route.
AliasTest::testWhitelist in core/modules/path_alias/tests/src/Kernel/AliasTest.php
Tests the alias whitelist.
AreaDisplayLinkTest::testAreaDisplayLink in core/modules/views/tests/src/Kernel/Handler/AreaDisplayLinkTest.php
Tests the views area display_link handler.
BasicAuthResourceTestTrait::assertResponseWhenMissingAuthentication in core/modules/rest/tests/src/Functional/BasicAuthResourceTestTrait.php

... See full list


core/modules/migrate/src/Plugin/migrate/process/Get.php, line 91


View source
class Get extends ProcessPluginBase {
     * Flag indicating whether there are multiple values.
     * @var bool
    protected $multiple;
     * {@inheritdoc}
    public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
        $source = $this->configuration['source'];
        $properties = is_string($source) ? [
        ] : $source;
        $return = [];
        foreach ($properties as $property) {
            if ($property || (string) $property === '0') {
                $return[] = $row->get($property);
            else {
                $return[] = $value;
        if (is_string($source)) {
            $this->multiple = is_array($return[0]);
            return $return[0];
        return $return;
     * {@inheritdoc}
    public function multiple() {
        return $this->multiple;



Title Sort descending Modifiers Object type Summary Overriden Title Overrides
Get::$multiple protected property Flag indicating whether there are multiple values.
Get::multiple public function Indicates whether the returned value requires multiple handling. Overrides ProcessPluginBase::multiple
Get::transform public function Performs the associated process. Overrides ProcessPluginBase::transform
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::reset public function Resets the internal data of a plugin. Overrides MigrateProcessInterface::reset
ProcessPluginBase::stopPipeline protected function Stops pipeline processing after this plugin finishes.

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