Merge pull request #137 from mailchimp/fix/34

Make the form field visibility dependent on the WordPress "Include?" settings instead of the Mailchimp settings.

Author: vikrampm1

mailchimp.php

@@ -680,9 +680,15 @@ function mailchimp_sf_get_merge_vars( $list_id, $new_list, $update_option = true
 
 	foreach ( $mv['merge_fields'] as $mv_var ) {
 		$opt = 'mc_mv_' . $mv_var['tag'];
-		// turn them all on by default
 		if ( $new_list ) {
-			update_option( $opt, 'on' );
+			$public = $mv_var['public'] ?? false;
+			if ( ! $public ) {
+				// This is a hidden field, so we don't want to include it.
+				update_option( $opt, 'off' );
+			} else {
+				// We need to set the option to 'on' so that it shows up in the form.
+				update_option( $opt, 'on' );
+			}
 		}
 	}
 	return $mv['merge_fields'];

mailchimp_upgrade.php

@@ -22,6 +22,10 @@ function mailchimp_version_check() {
 		mailchimp_update_1_6_0();
 	}
 
+	if ( false === $db_option || version_compare( '1.7.0', $db_option, '>' ) ) {
+		mailchimp_update_1_7_0();
+	}
+
 	update_option( 'mc_version', MCSF_VER );
 }
 
@@ -36,3 +40,24 @@ function mailchimp_version_check() {
 function mailchimp_update_1_6_0() {
 	delete_option( 'mc_rewards' );
 }
+
+/**
+ * Version 1.7.0 update routine
+ *   - Set "Include?" value to "off" for hidden fields
+ *
+ * @return void
+ */
+function mailchimp_update_1_7_0() {
+	$form_fields = get_option( 'mc_merge_vars' );
+
+	if ( ! empty( $form_fields ) && is_array( $form_fields ) ) {
+		foreach ( $form_fields as $field ) {
+			if ( ! $field['required'] && ! $field['public'] ) {
+				$option = 'mc_mv_' . $field['tag'];
+				// This is a hidden field, so we don't want to include it.
+				// We need to set the option to 'off' so that it doesn't show up in the form.
+				update_option( $option, 'off' );
+			}
+		}
+	}
+}

mailchimp_widget.php

@@ -205,11 +205,7 @@ function mailchimp_sf_signup_form( $args = array() ) {
 
 		// Loop over our vars, and output the ones that are set to display
 		foreach ( $mv as $mv_var ) {
-			if ( ! $mv_var['public'] ) {
-				echo '<div style="display:none;">' . mailchimp_form_field( $mv_var, $num_fields ) . '</div>'; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Ignoring because form field is escaped in function
-			} else {
-				echo mailchimp_form_field( $mv_var, $num_fields ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Ignoring because form field is escaped in function
-			}
+			echo mailchimp_form_field( $mv_var, $num_fields ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Ignoring because form field is escaped in function
 		}
 
 		// Show an explanation of the * if there's more than one field

views/setup_page.php

@@ -297,7 +297,7 @@ function ( $ele ) {
 								<td><?php echo esc_html( ( 1 === intval( $mv_var['required'] ) ) ? 'Y' : 'N' ); ?></td>
 								<td>
 									<?php
-									if ( ! $mv_var['required'] && $mv_var['public'] ) {
+									if ( ! $mv_var['required'] ) {
 										$opt = 'mc_mv_' . $mv_var['tag'];
 										?>
 										<label class="screen-reader-text" for="<?php echo esc_attr( $opt ); ?>">