Click Guide

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 plugin

Install the plugin#

The plugin ships as a standard WordPress zip — no Composer, no npm, nothing to compile.

  1. Download click-guide.zip using the button above.
  2. In your WordPress dashboard go to Plugins → Add New → Upload Plugin.
  3. Choose the downloaded zip file and click Install Now.
  4. Click Activate Plugin.
  5. Open the new Click Guide item in the left-hand menu.

You can also install via WP-CLI:

bash
wp plugin install https://clickguide.co.za/downloads/click-guide.zip --activate

Connect your account#

  1. Sign in to app.clickguide.co.za and open the Keys tab.
  2. Copy your publishable key — it starts with cg_pk_live_.
  3. In the plugin's Settings tab, paste the key into the Publishable key field.
  4. Add your WordPress site's URL as an allowed origin on the key in the console.
  5. 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#

SettingWhat it does
Click GuideMaster on/off switch. Disables the script site-wide without touching any other setting.
SDK versionPin to v1 for stability or choose Latest to pick up new releases automatically.
Publishable keyYour site-specific key from the Click Guide console. Safe to expose — it is scoped to the origins you allow.
Launcher labelThe text on the floating beacon. Default: Help.
Launcher positionWhere the beacon sits: bottom-right, bottom-left, top-right, or top-left.
Show Click Guide toEveryone · Logged-in users only · Admins only (great for testing) · Nobody (temporarily off).
Page visibilityLoad 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:

  • Load on all pages — the default. Click Guide renders wherever the script loads.
  • Only on these pages — Click Guide loads only on URLs that match a pattern you enter.
  • Everywhere except these pages — Click Guide loads everywhere except on URLs that match a pattern you enter.

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.

PatternMatchesDoes 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.

Verify the install#

  • Open your site in a new browser tab (private window works well) and confirm the launcher beacon is visible in the corner you chose.
  • Open the browser console and look for [click-guide] ready. — its absence means the script did not load or the key was rejected.
  • In the Click Guide console, open Applications → Usage. The Sessions counter increments as soon as the first browser loads your page with the script active.