Skip to content

Installation

“SilentJMA” edited this page Jun 18, 2026 · 2 revisions

Installation

Requirements

Dependency Minimum Notes
WordPress 5.6+
WooCommerce 3.0+
PHP 8.3+ Extensions: json, mbstring, gd, dom
Memory 256 MB 512 MB recommended for large catalogs

Quick Install

  1. Download the plugin zip from the latest release.
  2. Go to Plugins → Add New → Upload Plugin in your WordPress admin.
  3. Upload the zip and click Activate.
  4. Navigate to Mirakl → Stores to configure your first store.

Important: All PHP production dependencies (Composer packages, SDK, Guzzle, Dompdf) are committed to the repository. No composer install is required for activation.

Development Setup

For local development:

cd wp-content/plugins/mirakl-woocommerce-connector
composer install            # Install dev dependencies (PHPUnit, PHPCS)
vendor/bin/phpunit tests/Unit/

Activation Behavior

On activation, the plugin:

  1. Creates all custom database tables (see Database Schema)
  2. Registers custom cron schedules (5/10/15/30 min intervals)
  3. Schedules default sync jobs
  4. Flushes rewrite rules

On deactivation, all cron jobs are cleared. Data remains in the database.

Migrations

The plugin runs non-destructive data migrations on version changes:

  • Legacy option keys are renamed
  • New tables are created (existing tables are left intact)
  • Enum values in existing columns are expanded as needed

Version tracking is stored in the mirakl_connector_db_version option.

Clone this wiki locally