Remove custom fields mapping and add Kit unsubscribe on delete

Remove last_name_field and custom_fields settings from subscribers configuration

Remove custom_fields from cache clearing operations

Add kit_unsubscribe_on_delete setting to optionally unsubscribe from Kit when deleting subscribers

Implement Kit unsubscribe in bulk and single delete operations

Add subscriber form handling and admin notices to Subscribers_List

Update Subscribers_List_Table to show plugin names from events instead

Author: ajaydsouza

includes/admin/class-kit-oauth.php

@@ -293,7 +293,7 @@ public function get_settings_url(): string {
 	 * @return void
 	 */
 	public function clear_kit_cache(): void {
-		foreach ( array( 'forms', 'tags', 'sequences', 'custom_fields' ) as $transient ) {
+		foreach ( array( 'forms', 'tags', 'sequences' ) as $transient ) {
 			delete_transient( 'freemkit_kit_' . $transient );
 		}
 	}

includes/admin/class-settings-wizard.php

@@ -118,8 +118,6 @@ public function get_wizard_steps(): array {
 					array(
 						'kit_form_id',
 						'kit_tag_id',
-						'last_name_field',
-						'custom_fields',
 					),
 					$all_settings
 				),
@@ -412,7 +410,6 @@ public function enqueue_wizard_tom_select_data( string $hook ): void {
 				'endpoint'        => '',
 				'forms'           => Settings::get_localized_kit_data( 'forms' ),
 				'tags'            => Settings::get_localized_kit_data( 'tags' ),
-				'custom_fields'   => Settings::get_localized_kit_data( 'custom_fields' ),
 				'freemius_events' => Settings::get_localized_kit_data( 'freemius_events' ),
 				'strings'         => array(
 					/* translators: %s: search term */

includes/admin/class-settings.php

@@ -450,53 +450,25 @@ public static function settings_kit(): array {
 	 */
 	public static function settings_subscribers(): array {
 		$settings = array(
-			'subscribers'              => array(
+			'subscribers'               => array(
 				'id'   => 'subscribers',
 				'name' => __( 'Subscribers', 'freemkit' ),
 				'desc' => __( 'Configure your subscribers settings in this tab.', 'freemkit' ),
 				'type' => 'header',
 			),
-			'respect_marketing_optout' => array(
+			'respect_marketing_optout'  => array(
 				'id'      => 'respect_marketing_optout',
 				'name'    => __( 'Respect Marketing Opt-out', 'freemkit' ),
 				'desc'    => __( 'When enabled, users who opt out of marketing on Freemius will be unsubscribed from Kit and blocked from future subscriptions.', 'freemkit' ),
 				'type'    => 'checkbox',
 				'default' => 1,
 			),
-			'last_name_field'          => array(
-				'id'               => 'last_name_field',
-				'name'             => __( 'Last Name field', 'freemkit' ),
-				'desc'             => __( 'Select the field name for mapping the last name in Kit. Note: Kit lacks a default last name field; a custom field must be created in your account first.', 'freemkit' ),
-				'type'             => 'text',
-				'default'          => '',
-				'field_class'      => 'ts_autocomplete',
-				'field_attributes' => self::get_kit_search_field_attributes( 'custom_fields', array( 'maxItems' => 1 ) ),
-			),
-			'custom_fields'            => array(
-				'id'                => 'custom_fields',
-				'name'              => __( 'Custom Fields', 'freemkit' ),
-				'desc'              => '',
-				'type'              => 'repeater',
-				'live_update_field' => 'local_name',
-				'default'           => array(),
-				'fields'            => array(
-					array(
-						'id'      => 'local_name',
-						'name'    => __( 'Field Local Name', 'freemkit' ),
-						'desc'    => __( 'Enter the name of your field that will be used locally in the database on this site.', 'freemkit' ),
-						'type'    => 'text',
-						'default' => '',
-					),
-					array(
-						'id'               => 'remote_name',
-						'name'             => __( 'Field name on Kit', 'freemkit' ),
-						'desc'             => __( 'Enter the name of your custom field that is used on the Kit.', 'freemkit' ),
-						'type'             => 'text',
-						'default'          => '',
-						'field_class'      => 'ts_autocomplete',
-						'field_attributes' => self::get_kit_search_field_attributes( 'custom_fields', array( 'maxItems' => 1 ) ),
-					),
-				),
+			'kit_unsubscribe_on_delete' => array(
+				'id'      => 'kit_unsubscribe_on_delete',
+				'name'    => __( 'Unsubscribe from Kit on Delete', 'freemkit' ),
+				'desc'    => __( 'When enabled, deleting a subscriber will also unsubscribe them from Kit.', 'freemkit' ),
+				'type'    => 'checkbox',
+				'default' => 0,
 			),
 		);
 
@@ -515,7 +487,7 @@ public static function settings_subscribers(): array {
 	 *
 	 * @since 1.0.0
 	 *
-	 * @param string $endpoint   The endpoint to search ('forms', 'tags', 'custom_fields', 'freemius_events').
+	 * @param string $endpoint   The endpoint to search ('forms', 'tags', 'freemius_events').
 	 * @param array  $ts_config  Optional TypeScript configuration.
 	 * @return array Field attributes array
 	 */
@@ -706,7 +678,6 @@ public function admin_enqueue_scripts( $hook ) {
 					'endpoint'        => '',
 					'forms'           => self::get_localized_kit_data( 'forms' ),
 					'tags'            => self::get_localized_kit_data( 'tags' ),
-					'custom_fields'   => self::get_localized_kit_data( 'custom_fields' ),
 					'freemius_events' => self::get_localized_kit_data( 'freemius_events' ),
 					'strings'         => array(
 						/* translators: %s: search term */
@@ -906,12 +877,12 @@ public function handle_kit_search() {
 				case 'tags':
 					$data = $this->get_kit_tags( $query );
 					break;
-				case 'custom_fields':
-					$data = $this->get_kit_custom_fields( $query );
-					break;
 				case 'freemius_events':
 					$data = Freemius::get_events( $query );
 					break;
+				case 'custom_fields':
+					$data = self::get_kit_data( 'custom_fields', $query );
+					break;
 				default:
 					$data = array();
 					break;
@@ -962,7 +933,7 @@ public function ajax_refresh_lists() {
 			wp_send_json_error( (object) array( 'message' => esc_html__( 'You do not have permission to perform this action.', 'freemkit' ) ) );
 		}
 
-		foreach ( array( 'forms', 'tags', 'sequences', 'custom_fields' ) as $transient ) {
+		foreach ( array( 'forms', 'tags', 'sequences' ) as $transient ) {
 			delete_transient( 'freemkit_kit_' . $transient );
 		}
 
@@ -1276,7 +1247,13 @@ public static function normalize_kit_items( array $items, string $type ): array
 				continue;
 			}
 
-			$id = isset( $item['id'] ) ? (string) $item['id'] : ( isset( $item['key'] ) ? (string) $item['key'] : '' );
+			// Custom fields: use the API key (e.g. 'last_name') not the numeric ID,
+			// because Kit's update_subscriber endpoint expects field keys in the fields object.
+			if ( 'custom_fields' === $type && isset( $item['key'] ) ) {
+				$id = (string) $item['key'];
+			} else {
+				$id = isset( $item['id'] ) ? (string) $item['id'] : ( isset( $item['key'] ) ? (string) $item['key'] : '' );
+			}
 			if ( '' === $id ) {
 				continue;
 			}
@@ -1286,8 +1263,6 @@ public static function normalize_kit_items( array $items, string $type ): array
 				$name = (string) $item['name'];
 			} elseif ( isset( $item['label'] ) ) {
 				$name = (string) $item['label'];
-			} elseif ( 'custom_fields' === $type && isset( $item['key'] ) ) {
-				$name = (string) $item['key'];
 			}
 
 			if ( '' === $name ) {
@@ -1327,18 +1302,6 @@ public function get_kit_tags( $search = '' ) {
 		return self::get_kit_data( 'tags', $search );
 	}
 
-	/**
-	 * Get Kit custom fields, optionally filtered by search term.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @param string $search Optional search term.
-	 * @return array|\WP_Error Array of custom fields.
-	 */
-	public function get_kit_custom_fields( $search = '' ) {
-		return self::get_kit_data( 'custom_fields', $search );
-	}
-
 	/**
 	 * Add a "Test Connection" button after the OAuth connection output.
 	 *