X-Git-Url: http://aleph1.co.uk/gitweb/?a=blobdiff_plain;f=web%2Fcore%2Fmodules%2Fmigrate%2Fsrc%2FPlugin%2Fmigrate%2Fdestination%2FEntityBaseFieldOverride.php;h=e6b3682eb0bb1e8e3575e956f0b3f8d2eb130884;hb=5b8bb166bfa98770daef9de5c127fc2e6ef02340;hp=75232490b7b325932cd7ae7d7302bca592ab5cf7;hpb=a2bd1bf0c2c1f1a17d188f4dc0726a45494cefae;p=yaffs-website

diff --git a/web/core/modules/migrate/src/Plugin/migrate/destination/EntityBaseFieldOverride.php b/web/core/modules/migrate/src/Plugin/migrate/destination/EntityBaseFieldOverride.php
index 75232490b..e6b3682eb 100644
--- a/web/core/modules/migrate/src/Plugin/migrate/destination/EntityBaseFieldOverride.php
+++ b/web/core/modules/migrate/src/Plugin/migrate/destination/EntityBaseFieldOverride.php
@@ -5,7 +5,42 @@ namespace Drupal\migrate\Plugin\migrate\destination;
 use Drupal\migrate\Row;
 
 /**
- * Provides entity base field override plugin.
+ * Provides entity base field override destination plugin.
+ *
+ * Base fields are non-configurable fields that always exist on a given entity
+ * type, like the 'title', 'created' and 'sticky' fields of the 'node' entity
+ * type. Some entity types can have bundles, for example the node content types.
+ * The base fields exist on all bundles but the bundles can override the
+ * definitions. For example, the label for node 'title' base field can be
+ * different on different content types.
+ *
+ * Example:
+ *
+ * The example below migrates the node 'sticky' settings for each content type.
+ * @code
+ * id: d6_node_setting_sticky
+ * label: Node type 'sticky' setting
+ * migration_tags:
+ *   - Drupal 6
+ * source:
+ *   plugin: d6_node_type
+ *   constants:
+ *     entity_type: node
+ *     field_name: sticky
+ * process:
+ *   entity_type: 'constants/entity_type'
+ *   bundle: type
+ *   field_name: 'constants/field_name'
+ *   label:
+ *     plugin: default_value
+ *     default_value: 'Sticky at the top of lists'
+ *   'default_value/0/value': 'options/sticky'
+ * destination:
+ *   plugin: entity:base_field_override
+ * migration_dependencies:
+ *   required:
+ *     - d6_node_type
+ * @endcode
  *
  * @MigrateDestination(
  *   id = "entity:base_field_override"