Add experimental emails settings API to V4 (#61849)

costasovo · web-flow · commit 901da7e8bcdb · 2025-11-12T09:22:03.000+01:00
diff --git a/plugins/woocommerce/changelog/wooprd-926-move-notifications-listing-api-to-woocommerce b/plugins/woocommerce/changelog/wooprd-926-move-notifications-listing-api-to-woocommerce
@@ -0,0 +1,5 @@
+Significance: patch
+Type: add
+Comment: Add experimental V4 settings/emails API
+
+
diff --git a/plugins/woocommerce/includes/emails/class-wc-email-cancelled-order.php b/plugins/woocommerce/includes/emails/class-wc-email-cancelled-order.php
@@ -236,6 +236,9 @@ public function init_form_fields() {
 				$this->form_fields['cc']  = $this->get_cc_field();
 				$this->form_fields['bcc'] = $this->get_bcc_field();
 			}
+			if ( $this->block_email_editor_enabled ) {
+				$this->form_fields['preheader'] = $this->get_preheader_field();
+			}
 		}
 	}
 
diff --git a/plugins/woocommerce/includes/emails/class-wc-email-customer-cancelled-order.php b/plugins/woocommerce/includes/emails/class-wc-email-customer-cancelled-order.php
@@ -226,6 +226,9 @@ public function init_form_fields() {
 				$this->form_fields['cc']  = $this->get_cc_field();
 				$this->form_fields['bcc'] = $this->get_bcc_field();
 			}
+			if ( $this->block_email_editor_enabled ) {
+				$this->form_fields['preheader'] = $this->get_preheader_field();
+			}
 		}
 	}
 
diff --git a/plugins/woocommerce/includes/emails/class-wc-email-customer-invoice.php b/plugins/woocommerce/includes/emails/class-wc-email-customer-invoice.php
@@ -260,6 +260,9 @@ public function init_form_fields() {
 				$this->form_fields['cc']  = $this->get_cc_field();
 				$this->form_fields['bcc'] = $this->get_bcc_field();
 			}
+			if ( $this->block_email_editor_enabled ) {
+				$this->form_fields['preheader'] = $this->get_preheader_field();
+			}
 		}
 	}
 
diff --git a/plugins/woocommerce/includes/emails/class-wc-email-customer-pos-refunded-order.php b/plugins/woocommerce/includes/emails/class-wc-email-customer-pos-refunded-order.php
@@ -376,6 +376,9 @@ public function init_form_fields() {
 				$this->form_fields['cc']  = $this->get_cc_field();
 				$this->form_fields['bcc'] = $this->get_bcc_field();
 			}
