feat: add tracking opt-in checkbox (#507)

Author: girishpanchal30

assets/css/style-wizard.css

@@ -296,6 +296,19 @@ h2.wpmm-title span img {
     font-size: 18px;
 }
 
+.subscribe-step .opt-in-container {
+    display: flex;
+    gap: 8px;
+    margin-top: 20px;
+}
+
+.subscribe-step .opt-in-container svg.components-checkbox-control__checked {
+    top: 20%;
+}
+
+.subscribe-step .opt-in-container label {
+    text-align: left;
+}
 #email-input-wrap {
     position: relative;
     display: flex;

assets/js/scripts-admin.js

@@ -429,11 +429,13 @@ jQuery( function( $ ) {
 
 		emailInput.removeClass( 'invalid' );
 		subscribeButton.addClass( 'is-busy' );
+		const optIn = $('#wizard-opt-in').is( ':checked' );
 
 		$.post( wpmmVars.ajaxURL, {
 			action: 'wpmm_subscribe',
 			email,
 			_wpnonce: wpmmVars.wizardNonce,
+			opt_in: optIn ? 1 : 0,
 		}, function( response ) {
 			if ( ! response.success ) {
 				alert( response.data );

includes/classes/wp-maintenance-mode-admin.php

@@ -806,6 +806,10 @@ public function subscribe_newsletter() {
 				die( esc_html__( 'Empty field: email', 'wp-maintenance-mode' ) );
 			}
 
+			if ( isset( $_POST['opt_in'] ) && sanitize_text_field( $_POST['opt_in'] ) ) {
+				update_option( 'wp_maintenance_mode_logger_flag', 'yes' );
+			}
+
 			$response = wp_remote_post(
 				self::SUBSCRIBE_ROUTE,
 				array(

includes/classes/wp-maintenance-mode.php

@@ -159,6 +159,9 @@ function() {
 					}
 				);
 			}
+
+			add_action( 'init', array( $this, 'initialize_telemetry' ) );
+
 		}
 
 		/**
@@ -1449,6 +1452,30 @@ public function set_current_page_category( $category ) {
 		public function get_current_page_category() {
 			return $this->current_page_category;
 		}
+
+		/**
+		 * Initialize telemetry.
+		 *
+		 * @return void
+		 */
+		public function initialize_telemetry() {
+			if ( 'yes' === get_option( 'wp_maintenance_mode_logger_flag' ) ) {
+				add_filter( 'themeisle_sdk_enable_telemetry', '__return_true' );
+				add_filter(
+					'themeisle_sdk_telemetry_products',
+					function( $products ) {
+						foreach ( $products as &$product ) {
+							if ( isset( $product['slug'] ) && 'wp' === $product['slug'] ) {
+								$product['slug'] = 'wp_maintenance_mode';
+							}
+						}
+
+						return $products;
+					}
+				);
+			}
+
+		}
 	}
 
 }

views/wizard.php

@@ -116,6 +116,13 @@
 					<input type="text" value="<?php echo esc_attr( get_bloginfo( 'admin_email' ) ); ?>" />
 					<input type="button" class="button button-primary button-big subscribe-button" value="<?php esc_attr_e( 'Sign me up', 'wp-maintenance-mode' ); ?>" />
 				</div>
+				<div class="opt-in-container">
+					<span class="components-checkbox-control__input-container">
+						<input id="wizard-opt-in" type="checkbox" class="components-checkbox-control__input" checked>
+						<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="24" height="24" role="presentation" class="components-checkbox-control__checked" aria-hidden="true" focusable="false"><path d="M16.7 7.1l-6.3 8.5-3.3-2.5-.9 1.2 4.5 3.4L17.9 8z"></path></svg>
+					</span>
+					<label for="wizard-opt-in"><?php echo esc_html__( 'Help us improve LightStart by opting in to anonymous usage tracking. No sensitive data is collected.', 'wp-maintenance-mode' ); ?></label>
+				</div>
 				<input id="skip-subscribe" type="button" class="button button-link skip-link" value="<?php esc_attr_e( 'I\'ll skip for now, thanks!', 'wp-maintenance-mode' ); ?>" />
 			</div>
 		</div>