Gatemi Store Migration Developer Reference

The free edition applies no filters or actions of its own. Everything under Filters and Actions is the full edition's.

Filters — Full edition

gmsm_row

Filters one mapped row just before it is written. Return an empty array to skip the row; it is counted under "Held back by a filter."

Argument Type
$fields array The mapped fields (see below)
$kind string product, customer, order or coupon
$assoc array The raw row, keyed by the file's own headers

The $fields keys per kind:

  • product — source_id, name, description, sku, price, sale_price, stock (int or null), weight (float or null, full edition), categories (list of paths, each a list of names, top first), published (bool)
  • customer — source_id, email, first_name, last_name, phone, city, country
  • order — source_id, email, total, tax, shipping, currency, status, date, sku, quantity, line_name, line_price (and job, the run's token, added after the filter)
  • coupon — source_id, code, amount, type (percent or fixed_cart)
// Import products as drafts whatever the file says.
add_filter( 'gmsm_row', function ( $fields, $kind, $assoc ) {
	if ( 'product' === $kind ) {
		$fields['published'] = false;
	}
	return $fields;
}, 10, 3 );

Do not change source_id unless you mean to: it decides update-or-create.

gmsm_sources

Filters the source catalog — the formats a file can come from. Each entry is a label and a maps array of kind → field → list of candidate headers. A source added here appears in The file came from and gets the reader, the batching, the resume and the source-id rule.

add_filter( 'gmsm_sources', function ( $sources ) {
	$sources['acme'] = array(
		'label' => 'Acme Shop CSV',
		'maps'  => array(
			'product' => array(
				'source_id' => array( 'Product Code' ),
				'name'      => array( 'Product Name' ),
				'price'     => array( 'RRP' ),
				'sku'       => array( 'Product Code' ),
				'status'    => array( 'Live' ),
			),
		),
	);
	return $sources;
} );

Source ids are stored as <source key>:<value>, so a new source never collides with Shopify or WooCommerce records. A kind you leave out of maps is read with an empty map, so every row of it is skipped.

gmsm_settings

Filters the merged settings array (publish, tidy_file) after it is read.

Licensing and boot

  • gmsm_modules — the ordered list of modules the plugin boots.
  • gmsm_license_api_url — the licence server's base URL.
  • gmsm_update_cache_ttl (default 12 hours), gmsm_update_retry_ttl (default 15 minutes) and gmsm_sync_cache_ttl (default 12 hours) — cache lifetimes in seconds, never below 60.

Actions — Full edition

gmsm_booted

Fires once the plugin's modules are registered and booted. Receives the plugin's container.

Options

Option Edition Holds
gmsm_settings both (shared) publish (yes/no, default no), tidy_file (yes/no, default yes)
gmsm_job full The open or last finished job
gmsmf_job free The same, for the free edition
gmsm_license full Licence state

A job is an array: file, name, source, kind, headers, offset (bytes), size, created, updated, skipped, reasons (reason → count, up to 50 reasons), done, started, finished (both UTC MySQL datetimes).

Meta keys

Key On Value
_gmsm_source products, coupons, orders (post/order meta); customers (user meta) The source id, e.g. shopify:the-blue-kettle, woo:123, shopify:ann@example.com
_gmsm_job orders (full edition) The migration run that created the order — what lets that run's later rows add their lines to it

Both editions write the same key, so a record imported by one is recognised by the other.

// Find the product imported from a Shopify handle.
$ids = get_posts( array(
	'post_type'   => 'product',
	'post_status' => 'any',
	'fields'      => 'ids',
	'meta_key'    => '_gmsm_source',
	'meta_value'  => 'shopify:the-blue-kettle',
) );

Cron

Hook Edition Schedule
gmsm_run full Every minute (gmsm_minute), only while a job is open
gmsmf_run free Every minute (gmsmf_minute), only while a job is open
gmsm_license_check full Twice daily, while a licence key is saved

Each run reads 50 rows. The schedule is added on init when a job is open and removed when none is.

Upload folder

wp-content/uploads/gmsm-imports/ (full) or wp-content/uploads/gmsmf-imports/ (free). Files are named with 20 random characters plus .csv. The folder gets an empty index.html and a .htaccess containing Deny from all.

Admin screen

admin.php?page=gmsm-store-migration (full edition), capability manage_woocommerce, nonce action gmsm_migration. The free edition's screen is admin.php?page=gmsmf-store-migration, nonce action gmsmf_migration. Neither edition registers a REST route, an AJAX action or any storefront hook; the free edition makes no HTTP request at all.

Shopping Cart
Scroll to Top