class Concat

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

Concatenates a set of strings.

The concat plugin is used to concatenate strings. For example, imploding a set of strings into a single string.

Available configuration keys:

  • delimiter: (optional) A delimiter, or glue string, to insert between the strings.


    plugin: concat
      - foo
      - bar

This will set new_text_field to the concatenation of the 'foo' and 'bar' source values. For example, if the 'foo' property is "Rosa" and the 'bar' property is "Parks", new_text_field will be "RosaParks".

You can also specify a delimiter.

    plugin: concat
      - foo
      - bar
    delimiter: /

This will set new_text_field to the concatenation of the 'foo' source value, the delimiter and the 'bar' source value. For example, using the values above and "/" as the delimiter, if the 'foo' property is "Rosa" and the 'bar' property is "Rosa", new_text_field will be "Rosa/Parks".


Expanded class hierarchy of Concat

See also


2 files declare their use of Concat
ConcatTest.php in core/modules/migrate/tests/src/Unit/process/ConcatTest.php
ExplodeTest.php in core/modules/migrate/tests/src/Unit/process/ExplodeTest.php
24 string references to 'Concat'
Connection::open in core/modules/sqlite/src/Driver/Database/sqlite/Connection.php
Opens a client connection.
d6_comment_type.yml in core/modules/comment/migrations/d6_comment_type.yml
d6_file.yml in core/modules/file/migrations/d6_file.yml
d6_language_content_comment_settings.yml in core/modules/content_translation/migrations/d6_language_content_comment_settings.yml
d6_system_site_translation.yml in core/modules/config_translation/migrations/d6_system_site_translation.yml

... See full list


core/modules/migrate/src/Plugin/migrate/process/Concat.php, line 55


View source
class Concat extends ProcessPluginBase {
     * {@inheritdoc}
    public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
        if (is_array($value)) {
            $delimiter = $this->configuration['delimiter'] ?? '';
            return implode($delimiter, $value);
        else {
            throw new MigrateException(sprintf('%s is not an array', var_export($value, TRUE)));



Title Sort descending Modifiers Object type Summary Overriden Title Overrides
Concat::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::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.

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