[Simple Analytics] Add Data Layer & Form Event Tracking by alaca · Pull Request #204 · mailchimp/wordpress

alaca · 2026-03-24T15:50:34Z

Description of the Change

Created a custom database table ({prefix}_mailchimp_sf_form_analytics) for daily aggregated form analytics, with columns for list_id, form_id, event_date, views, and submissions (unique key on list_id, form_id, event_date)
Implement client-side form view tracking that adds data-list-id attribute to all form types (block, widget, shortcode) and
fires an AJAX POST on page load, deduplicated per list_id
Hook into successful form submissions via a new mailchimp_sf_form_submission_success action to increment daily submission
Table creation runs on plugin activation and via the upgrade routine for existing installs

Closes #198

How to test the Change

Activate the plugin on a fresh install and verify the wp_mailchimp_sf_form_analytics table is created
Visit a page with a Mailchimp signup form and verify a view is recorded in the analytics table for the correct list_id and
today's date
Place multiple forms (different lists) on one page and verify each list gets its own view count
Submit a form successfully and verify the submission count increments
Submit a form with invalid data (e.g., missing email) and verify no submission is tracked
Navigate to Mailchimp > Analytics in wp-admin and verify that test data is displayed

Changelog Entry

Created a custom database table (mailchimp_sf_form_analytics) for daily aggregated form analytics
Implemented client-side form view tracking via AJAX

Credits

Props @alaca

Checklist:

I agree to follow this project's Code of Conduct.
I have updated the documentation accordingly.
I have added tests to cover my change.
All new and existing tests pass.

Copilot

Pull request overview

Adds a new “Simple Analytics” data layer to track Mailchimp signup form views/submissions and surfaces the data in the WP Admin Analytics page.

Changes:

Adds a custom DB table ({prefix}_mailchimp_sf_form_analytics) plus query/increment helpers and an AJAX handler for form-view tracking.
Emits a new mailchimp_sf_form_submission_success action on successful submissions and hooks it to increment submission counts.
Adds data-list-id to rendered forms and adds frontend JS to POST form-view events.

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
`mailchimp_widget.php`	Adds `data-list-id` attribute to widget/shortcode form markup for JS tracking.
`includes/blocks/mailchimp/markup.php`	Adds `data-list-id` attribute to block form markup for JS tracking.
`assets/js/mailchimp.js`	Adds client-side view tracking that POSTs to `admin-ajax.php`.
`includes/class-mailchimp-form-submission.php`	Fires a new action on successful form submission for analytics hooks.
`includes/class-mailchimp-analytics-data.php`	New analytics storage/query class, table creation, AJAX handler, and submission tracking hook.
`mailchimp.php`	Loads the analytics data class, registers activation hook, localizes AJAX URL + nonce.
`mailchimp_upgrade.php`	Runs table creation in upgrade routine based on a stored DB version option.
`includes/class-mailchimp-analytics.php`	Removes trailing whitespace only.
`includes/admin/templates/analytics.php`	Fetches analytics data and currently outputs it via `print_r()` for display.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-28T03:49:19Z

+	public function init() {
+		add_action( 'wp_ajax_mailchimp_sf_track_form_view', array( $this, 'handle_form_view' ) );
+		add_action( 'wp_ajax_nopriv_mailchimp_sf_track_form_view', array( $this, 'handle_form_view' ) );
+		add_action( 'mailchimp_sf_form_submission_success', array( $this, 'track_submission' ) );
+	}


This PR introduces new analytics behaviors (AJAX endpoint for view tracking, DB writes, and a new submission-success hook) but doesn’t add/extend automated coverage. There is an existing Cypress suite under tests/cypress; adding at least one e2e test that verifies view tracking + submission tracking increments the expected counts would help prevent regressions.

iamdharmesh

Thanks @alaca. Overall this looks good and added few feedback/comment. Could you please check?

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Co-authored-by: Dharmesh Patel <dspatel44@gmail.com>

…nd-form-event-tracking

alaca · 2026-04-06T07:17:33Z

@iamdharmesh resolved. Also, the data is now loaded via ajax for future integrations with chart.js

Copilot

Pull request overview

Copilot reviewed 10 out of 10 changed files in this pull request and generated 5 comments.

Comments suppressed due to low confidence (1)

includes/admin/templates/analytics.php:110

There are two elements with the same id mailchimp-sf-analytics-content (one empty and one containing the placeholder). Duplicate IDs produce invalid markup and getElementById() will return only the first element, leaving the placeholder orphaned/unreachable. Keep a single container and place the placeholder inside it (or remove the duplicate).

			<div class="mailchimp-sf-analytics-content" id="mailchimp-sf-analytics-content">
			</div>

				<div class="mailchimp-sf-analytics-content" id="mailchimp-sf-analytics-content">
					<div class="mailchimp-sf-analytics-placeholder">
						<p><?php esc_html_e( 'Select a date range and list to view analytics.', 'mailchimp' ); ?></p>
					</div>
				</div>

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-07T07:23:32Z

