Merge pull request #201 from brainstormforce/latest-optin-changes

PS-1385: Make Analytics optin changes in AIOSRS

Author: sushmak02

README.md

@@ -4,7 +4,7 @@
 **Tags:** schema markup, rich snippets, wordpress seo, structured data, google search  
 **Requires at least:** 3.7  
 **Tested up to:** 6.8  
-**Stable tag:** 1.7.2  
+**Stable tag:** 1.7.3  
 **Requires PHP:** 7.4  
 **License:** GPLv2 or later  
 **License URI:** http://www.gnu.org/licenses/gpl-2.0.html  
@@ -83,6 +83,9 @@ No, the plugin provides an easy-to-use interface where you can add schema markup
 
 ## Changelog ##
 
+### 1.7.3 ###
+- Improvement: Refactored and optimized the codebase to improve code quality.
+
 ### 1.7.2 ###
 - Fixed: Resolved the issue for function _load_textdomain_just_in_time was called incorrectly in WP 6.8.
 

admin/bsf-analytics/changelog.txt

@@ -0,0 +1,10 @@
+v1.1.14 - 6-May-2025
+- New: Introduced a key 'hide_optin_checkbox' to hide checkbox from Settings > General.
+- Improvement: Single optin notice for all bsf products.
+- Improvement: Introduced delay of 7 days for next optin message if user has reqested request from product.
+v1.1.13 - 17-April-2025
+- Improvement: Ensured unique id for label's `for` attribute in deactivation survey fields by prefixing them with product slugs.
+- Improvement: Prevented deactivation survey from triggering when switching from a child theme to its parent.
+
+v1.1.12 - 24-March-2025
+- Improvement: Added `suremails` and `latepoint` slugs to UTM analytics.

admin/bsf-analytics/class-bsf-analytics.php

@@ -209,6 +209,15 @@ public function option_notice() {
 				return;
 			}
 
