Install & connect the plugin
The plugin detects recipe pages, injects Allspice buttons and the widget, loads asynchronously, and enables publisher analytics. Setup typically takes under 10 minutes.
On this page
Overview
The Allspice WordPress Plugin enables the Allspice widget and interactive cooking tools on your recipe pages.
Once installed, the plugin:
- detects recipe pages automatically
- injects Allspice buttons and the widget where supported
- loads asynchronously to avoid impacting site speed
- enables publisher analytics + attribution for revenue share
Prerequisites
Before installing the plugin, you'll need:
- A WordPress site with admin access
- A verified domain inside the Allspice Publisher Portal
- Recipe posts that are publicly accessible
- Recipe content in a supported format (JSON-LD strongly recommended)
If your recipes include JSON-LD (schema.org Recipe), detection and extraction will be significantly more reliable.
Installing the Plugin
Option A - Install from WordPress (recommended)
- In your WordPress admin panel, go to: Plugins → Add New
- Search for: Allspice
- Click Install Now
- Click Activate
Option B - Upload plugin ZIP
- Go to: Plugins → Add New → Upload Plugin
- Select the plugin ZIP file
- Click Install Now
- Click Activate
If you have a development team, plugin installation can be handled via your normal deployment workflow as well.
Initial Setup (After Install)
After activation, the plugin will prompt you to complete basic setup. You will be asked to input the following information in the plugin settings page:
- Publisher ID
- Domain ID
- Webhook Token
You can provide this information before linking your domain in the Publisher Portal. However, we recommend waiting until your domain is verified and your recipes have been synced before configuring the plugin settings page. At that point, you will see the status of this domain switch to "Ready" in the Publisher Portal.
Buttons & Placement (Premade vs Custom)
Allspice supports two button types: Premade Buttons and Custom Buttons. Both are configured in the Publisher Portal, and both can trigger different Allspice actions (Chat, Groceries, Search, etc.).
Premade Buttons (Fastest Setup)
Premade buttons are the easiest way to add Allspice UI to your site.
You can place premade buttons using:
- Shortcodes
- WordPress Blocks
- Automatic Placement (on detected recipe pages only)
Premade buttons are ideal if you want something that works immediately with minimal effort.
You can also configure premade button options (including color) inside the Publisher Portal.
Custom Buttons (Full Control)
Custom buttons let you turn any element on your site into an Allspice button.
To create a custom button:
- Add the Allspice class name we provide to your element
- Choose which action it should trigger inside the Publisher Portal
Example actions include:
- Open Allspice Chat
- Open Groceries
- Open Search
- Open the Allspice widget experience
This is the best option if you want:
- full design control
- exact placement anywhere on your site
- Allspice functionality without "premade" styling
Where Buttons Can Appear
By default, the plugin injects Allspice on detected recipe pages only. This keeps your site clean and ensures Allspice appears only where it adds value.
If you want Allspice on other pages (like a landing page, recipe index, or homepage), you can place custom buttons there without enabling full recipe injection.
Important notes:
- "Automatic" premade button placement only displays on detected recipe pages
- Custom buttons can appear anywhere, including non-recipe pages
Syncing Changes from the Publisher Portal
When you change anything in the Publisher Portal (buttons, colors, actions, placements, etc.), you must sync those changes to your WordPress site.
To sync immediately:
- Go to WordPress Admin → Allspice Plugin Settings
- Click Sync with Allspice
If you do not manually sync, changes will still apply automatically, but on a 12 hour update schedule.
This is intentional to prevent excessive network calls and keep your site performance fast.
The same "Sync with Allspice" behavior applies to recipe updates and configuration changes - use manual sync any time you want changes to take effect right away.
Performance & Loading Behavior
Allspice is engineered to be performance-friendly.
What Allspice loads
- Scripts are loaded asynchronously
- The widget loads only when needed
- Allspice runs only on recipe pages by default
Core Web Vitals
Allspice is designed to avoid negative Core Web Vitals impact by minimizing render-blocking behavior.
If you use aggressive optimization tools (like minification, JS delay, or script rewriting), you may need a small configuration adjustment to ensure the widget loads correctly.
Supported Environments (Dev / Test)
Allspice can be installed on:
- production domains
- public dev environments used for testing
Allspice may not work correctly on:
- private staging environments behind authentication
- sites blocking crawler access
- sites without public sitemaps / restricted content access
If you want to test before launch, we recommend using a public dev domain with a small set of sample recipes.
Updating the Plugin
We regularly ship improvements to:
- recipe extraction reliability
- widget UI and performance
- publisher analytics + controls
- compatibility with new WordPress environments
Updating via WordPress Admin
- Go to Plugins
- Find Allspice
- Click Update Now (when available)
Keeping the plugin up to date ensures you get the newest improvements and platform features automatically.
Uninstall / Disable
You can disable Allspice at any time:
Disable
- Go to Plugins
- Click Deactivate
Remove completely
Click Delete after deactivation.
If you disable Allspice temporarily, your Publisher Portal configuration and domain linkage remain available, and you can reactivate at any time.