class MigrateDestination

Same name in other branches
  1. 9 core/modules/migrate/src/Annotation/MigrateDestination.php \Drupal\migrate\Annotation\MigrateDestination
  2. 8.9.x core/modules/migrate/src/Annotation/MigrateDestination.php \Drupal\migrate\Annotation\MigrateDestination
  3. 11.x core/modules/migrate/src/Annotation/MigrateDestination.php \Drupal\migrate\Annotation\MigrateDestination
  4. 11.x core/modules/migrate/src/Attribute/MigrateDestination.php \Drupal\migrate\Attribute\MigrateDestination

Defines a MigrateDestination attribute.

Plugin Namespace: Plugin\migrate\destination

For a working example, see \Drupal\migrate\Plugin\migrate\destination\UrlAlias

Attributes

#[\Attribute(\Attribute::TARGET_CLASS)]

Hierarchy

  • class \Drupal\migrate\Attribute\MigrateDestination extends \Drupal\Component\Plugin\Attribute\Plugin

Expanded class hierarchy of MigrateDestination

See also

\Drupal\migrate\Plugin\MigrateDestinationPluginManager

\Drupal\migrate\Plugin\MigrateDestinationInterface

\Drupal\migrate\Plugin\migrate\destination\DestinationBase

\Drupal\migrate\Attribute\MigrateProcess

Plugin API

Related topics

32 files declare their use of MigrateDestination
BlockedIp.php in core/modules/ban/src/Plugin/migrate/destination/BlockedIp.php
Book.php in core/modules/book/src/Plugin/migrate/destination/Book.php
Config.php in core/modules/migrate/src/Plugin/migrate/destination/Config.php
DefaultLangcode.php in core/modules/language/src/Plugin/migrate/destination/DefaultLangcode.php
DummyDestination.php in core/modules/migrate/tests/modules/migrate_events_test/src/Plugin/migrate/destination/DummyDestination.php

... See full list

File

core/modules/migrate/src/Attribute/MigrateDestination.php, line 25

Namespace

Drupal\migrate\Attribute
View source
class MigrateDestination extends Plugin {
    
    /**
     * Constructs a migrate destination plugin attribute object.
     *
     * @param string $id
     *   A unique identifier for the destination plugin.
     * @param bool $requirements_met
     *   (optional) Whether requirements are met.
     * @param string|null $destination_module
     *   (optional) Identifies the system handling the data the destination plugin
     *   will write. The destination plugin itself determines how the value is
     *   used. For example, Migrate's destination plugins expect
     *   destination_module to be the name of a module that must be installed on
     *   the destination.
     * @param class-string|null $deriver
     *   (optional) The deriver class.
     */
    public function __construct(string $id, bool $requirements_met = TRUE, ?string $destination_module = NULL, ?string $deriver = NULL) {
    }

}

Members

Title Sort descending Modifiers Object type Summary
MigrateDestination::__construct public function Constructs a migrate destination plugin attribute object.

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