Skip to content

Data, endpoints and integration points

Reign Dokan Addon overviewPremiumGet Reign Dokan Addon →

for developers. Reference for what the add-on stores and registers. For filters and template overrides see Filters and templates.

The add-on registers no shortcodes, blocks, widgets, REST routes or WP-CLI commands. It has one AJAX action, one My Account endpoint and the BuddyPress and BuddyBoss integration below.

Action Who What it does
reign_dokan_toggle_favourite Logged-in members only (no guest handler) Adds or removes one product in the member’s favourites. Posts product_id and a nonce named after the action. Answers with JSON success, or JSON error with a message.

Error replies: 403 “This page has expired. Refresh it and try again.” for a bad nonce, 400 “This product is not available.” for a missing or unavailable product, and 400 with “You can save up to N favourites. Remove one to add another.” or “Your favourites are still saving. Try again in a moment.” from the save itself.

favourites is added as a WooCommerce My Account endpoint, with the menu item “Favourite products” placed just before Log out. The page pages its list with the fpage query argument, using the shop’s page size. After activation, or whenever the saved Dokan settings change, the add-on asks for one rewrite flush on the next request (the reign_dokan_flush option).

Surface Detail
Profile tab “Store” Slug store, position 70. Shown on a vendor’s profile when Store tab on vendor profiles is on.
Profile tab “Favourite products” Slug favourite-products, position 71. Shown only on the member’s own profile. The My Account endpoint uses a different slug (favourites) so the two never match the same URL.
Activity type “New products” reign_mv_new_product. Posted as the vendor when a product is published.
Activity type “Product reviews” reign_mv_new_review. Posted as the reviewer when a review is approved.
Activity type “Store purchases” reign_mv_new_order. Posted as the buyer when an order reaches processing or completed. Hidden from the sitewide stream, so it shows on the buyer’s own profile only.

These appear as filter choices in the activity stream. Each activity stores only IDs and a title; the card is printed from live data. A repeated event with the same IDs is not posted twice. Publishes during an import, Bulk Edit, Woo’s CSV import or WP-CLI post nothing. PeepSo is not integrated.

Action Purpose
reign_dokan_convert Convert the old store list shortcode on the pages the scan found. Needs manage_options and a nonce.
reign_dokan_dismiss Dismiss the upgrade notice.

See Upgrading from 3.8.0.

Where Key Holds
Option reign_options['dokan'] The five settings.
Option reign_dokan_upgraded Set once the 3.9.0 settings migration has run (holds the add-on version).
Option reign_dokan_scan The upgrade scan result; removed when nothing is left to fix or when you dismiss the notice.
Option reign_dokan_flush One-shot request for a rewrite flush.
Transient reign_dokan_convert_<user id> The “converted” report, shown once to the admin who ran it (kept up to an hour).
User meta reign_mv_favourite_products The member’s favourites, a list of product IDs.
User meta rda_favorite_products The 3.8.0 list. Read once, never deleted.
User meta reign_mv_favourites_migrated Marks that the old list was copied for this member.

REIGN_MV_FAVOURITES_CAP (default 200) is the favourites limit. Define it in wp-config.php before the add-on loads, or use the reign_mv_favourites_cap filter.

  • woocommerce_product_meta_start prints the Sold by line.
  • woocommerce_before_shop_loop_item and woocommerce_after_add_to_cart_button print the heart.
  • On store list pages with a non-default card style the add-on adds the body class reign-dokan-cards-centered or reign-dokan-cards-soft.

The add-on lists itself through the Reign reign_licensed_products filter, so the key is entered under Reign Settings > License and updates come from Reign. There is no licence screen in the add-on.