Gatemi Review Reminders Developer Reference

The free edition's filters carry the prefix gmrrf_; the full edition's carry gmrr_. Where a filter exists in both, it takes the same arguments. Storage is shared on purpose, so everything under Storage applies to both.

Filters

gmrrf_should_remind / gmrr_should_remind

Whether one order is reminded at all, after the plugin's own checks (status, billing email, something left to ask about).

Argument Type
$ok bool The plugin's answer
$order WC_Order The order
// Never ask about orders placed before reminders were switched on.
add_filter( 'gmrr_should_remind', function ( $ok, $order ) {
	$created = $order->get_date_created();
	return $ok && $created && $created->getTimestamp() >= strtotime( '2026-10-01' );
}, 10, 2 );

gmrrf_reviewable / gmrr_reviewable

The product ids one order is asked about, after refunds, exclusions and already-reviewed products are taken out. Return an empty array and the order is not asked.

Argument Type
$products int[] Product ids (a variation is its parent)
$order WC_Order The order

gmrrf_email / gmrr_email

The reminder just before wp_mail(). Return false to hold it back; the order stays claimed and is not asked again.

Argument Type
$message array to, subject, body (HTML, the unsubscribe line already appended), headers
$order WC_Order The order
$products int[] The products asked about
// Copy every review request to the shop.
add_filter( 'gmrr_email', function ( $message ) {
	if ( is_array( $message ) ) {
		$message['headers'][] = 'Bcc: reviews@example.com';
	}
	return $message;
} );

gmrrf_photo_types / gmrr_photo_types

The image types a photo review accepts, as extension pattern ⇒ MIME type. Default:

array(
	'jpg|jpeg' => 'image/jpeg',
	'png'      => 'image/png',
	'gif'      => 'image/gif',
	'webp'     => 'image/webp',
)

Widening this widens what a stranger may upload. An empty array is ignored.

gmrr_photo_bytes — Full edition

The largest a single photo may be, in bytes. Default: Largest photo (MB) × 1 MB.

gmrr_batch_size — Full edition

How many reminders one sweep sends, at most, for each reminder in the sequence (it reads up to ten batches of due orders to find them). Clamped to 1–200.

gmrr_settings, gmrr_modules, gmrr_license_api_url, gmrr_update_cache_ttl — Full edition

The merged settings array, the boot module list, the gatemi.com licensing endpoint (for staging mirrors) and how long the update payload is cached.

Actions — Full edition

gmrr_booted

Fires once the plugin has booted, with its service container as the only argument.

Storage

Options

Option
gmrr_settings The settings, shared by both editions
gmrr_optouts Opted-out addresses, lower-cased, as keys
gmrr_license Full edition licence state

Meta

Key On
_gmrr_sent Order The claim: the list of reminder indexes this order has had
_gmrr_photos Review (comment) Attachment ids of its photos
_gmrr_comment Attachment The review a photo belongs to
_gmrr_coupon Review (comment) Full edition: pending, then the thank-you coupon's code

The order claim is read and written through the order's meta API, so it works under HPOS and the legacy order store.

Cron

Hook Schedule
gmrrf_send_reminders Hourly — free edition
gmrr_send_reminders Hourly — full edition
gmrr_license_check Full edition licence check

Each edition keeps its own sweep event, so uninstalling one never removes the other's.

All links point at your home page. The Leave a review page carries gmrr_order and gmrr_review on to each product's address, and the product's review form posts them back as two hidden fields of the same names; pre_comment_approved refuses a review posted with them for a product the order did not buy (WP_Error code gmrr_not_reviewable, or gmrrf_not_reviewable in the free edition), and an accepted one gets WooCommerce's verified comment meta. The page itself is a whole response: the theme's header and footer (template parts on a block theme), then exit, sent with nocache_headers() and a noindex robots tag.

Argument
gmrr_order The order id
gmrr_review The signed token for that order
gmrr_stop The unsubscribe token

The review token is an HMAC over the order id and the order key, signed with the site's auth salts. The unsubscribe token is wp_hash() over gmrr-optout| and the lower-cased address. Both editions compose them the same way, so a link sent by one works under the other.

The photo upload field is named gmrr_photos[].

CSS classes

The storefront stylesheet and script load only on a page that drew a review page or a photo field.

Class Element
.gmrr-page, .gmrr-page__title, .gmrr-page__lead The Leave a review page
.gmrr-page__products, .gmrr-page__product Its list of products
.gmrr-page__empty "There is nothing here to review…"
.gmrr-photos, .gmrr-photos__hint The photo field on the review form
.gmrr-review-photos, .gmrr-review-photo, .gmrr-review-photo__image Photos shown on an approved review
.gmrr-review-photo__image {
	border-radius: 6px;
	max-width: 160px;
}
Shopping Cart
Scroll to Top