+				}
+
+				const { data } = response;
+				contentArea.innerHTML = JSON.stringify(data);


contentArea.innerHTML = JSON.stringify(data) uses innerHTML with server-provided content, which is unnecessary and can introduce XSS risks if the payload ever contains user-controlled strings. Prefer assigning to textContent for raw JSON output, or render into DOM nodes with proper escaping.

Suggested change

contentArea.innerHTML = JSON.stringify(data);

contentArea.textContent = JSON.stringify(data);

Copilot · 2026-04-07T07:23:33Z

+		);
+		// phpcs:enable WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching, WordPress.DB.PreparedSQL.InterpolatedNotPrepared
+
+		if ( false === $result ) {


This error_log() call will likely violate the WordPress PHPCS sniff WordPress.PHP.DevelopmentFunctions.error_log_error_log (other files use // phpcs:ignore when logging). Either add the appropriate PHPCS ignore/comment, or route logging through the existing logging mechanism/filter used elsewhere in the plugin.

Suggested change

if ( false === $result ) {

if ( false === $result ) {

// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log -- Logs DB write failures for analytics tracking.

Copilot · 2026-04-07T07:23:33Z

+		);
+		// phpcs:enable WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching, WordPress.DB.PreparedSQL.InterpolatedNotPrepared
+
+		if ( false === $result ) {


This error_log() call will likely violate the WordPress PHPCS sniff WordPress.PHP.DevelopmentFunctions.error_log_error_log (other files use // phpcs:ignore when logging). Either add the appropriate PHPCS ignore/comment, or route logging through the existing logging mechanism/filter used elsewhere in the plugin.

Suggested change

if ( false === $result ) {

if ( false === $result ) {

// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log -- Intentional diagnostic logging for database write failures.

Copilot · 2026-04-07T07:23:33Z

+	public function init() {
+		add_action( 'wp_ajax_mailchimp_sf_track_form_view', array( $this, 'handle_form_view' ) );
+		add_action( 'wp_ajax_nopriv_mailchimp_sf_track_form_view', array( $this, 'handle_form_view' ) );
+		add_action( 'wp_ajax_mailchimp_sf_get_analytics', array( $this, 'handle_get_analytics' ) );
+		add_action( 'mailchimp_sf_form_submission_success', array( $this, 'track_submission' ) );
+	}


New analytics behavior (AJAX endpoints + view/submission tracking) isn’t covered by existing Cypress tests. Since the repo already has e2e coverage for the Analytics admin page, add tests that (1) trigger a form view POST and assert the analytics table/counts change, and (2) submit a form successfully and assert submissions increment (and invalid submissions do not).

Copilot · 2026-04-07T07:23:34Z

+	// Create analytics table if it doesn't exist.
+	$analytics_db_version = get_option( 'mailchimp_sf_analytics_db_version' );
+	if ( false === $analytics_db_version || version_compare( Mailchimp_Analytics_Data::DB_VERSION, $analytics_db_version, '>' ) ) {
+		Mailchimp_Analytics_Data::create_table();
+	}


This table-creation block won’t run if mailchimp_version_check() returns early when MCSF_VER === get_option('mc_version'). That means a site can end up with no analytics table if the mc_version option is already current (e.g., version string unchanged, or option manually set) but mailchimp_sf_analytics_db_version is missing/outdated. Consider moving the analytics DB version check above the early return, or adjusting the early return condition to also account for the analytics DB version option.

iamdharmesh

Thanks for the changes @alaca. This looks good overall now. Just added 1 minor nit comment and this will be ready for the go. Thanks

iamdharmesh

Thanks for changes @alaca

ankitguptaindia · 2026-04-24T14:32:56Z

QA Status: Query Raised ⚠️

@alaca

This PR works as expected and currently, every page refresh increments the view count in the same browse/tab, just on a refresh. Is there any logic to track unique user events (e.g., cookies/session)?

Should we consider adding deduplication to avoid multiple counts from the same user/machine/etc within a short timeframe?

Feel free to let me know if this behaviour is expected or out of scope.

Recording.1793.mp4

cc: @iamdharmesh

alaca · 2026-04-28T08:12:50Z

@ankitguptaindia yeah, I agree, but I checked the PRD doc, and I was not able to find anything related to this. We can always address this later.

…nd-form-event-tracking

ankitguptaindia · 2026-05-15T07:50:24Z

QA Status: Approved ✅

Test Result:

Tested the analytics tracking functionality and confirmed the analytics table is created successfully on plugin activation. Verified that form views and successful submissions are tracked correctly, including multiple forms on the same page, while invalid submissions are not tracked. Also confirmed analytics data displays correctly under Mailchimp > Analytics in wp-admin.

Functional Demo / Screencast:

Recording.1793.mp4

Additional enhancement suggestion logged separately: #215

🖥 Testing Environment -

Details

WordPress: 7.0-RC3-62350
PHP: 8.4.18
Server: nginx/1.26.1
Database: mysqli (Server: 8.0.35 / Client: mysqlnd 8.4.18)
Browser: Chrome 147.0.0.0
OS: macOS
Theme: Twenty Twenty-Five 1.4

initial commit

32e9d80

github-actions Bot assigned alaca Mar 24, 2026

github-actions Bot added this to the 2.1.0 milestone Mar 24, 2026

github-actions Bot added the needs:code-review This requires code review. label Mar 24, 2026

alaca requested a review from iamdharmesh March 24, 2026 15:51

iamdharmesh changed the base branch from develop to feature/analytics-admin-page March 28, 2026 03:45

iamdharmesh requested a review from Copilot March 28, 2026 03:45

Copilot started reviewing on behalf of iamdharmesh March 28, 2026 03:45 View session

Copilot AI reviewed Mar 28, 2026

View reviewed changes

iamdharmesh requested changes Mar 28, 2026

View reviewed changes

alaca and others added 12 commits April 6, 2026 08:20

Update includes/admin/templates/analytics.php

fd8d824

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update includes/class-mailchimp-analytics-data.php

fd10548

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update includes/admin/templates/analytics.php

af36860

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update assets/js/mailchimp.js

c9e70bf

Co-authored-by: Dharmesh Patel <dspatel44@gmail.com>

Update includes/class-mailchimp-analytics-data.php

db85ff8

Co-authored-by: Dharmesh Patel <dspatel44@gmail.com>

refactor: admin nonce

d502e39

refactor: log error

2910bf8

Merge branch 'feature/analytics-admin-page' into feature/data-layer-a…

7e0cb95

…nd-form-event-tracking

refactor: remove copilot suggestion

b912629

feature: add get analytics ajax action

b7a201d

feature: localize mailchimpSFAnalytics

dfa1f5d

feature: add fetchAnalyticsData

2275cc9

alaca requested a review from iamdharmesh April 6, 2026 07:17

iamdharmesh requested a review from Copilot April 7, 2026 07:18

Copilot started reviewing on behalf of iamdharmesh April 7, 2026 07:18 View session

Copilot AI reviewed Apr 7, 2026

View reviewed changes

iamdharmesh reviewed Apr 7, 2026

View reviewed changes

Comment thread mailchimp.php Outdated

refactor: remove activation hook

8d5d146

alaca requested a review from iamdharmesh April 7, 2026 09:55

iamdharmesh approved these changes Apr 7, 2026

View reviewed changes

iamdharmesh requested a review from ankitguptaindia April 17, 2026 16:48

Merge branch 'feature/analytics-admin-page' into feature/data-layer-a…

39b3a6a

…nd-form-event-tracking

iamdharmesh merged commit ac79c78 into feature/analytics-admin-page May 13, 2026

This was referenced May 13, 2026

[Simple Analytics] Add Data Layer & Form Event Tracking #213

Merged

Implement Simple Analytics #212

Draft

ankitguptaindia mentioned this pull request May 15, 2026

Enhancement Suggestion: Consider Deduplication for View Count Tracking #215

Open

1 task

ankitguptaindia mentioned this pull request May 15, 2026

[Simple Analytics] Add Data Layer & Form Event Tracking #198

Open

	contentArea.innerHTML = JSON.stringify(data);
	contentArea.textContent = JSON.stringify(data);

	if ( false === $result ) {
	if ( false === $result ) {
	// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log -- Logs DB write failures for analytics tracking.

Conversation

alaca commented Mar 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description of the Change

How to test the Change

Changelog Entry

Credits

Checklist:

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Mar 28, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

iamdharmesh left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

alaca commented Apr 6, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

iamdharmesh left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

iamdharmesh left a comment

Choose a reason for hiding this comment

Uh oh!

ankitguptaindia commented Apr 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

QA Status: Query Raised ⚠️

Uh oh!

alaca commented Apr 28, 2026

Uh oh!

ankitguptaindia commented May 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

QA Status: Approved ✅

Test Result:

Functional Demo / Screencast:

Additional enhancement suggestion logged separately: #215

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

alaca commented Mar 24, 2026 •

edited

Loading

ankitguptaindia commented Apr 24, 2026 •

edited

Loading

ankitguptaindia commented May 15, 2026 •

edited

Loading