You are here

migrate.api.php in Migrate 6.2

Same filename and directory in other branches
  1. 6 migrate.api.php
  2. 7.2 migrate.api.php

Documentation for hooks defined by Migrate.

File

migrate.api.php
View source
<?php

/**
 * @file
 * Documentation for hooks defined by Migrate.
 */

/**
 * Registers your module as an implementor of Migrate-based classes.
 */
function hook_migrate_api() {
  $api = array(
    'api' => 2,
  );
  return $api;
}

/**
 * Provides text to be displayed at the top of the dashboard page (migrate_ui).
 */
function hook_migrate_overview() {
  return t('<p>Listed below are all the migration processes defined for migration
    of our old site to Drupal. Open issues applying to specific migrations
    can be viewed by clicking the migration name. Also, details on how each
    migration will behave when incrementally migrated are provided.</p>
    <p><a href="http://issuetracker.example.com/?project=migration&status=open">Open migration tickets</a></p>');
}

Functions

Namesort descending Description
hook_migrate_api Registers your module as an implementor of Migrate-based classes.
hook_migrate_overview Provides text to be displayed at the top of the dashboard page (migrate_ui).