+			if ( $this->block_email_editor_enabled ) {
+				$this->form_fields['preheader'] = $this->get_preheader_field();
+			}
 		}
 
 		/**
diff --git a/plugins/woocommerce/includes/emails/class-wc-email-customer-refunded-order.php b/plugins/woocommerce/includes/emails/class-wc-email-customer-refunded-order.php
@@ -357,6 +357,9 @@ public function init_form_fields() {
 				$this->form_fields['cc']  = $this->get_cc_field();
 				$this->form_fields['bcc'] = $this->get_bcc_field();
 			}
+			if ( $this->block_email_editor_enabled ) {
+				$this->form_fields['preheader'] = $this->get_preheader_field();
+			}
 		}
 	}
 
diff --git a/plugins/woocommerce/includes/emails/class-wc-email-failed-order.php b/plugins/woocommerce/includes/emails/class-wc-email-failed-order.php
@@ -236,6 +236,9 @@ public function init_form_fields() {
 				$this->form_fields['cc']  = $this->get_cc_field();
 				$this->form_fields['bcc'] = $this->get_bcc_field();
 			}
+			if ( $this->block_email_editor_enabled ) {
+				$this->form_fields['preheader'] = $this->get_preheader_field();
+			}
 		}
 	}
 
diff --git a/plugins/woocommerce/includes/emails/class-wc-email-new-order.php b/plugins/woocommerce/includes/emails/class-wc-email-new-order.php
@@ -264,6 +264,9 @@ public function init_form_fields() {
 				$this->form_fields['cc']  = $this->get_cc_field();
 				$this->form_fields['bcc'] = $this->get_bcc_field();
 			}
+			if ( $this->block_email_editor_enabled ) {
+				$this->form_fields['preheader'] = $this->get_preheader_field();
+			}
 		}
 
 
diff --git a/plugins/woocommerce/includes/emails/class-wc-email.php b/plugins/woocommerce/includes/emails/class-wc-email.php
@@ -1190,6 +1190,9 @@ public function init_form_fields() {
 			$this->form_fields['cc']  = $this->get_cc_field();
 			$this->form_fields['bcc'] = $this->get_bcc_field();
 		}
+		if ( $this->block_email_editor_enabled ) {
+			$this->form_fields['preheader'] = $this->get_preheader_field();
+		}
 	}
 
 	/**
@@ -1226,6 +1229,22 @@ protected function get_bcc_field() {
 		);
 	}
 
+	/**
+	 * Get the preheader field definition.
+	 *
+	 * @return array
+	 */
+	protected function get_preheader_field() {
+		return array(
+			'title'       => __( 'Preheader', 'woocommerce' ),
+			'description' => __( 'Shown as a preview in the Inbox, next to the subject line. (Max 150 characters).', 'woocommerce' ),
+			'placeholder' => '',
+			'type'        => 'text',
+			'default'     => '',
+			'desc_tip'    => true,
+		);
+	}
+
 	/**
 	 * Email type options.
 	 *
diff --git a/plugins/woocommerce/includes/rest-api/Server.php b/plugins/woocommerce/includes/rest-api/Server.php
@@ -24,6 +24,7 @@
 use Automattic\WooCommerce\Internal\RestApi\Routes\V4\Customers\Controller as CustomersController;
 use Automattic\WooCommerce\Internal\RestApi\Routes\V4\Settings\General\Controller as GeneralSettingsController;
 use Automattic\WooCommerce\Internal\RestApi\Routes\V4\Settings\Email\Controller as EmailSettingsController;
+use Automattic\WooCommerce\Internal\RestApi\Routes\V4\Settings\Emails\Controller as EmailsSettingsController;
 use Automattic\WooCommerce\Internal\RestApi\Routes\V4\Fulfillments\Controller as FulfillmentsController;
 
 /**
@@ -241,6 +242,7 @@ protected function get_v4_controllers() {
 			'offline-payment-methods'   => OfflinePaymentMethodsController::class,
 			'settings-general'          => GeneralSettingsController::class,
 			'settings-email'            => EmailSettingsController::class,
+			'settings-emails'           => EmailsSettingsController::class,
 			'settings-products'         => SettingsProductsController::class,
 			'settings-payment-gateways' => PaymentGatewaysController::class,
 			// This is a wrapper that redirects V4 settings requests to the V3 settings controller.
diff --git a/plugins/woocommerce/src/Internal/RestApi/Routes/V4/Settings/Emails/Controller.php b/plugins/woocommerce/src/Internal/RestApi/Routes/V4/Settings/Emails/Controller.php
diff --git a/plugins/woocommerce/src/Internal/RestApi/Routes/V4/Settings/Emails/Schema/EmailsSettingsSchema.php b/plugins/woocommerce/src/Internal/RestApi/Routes/V4/Settings/Emails/Schema/EmailsSettingsSchema.php
diff --git a/plugins/woocommerce/tests/php/src/Internal/RestApi/Routes/V4/Settings/Email/EmailSettingsControllerTest.php b/plugins/woocommerce/tests/php/src/Internal/RestApi/Routes/V4/Settings/Email/EmailSettingsControllerTest.php
diff --git a/plugins/woocommerce/tests/php/src/Internal/RestApi/Routes/V4/Settings/Emails/EmailsSettingsControllerTest.php b/plugins/woocommerce/tests/php/src/Internal/RestApi/Routes/V4/Settings/Emails/EmailsSettingsControllerTest.php

Original file line number	Diff line number	Diff line change
`@@ -236,6 +236,9 @@ public function init_form_fields() {`
`236`	`236`	`$this->form_fields['cc'] = $this->get_cc_field();`
`237`	`237`	`$this->form_fields['bcc'] = $this->get_bcc_field();`
`238`	`238`	`}`
	`239`	`+ if ( $this->block_email_editor_enabled ) {`
	`240`	`+ $this->form_fields['preheader'] = $this->get_preheader_field();`
	`241`	`+ }`
`239`	`242`	`}`
`240`	`243`	`}`
`241`	`244`
Original file line number	Diff line number	Diff line change
`@@ -226,6 +226,9 @@ public function init_form_fields() {`
`226`	`226`	`$this->form_fields['cc'] = $this->get_cc_field();`
`227`	`227`	`$this->form_fields['bcc'] = $this->get_bcc_field();`
`228`	`228`	`}`
	`229`	`+ if ( $this->block_email_editor_enabled ) {`
	`230`	`+ $this->form_fields['preheader'] = $this->get_preheader_field();`
	`231`	`+ }`
`229`	`232`	`}`
`230`	`233`	`}`
`231`	`234`
Original file line number	Diff line number	Diff line change
`@@ -260,6 +260,9 @@ public function init_form_fields() {`
`260`	`260`	`$this->form_fields['cc'] = $this->get_cc_field();`
`261`	`261`	`$this->form_fields['bcc'] = $this->get_bcc_field();`
`262`	`262`	`}`
	`263`	`+ if ( $this->block_email_editor_enabled ) {`
	`264`	`+ $this->form_fields['preheader'] = $this->get_preheader_field();`
	`265`	`+ }`
`263`	`266`	`}`
`264`	`267`	`}`
`265`	`268`
Original file line number	Diff line number	Diff line change
`@@ -376,6 +376,9 @@ public function init_form_fields() {`
`376`	`376`	`$this->form_fields['cc'] = $this->get_cc_field();`
`377`	`377`	`$this->form_fields['bcc'] = $this->get_bcc_field();`
`378`	`378`	`}`
	`379`	`+ if ( $this->block_email_editor_enabled ) {`
	`380`	`+ $this->form_fields['preheader'] = $this->get_preheader_field();`
	`381`	`+ }`
`379`	`382`	`}`
`380`	`383`
`381`	`384`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -357,6 +357,9 @@ public function init_form_fields() {`
`357`	`357`	`$this->form_fields['cc'] = $this->get_cc_field();`
`358`	`358`	`$this->form_fields['bcc'] = $this->get_bcc_field();`
`359`	`359`	`}`
	`360`	`+ if ( $this->block_email_editor_enabled ) {`
	`361`	`+ $this->form_fields['preheader'] = $this->get_preheader_field();`
	`362`	`+ }`
`360`	`363`	`}`
`361`	`364`	`}`
`362`	`365`
Original file line number	Diff line number	Diff line change
`@@ -264,6 +264,9 @@ public function init_form_fields() {`
`264`	`264`	`$this->form_fields['cc'] = $this->get_cc_field();`
`265`	`265`	`$this->form_fields['bcc'] = $this->get_bcc_field();`
`266`	`266`	`}`
	`267`	`+ if ( $this->block_email_editor_enabled ) {`
	`268`	`+ $this->form_fields['preheader'] = $this->get_preheader_field();`
	`269`	`+ }`
`267`	`270`	`}`
`268`	`271`
`269`	`272`