+			if( $this->is_tracking_enabled() ) {
+				return; // Don't need to display notice if any of our plugin already have the permission.
+			}
+
+			// If the user has opted out of tracking, don't show the notice till 7 days. 
+			if ( get_site_option( 'bsf_analytics_last_displayed_time' ) > time() -  ( 7 * DAY_IN_SECONDS ) ) {
+				return; // Don't display the notice if it was displayed recently.
+			}
+
 			foreach ( $this->entities as $key => $data ) {
 
 				$time_to_display = isset( $data['time_to_display'] ) ? $data['time_to_display'] : '+24 hours';
@@ -225,8 +234,13 @@ public function option_notice() {
 				}
 
 				/* translators: %s product name */
-				$notice_string = sprintf( __( 'Want to help make %1s even more awesome? Allow us to collect non-sensitive diagnostic data and usage information. ' ), '<strong>' . esc_html( $data['product_name'] ) . '</strong>' );
-
+				$notice_string = sprintf(
+					__(
+						'Help us improve %1$s and our other products!<br><br>With your permission, we\'d like to collect <strong>non-sensitive information</strong> from your website — like your PHP version and which features you use — so we can fix bugs faster, make smarter decisions, and build features that actually matter to you. <em>No personal info. Ever.</em>'
+					),
+					'<strong>' . esc_html( $data['product_name'] ) . '</strong>'
+				);
+				
 				if ( is_multisite() ) {
 					$notice_string .= __( 'This will be applicable for all sites from the network.' );
 				}
@@ -252,7 +266,7 @@ public function option_notice() {
 									</div>
 								</div>',
 							/* translators: %s usage doc link */
-							sprintf( $notice_string . '<span dir="%1s"><a href="%2s" target="_blank" rel="noreferrer noopener">%3s</a><span>', $language_dir, esc_url( $usage_doc_link ), __( ' Know More.' ) ),
+							sprintf( $notice_string . '<span dir="%1s"><a href="%2s" target="_blank" rel="noreferrer noopener">%3s</a><span><br><br>', $language_dir, esc_url( $usage_doc_link ), __( ' Know More.' ) ),
 							esc_url(
 								add_query_arg(
 									array(
@@ -281,6 +295,8 @@ public function option_notice() {
 						'display-with-other-notices' => true,
 					)
 				);
+
+				return;
 			}
 		}
 
@@ -344,6 +360,7 @@ private function optin( $source ) {
 		 */
 		private function optout( $source ) {
 			update_site_option( $source . '_analytics_optin', 'no' );
+			update_site_option( 'bsf_analytics_last_displayed_time', time() );
 		}
 
 		/**
@@ -357,6 +374,7 @@ private function includes() {
 
 			// Loads all the modules.
 			require_once __DIR__ . '/modules/deactivation-survey/classes/class-deactivation-survey-feedback.php';
+			require_once __DIR__ . '/modules/utm-analytics.php';
 		}
 
 		/**
@@ -372,6 +390,17 @@ public function register_usage_tracking_setting() {
 					return;
 				}
 
+				/**
+				 * Introducing a new key 'hide_optin_checkbox, which allows individual plugin  to hide optin checkbox
+				 * If they are providing providing in-plugin option to manage this option.
+				 * from General > Settings page.
+				 * 
+				 * @since 1.1.14
+				 */
+				if( ! empty( $data['hide_optin_checkbox'] ) && true === $data['hide_optin_checkbox'] ) {
+					continue;
+				}
+
 				$usage_doc_link = isset( $data['usage_doc_link'] ) ? $data['usage_doc_link'] : $this->usage_doc_link;
 				$author         = isset( $data['author'] ) ? $data['author'] : 'Brainstorm Force';
 
@@ -488,7 +517,7 @@ public function add_analytics_option_callback( $option, $value ) {
 		}
 
 		/**
-		 * Send analaytics track event if tracking is enabled.
+		 * Send analytics track event if tracking is enabled.
 		 *
 		 * @since 1.0.0
 		 */
@@ -540,7 +569,7 @@ public function load_deactivation_survey_form() {
 
 			if ( class_exists( 'Deactivation_Survey_Feedback' ) ) {
 				foreach ( $this->entities as $key => $data ) {
-					// If the deactibation_survery info in available then only add the form.
+					// If the deactivation_survey info in available then only add the form.
 					if ( ! empty( $data['deactivation_survey'] ) && is_array( $data['deactivation_survey'] ) ) {
 						foreach ( $data['deactivation_survey'] as $key => $survey_args ) {
 							Deactivation_Survey_Feedback::show_feedback_form(

admin/bsf-analytics/modules/deactivation-survey/assets/js/feedback.js

@@ -159,12 +159,14 @@
 			} else if ( e.target.classList.contains( 'activate' ) ) {
 				this.deactivateUrl = e.target.href;
 
-				// Don't show for Child Themes.
+				// Don't show for Child Themes if parent theme is active & Parent Theme if child theme is active.
 				if (
 					-1 !==
 					this.deactivateUrl.indexOf(
 						`stylesheet=${ udsVars?._current_theme }-child`
-					)
+					) ||
+					-1 !==
+					this.deactivateUrl.indexOf(`stylesheet=${udsVars?._current_theme}&`)
 				) {
 					return;
 				}

admin/bsf-analytics/modules/deactivation-survey/assets/js/feedback.min.js

@@ -100,6 +100,9 @@ public static function show_feedback_form( array $args = array() ) {
 				return;
 			}
 
+			// Product slug used for input fields and labels in each plugin's deactivation survey.
+			$product_slug = isset( $args['plugin_slug'] ) ? sanitize_text_field( $args['plugin_slug'] ) : 'bsf';
+
 			?>
 			<div id="<?php echo esc_attr( $id ); ?>" class="uds-feedback-form--wrapper" style="display: none">
 				<div class="uds-feedback-form--container">
@@ -121,11 +124,13 @@ public static function show_feedback_form( array $args = array() ) {
 						<?php } ?>
 
 						<form class="uds-feedback-form" id="uds-feedback-form" method="post">
-							<?php foreach ( $args['popup_reasons'] as $key => $value ) { ?>
+						<?php foreach ( $args['popup_reasons'] as $key => $value ) {
+								$input_id = $product_slug . '_uds_reason_input_' . $key;
+								?>
 								<fieldset>
 									<div class="reason">
-										<input type="radio" class="uds-reason-input" name="uds_reason_input" id="uds_reason_input_<?php echo esc_attr( $key ); ?>" value="<?php echo esc_attr( $key ); ?>" data-placeholder="<?php echo esc_attr( $value['placeholder'] ); ?>" data-show_cta="<?php echo esc_attr( $value['show_cta'] ); ?>" data-accept_feedback="<?php echo esc_attr( $value['accept_feedback'] ); ?>">
-										<label class="uds-reason-label" for="uds_reason_input_<?php echo esc_attr( $key ); ?>"><?php echo esc_html( $value['label'] ); ?></label>
+										<input type="radio" class="uds-reason-input" name="uds_reason_input" id="<?php echo esc_attr( $input_id ); ?>" value="<?php echo esc_attr( $key ); ?>" data-placeholder="<?php echo esc_attr( $value['placeholder'] ); ?>" data-show_cta="<?php echo esc_attr( $value['show_cta'] ); ?>" data-accept_feedback="<?php echo esc_attr( $value['accept_feedback'] ); ?>">
+										<label class="uds-reason-label" for="<?php echo esc_attr( $input_id ); ?>"><?php echo esc_html( $value['label'] ); ?></label>
 									</div>
 								</fieldset>
 							<?php } ?>
@@ -151,8 +156,8 @@ public static function show_feedback_form( array $args = array() ) {
 							</fieldset>
 
 							<div class="uds-feedback-form-sumbit--actions">
-							<button class="button button-primary uds-feedback-submit" data-action="submit"><?php esc_html_e( 'Submit & Deactivate' ); ?></button>
-							<button class="button button-secondary uds-feedback-skip" data-action="skip"><?php esc_html_e( 'Skip & Deactivate' ); ?></button>
+								<button class="button button-primary uds-feedback-submit" data-action="submit"><?php esc_html_e( 'Submit & Deactivate' ); ?></button>
+								<button class="button button-secondary uds-feedback-skip" data-action="skip"><?php esc_html_e( 'Skip & Deactivate' ); ?></button>
 								<input type="hidden" name="referer" value="<?php echo esc_url( get_site_url() ); ?>">
 								<input type="hidden" name="version" value="<?php echo esc_attr( $args['plugin_version'] ); ?>">
 								<input type="hidden" name="source" value="<?php echo esc_attr( $args['plugin_slug'] ); ?>">