Gatemi Low Stock Developer Reference

Everything here is read from the plugin code. The free edition is plain WordPress PHP (GMLSF_* classes); the full edition is namespaced (GatemiLowStock) and is where almost all the filters live.

Filters — Full edition

Filter Arguments What it changes
gmls_settings array $settings The settings array after defaults are merged in.
gmls_is_low bool $low, WC_Product $product, int $quantity Whether one product counts as low.
gmls_report_limit int $limit (default 500) The most rows one scan collects.
gmls_report array $rows The finished, sorted report, used by both the screen and the digest.
gmls_digest array|false $message, array $rows The message (to, subject, body) before it is sent. Return false to cancel.
gmls_modules array $modules The ordered module list the plugin boots.
gmls_license_api_url string $url The gatemi.com licensing endpoint (for staging mirrors).
gmls_update_cache_ttl int $seconds How long the update payload is cached.

Each report row has the keys id, name, sku, stock, threshold, out (bool) and link (the product's edit URL).

The free edition applies no filters of its own.

Example: never report products in one category

add_filter( 'gmls_is_low', function ( $low, $product, $quantity ) {
	$id = $product->get_parent_id() ?: $product->get_id();
	if ( has_term( 'made-to-order', 'product_cat', $id ) ) {
		return false;
	}
	return $low;
}, 10, 3 );

Example: copy the digest to a second inbox

add_filter( 'gmls_digest', function ( $message, $rows ) {
	if ( is_array( $message ) ) {
		$message['to'][] = 'purchasing@example.com';
	}
	return $message;
}, 10, 2 );

Actions

Action Edition When
gmls_settings_saved Full After the settings screen saves. The plugin uses it to reschedule the digest.
gmlsf_settings_saved Free The same, for the free edition.
gmls_booted Full After every module has booted; receives the plugin's container.

Cron hooks

Hook Edition Recurrence
gmlsf_send_digest Free daily, first run at the chosen hour in the store's timezone.
gmls_send_digest Full daily or weekly, the same way.
gmls_license_check Full The licence check, twice daily. Only scheduled once a key is entered.

The digest event exists only while a digest is switched on and has a valid recipient; otherwise it is cleared. The free edition also clears its event on deactivation.

The full edition's cron hook is deliberately named gmls_send_digest rather than gmls_digest: WordPress keeps actions and filters in one registry, and a name used for both would make the gmls_digest filter call the cron callback.

Options

Option Edition Holds
gmls_settings Both The settings: digest, schedule, hour, recipients, send_empty, threshold, digest_subject, digest_body.
gmlsf_schedule_set Free The recurrence the free edition last scheduled.
gmls_schedule_set Full The recurrence the full edition last scheduled, so a change from weekly to daily reschedules.
gmls_license Full Licence state. Its presence also tells the free edition's uninstaller the full edition has been used.

WooCommerce's own option woocommerce_notify_low_stock_amount is read as the last fallback threshold, never written.

Meta

Key Type Edition Holds
_gmls_threshold product_cat term meta Full A category's own threshold, a whole number as a string. Absent means "not set".

A product's own threshold is WooCommerce's low_stock_amount (WC_Product::get_low_stock_amount()); the plugin reads it and never writes it.

Admin forms

Settings post as gmls_settings[...] with a nonce and require manage_woocommerce. The category field posts gmls_threshold with the nonce field gmls_term_nonce and requires manage_product_terms.

What it does not have

No database tables, no REST routes, no shortcodes, no storefront scripts or styles, and no product or order meta.

Shopping Cart
Scroll to Top