DOCUMENTATION

Documentation

Developer Reference

Developer Reference

This reference lists the main files, functions, hooks, filters, and options used by the plugin.

Important files

File Purpose
wpmc-behavior-and-heatmap.phpPlugin bootstrap, constants, module includes, activation hooks, admin theme CSS, updater.
includes/admin-menu.phpMain admin menu and core submenus.
includes/db-setup.phpClassic behavior schema and indexes.
extended/tracking.phpClassic behavior tracking, cookies, AJAX handlers, frontend script enqueue.
heatclick-BH/db.phpBH schema, insert helper, query helpers, post type guard.
heatclick-BH/rest.phpBH REST ingest and admin query endpoints.
heatclick-BH/ajax.phpBH AJAX ingest and admin query endpoints.
extended/details.phpHidden page details view, URL normalization, tab layout.
includes/integration-api.phpWPMissionControl behavior status and summary REST API.

Useful filters

  • wpmc_bh_tracker_enabled: override whether the BH frontend tracker loads.
  • wpmc_current_ip_address: override how the current IP is detected.
  • wpmc_is_current_ip_excluded: override final IP exclusion result.
  • wpmc_min_active_ms: adjust the minimum visible active time before a classic page view is saved.
  • wpmc_behavior_heatmap_shared_api_key_candidates: add WPMissionControl API key candidates.
  • wpmc_behavior_heatmap_shared_api_key: provide a single shared API key.
  • wpmc_behavior_heatmap_validate_api_key: custom integration token validation.
  • wpmc_behavior_heatmap_expected_api_keys: override accepted integration keys.

Key functions

  • wpmc_create_db_tables(): creates or upgrades classic behavior tables.
  • wpmc_bh_create_tables(): creates or upgrades the BH clicks table.
  • wpmc_is_enabled_post_type_for_url(): classic pipeline post type guard.
  • wpmc_bh_pt_enabled_for_url(): BH pipeline post type guard.
  • wpmc_bh_insert_click_batch(): sanitizes and inserts BH event batches.
  • wpmc_bh_get_totals(): returns click, navigation, and CTA totals for page/device/date filters.
  • wpmc_pick_best_known_url(): resolves a stored URL variant for details pages.
  • wpmc_bhm_build_behavior_summary(): builds remote integration summary payloads.