DOCUMENTATION

Documentation
Browse Docs

Settings

Settings

The Settings page controls what WPMC tracks and how the BH Clicks Tracker sends data. This article explains every setting, including the exact option keys, default values, and important behavior from the plugin source code.

Where to find it: WP Admin → WPMC Behavior & Heatmap → Settings
Recommended setup: Enable the BH tracker, then choose your tracked post types.

What gets saved in WordPress options

Setting Option key Default
Enable Clicks Tracker wpmc_bh_enabled Enabled by default on fresh install (no option saved yet)
Tracked Post Types wpmc_enabled_post_types If not configured yet: everything is allowed
Excluded IPs wpmc_excluded_ips Empty
Batch size wpmc_bh_batch_size 30
Max delay wpmc_bh_max_delay 1200 ms
Compression wpmc_bh_compress On (1)
Heatmap bucket size wpmc_bh_bucket 6 px

Legacy fallback: If a BH option is not saved yet, the plugin can fall back to legacy keys: wpmc_rt_enabled, wpmc_rt_batch_size, wpmc_rt_max_delay, wpmc_rt_compress, wpmc_rt_bucket.

1) Clicks Tracker (BH)

This is the main switch for click tracking. When OFF, the tracker is not loaded on the frontend, and no click data is collected or sent.

Option key

wpmc_bh_enabled stores on or off.

Default behavior

If the option is not saved yet (fresh install), BH is enabled by default.

Developer overrides (optional):
• Quick test via URL: ?wpmc_bh=1 or ?wpmc_bh=on
• Programmatic override: filter wpmc_bh_tracker_enabled

Admin tracking: On the frontend, the tracker passes skipAdmins when a user is logged in and has the manage_options capability. This keeps your own admin clicks from skewing heatmaps.

2) Tracked Post Types

Tracked Post Types determines which content types are tracked for clicks and views. The UI lists your public post types (Pages, Posts, and any public custom post types).

Option key

wpmc_enabled_post_types stores an array of post type slugs.

Important behavior from the code

  • Not configured yet (option is NULL): tracking is allowed everywhere by default.
  • Configured to an empty array []: tracking is disabled (nothing is tracked).
  • Configured with values: only those post types are tracked.

Special pages

Some URLs do not map to a single post (home, archive, search). In that case, the plugin treats them like this:

  • If you selected nothing (disabled all), those pages are not tracked.
  • If you selected any post types, those pages remain trackable.

Best practice: Enable only the post types you actually want to optimize. This keeps reports cleaner and reduces database growth.

3) Excluded IPs

This field stores IP addresses you want to exclude from tracking. The settings UI suggests separating multiple IPs with commas and shows your current IP.

Option key

wpmc_excluded_ips

How to format

  • Use comma-separated IP addresses (example: 203.0.113.10, 198.51.100.2)
  • Keep it minimal: add only your office/dev/test IPs

Important note (this version)

In the current codebase, this value is saved and displayed, but it is not yet used by the tracking filters in the front-end pipeline. If you need IP-based exclusion enforced, it can be added in the tracker filters/server handlers.

4) BH Engine Settings

These settings control how the BH tracker batches events and sends them to the server. The values are passed to the frontend tracker via the localized WPMC_BH.opts config.

Setting Option key Default How it affects tracking
Batch size wpmc_bh_batch_size 30 Sends a request after this many events are buffered. Larger values reduce request count; smaller values reduce the chance of losing buffered events when the tab closes. (The UI tooltip suggests typical values: 20–50.)
Max delay wpmc_bh_max_delay 1200 ms Maximum buffering time before sending, even if the batch is not full. Increase to reduce requests (more buffering), decrease for quicker delivery.
Compression wpmc_bh_compress On Sends event payloads in a more compact format. Useful for slower connections or high traffic sites.
Bucket size wpmc_bh_bucket 6 px Heatmap bin size in pixels. Smaller buckets can show more detail (more “points”), larger buckets smooth the heatmap and can be lighter to render.

Save & verify

Save

Click Save Settings. Your changes apply to new tracking events immediately.

Verify

  1. Open a tracked page on the frontend.
  2. Click a few links/buttons and scroll.
  3. Go to BH Heatmap and check that click points appear.

Troubleshooting

  • No data at all: Ensure BH is enabled and at least one post type is selected (or reset settings to default behavior).
  • Heatmap empty: Generate real clicks on the frontend and ensure you’re viewing the correct page/device mode.
  • Testing as admin: Some setups skip tracking for admins to keep data clean. Test in an incognito window.