Acuity WordPress - Migration Centre

The core "Control Centre" for the Acuity WordPress migration tools. It provides a single, shared connection to a legacy WordPress database and a dashboard that lists every migration tool installed on the site.

This module contains no import logic of its own — it is the hub that the actual importers depend on. Install it once, point it at your WordPress database, and each migration tool registers on its dashboard.

When your migration is complete and the individual migration tools have been removed, you can safely uninstall this module.

Initial version

This is a beta release for code review and testing.

Requirements

• Backdrop CMS 1.x
• A secondary database connection to the WordPress database, defined in settings.php.
• At least one migration tool (e.g. Acuity WordPress User Import) to do anything useful.

Installation

Install this module using the official Backdrop CMS instructions at https://docs.backdropcms.org/documentation/extend-with-modules

Add the WordPress database configuration to your settings.php file (see Documentation below), enable the module, then set the connection at Configuration → Acuity → WP Migration Centre → Global DB Connection.

Documentation

1. Database Configuration

Define the connection to the WordPress database in your site's settings.php. The prefix must be empty to query wp_users directly. host may be 127.0.0.1, localhost, or a remote database host.

$databases['wordpress']['default'] = array(
  'driver' => 'mysql',
  'database' => 'your_wordpress_db_name',
  'username' => 'db_user',
  'password' => 'db_pass',
  'host' => '127.0.0.1',
  'prefix' => '',
);

2. Setting the Connection

• Open Configuration → Acuity → WP Migration Centre (admin/config/acuity-wpmc).
• On the Global DB Connection tab, enter the Database Key you defined in settings.php (default wordpress).
• Click Test Connection to verify connectivity and that the WordPress tables are found, then Save Connection Settings.

3. The Dashboard

The dashboard at admin/config/acuity-wpmc lists every installed migration tool. If it is empty, enable a tool such as Acuity WordPress User Import and it will appear.

For developers (integrating a migration tool)

A migration tool integrates with the Centre in two ways:

• Register on the dashboard — implement hook_acuity_wpmc_group_info(), returning one or more groups:

  function mymodule_acuity_wpmc_group_info() {
    return array(
      'mytool' => array(
        'title' => t('My Migration Tool'),
        'description' => t('Imports my content from WordPress.'),
        'url' => 'admin/config/acuity-wpmc/mytool',
      ),
    );
  }

• Get the shared connection — call acuity_wpmc_get_database(). It returns a Backdrop database connection to the configured WordPress database, or FALSE on failure — always guard for FALSE:

  $wp = acuity_wpmc_get_database();
  if (!$wp) {
    // Connection not configured or unavailable.
    return;
  }
  $count = $wp->select('wp_users', 'u')->countQuery()->execute()->fetchField();

Current consumers: Acuity WordPress User Import (acuity_wpuser) and Entity Forum Importer (its WordPress bbPress source).

Issues:

Bugs and Feature requests should be reported in the Issue Queue: https://github.com/backdrop-contrib/acuity_wpmc/issues

Current Maintainer(s):

• Steve Moorhouse (albanycomputers) (https://github.com/albanycomputers)
• Seeking additional maintainers and contributors.

Credits:

• Assisted by AI

Sponsorship:

• Albany Computer Services (https://www.albany-computers.co.uk)
• Albany Web Design (https://www.albanywebdesign.co.uk)
• Albany Hosting (https://www.albany-hosting.co.uk)

License

This project is GPL v2 software. See the LICENSE.txt file in this directory for complete text.