WordPress integration
Click Guide for WordPress#
Add in-app walkthroughs and contextual help to any WordPress site. Install the plugin, paste your publishable key, and the Click Guide launcher appears in minutes — no theme edits required.
Download pluginInstall the plugin#
The plugin ships as a standard WordPress zip — no Composer, no npm, nothing to compile.
- Download
click-guide.zipusing the button above. - In your WordPress dashboard go to Plugins → Add New → Upload Plugin.
- Choose the downloaded zip file and click Install Now.
- Click Activate Plugin.
- Open the new Click Guide item in the left-hand menu.
You can also install via WP-CLI:
wp plugin install https://clickguide.co.za/downloads/click-guide.zip --activateConnect your account#
- Sign in to app.clickguide.co.za and open the Keys tab.
- Copy your publishable key — it starts with
cg_pk_live_. - In the plugin's Settings tab, paste the key into the Publishable key field.
- Add your WordPress site's URL as an allowed origin on the key in the console.
- Click Save settings.
The Status tab confirms the key is set and shows the exact <script> tag the plugin injects into your page footer.
Plugin settings#
| Setting | What it does |
|---|---|
Click Guide | Master on/off switch. Disables the script site-wide without touching any other setting. |
SDK version | Pin to v1 for stability or choose Latest to pick up new releases automatically. |
Publishable key | Your site-specific key from the Click Guide console. Safe to expose — it is scoped to the origins you allow. |
Launcher label | The text on the floating beacon. Default: Help. |
Launcher position | Where the beacon sits: bottom-right, bottom-left, top-right, or top-left. |
Show Click Guide to | Everyone · Logged-in users only · Admins only (great for testing) · Nobody (temporarily off). |
Page visibility | Load on all pages, only on specific pages, or everywhere except specific pages. |
Limiting Click Guide to specific pages#
The Page visibility setting lets you control exactly which URLs the launcher appears on — useful when you only want Click Guide on your shop, your documentation, or your member area.
Open the Settings tab and choose one of three modes:
When you pick "Only on these pages" or "Everywhere except these pages", a text area appears. Enter one URL path per line. The path is matched against the current page's URL — query strings are ignored.
URL pattern syntax#
Patterns match the URL path only (no domain, no query string). Use * as a wildcard that matches any sequence of characters.
| Pattern | Matches | Does not match |
|---|---|---|
/shop/* | /shop/cart, /shop/checkout/step-2 | /shop |
/shop | /shop exactly | /shop/cart |
/docs/* | /docs/getting-started, /docs/api/overview | / |
/* | every page | — |
/shop/*/products/*/checkout/my-account/*The plugin runs the pattern check on the server before the page is sent to the browser, so there is no flash of the launcher on excluded pages.
Page builders (Elementor, Divi, Beaver Builder): URL patterns work with any page builder because the check happens at the PHP level, not in the editor. You do not need to add anything to individual page templates.
Updating the plugin#
Download the latest zip from the button at the top of this page, then go to Plugins → Add New → Upload Plugin and tick Replace current with uploaded before clicking Install. Your settings are stored in the WordPress options table and survive the update.