<?php
declare( strict_types=1 );
namespace Automattic\WooCommerce\Internal\EmailEditor;
use Automattic\WooCommerce\EmailEditor\Email_Editor_Container;
use Automattic\WooCommerce\EmailEditor\Engine\Dependency_Check;
use Automattic\WooCommerce\Internal\Admin\EmailPreview\EmailPreview;
use Automattic\WooCommerce\Internal\EmailEditor\EmailPatterns\PatternsController;
use Automattic\WooCommerce\Internal\EmailEditor\EmailTemplates\TemplatesController;
use Automattic\WooCommerce\Internal\EmailEditor\WCTransactionalEmails\WCEmailTemplateAutoApplier;
use Automattic\WooCommerce\Internal\EmailEditor\WCTransactionalEmails\WCEmailTemplateDivergenceDetector;
use Automattic\WooCommerce\Internal\EmailEditor\WCTransactionalEmails\WCEmailTemplateSyncBackfill;
use Automattic\WooCommerce\Internal\EmailEditor\WCTransactionalEmails\WCEmailTemplateSyncTracker;
use Automattic\WooCommerce\Internal\EmailEditor\WCTransactionalEmails\WCTransactionalEmails;
use Automattic\WooCommerce\Internal\EmailEditor\WCTransactionalEmails\WCTransactionalEmailPostsManager;
use Automattic\WooCommerce\Internal\EmailEditor\EmailTemplates\TemplateApiController;
use Automattic\WooCommerce\EmailEditor\Engine\Logger\Email_Editor_Logger;
use WP_Post;
defined( 'ABSPATH' ) || exit;
/**
* Integration class for the Email Editor functionality.
*/
class Integration {
const EMAIL_POST_TYPE = 'woo_email';
/**
* The email editor page renderer instance.
*
* @var PageRenderer
*/
private PageRenderer $editor_page_renderer;
/**
* The dependency check instance.
*
* @var Dependency_Check
*/
private Dependency_Check $dependency_check;
/**
* The template API controller instance.
*
* @var TemplateApiController
*/
private TemplateApiController $template_api_controller;
/**
* The email data API controller instance.
*
* @var EmailApiController
*/
private EmailApiController $email_api_controller;
/**
* The WC_Email instance.
*
* @var \WC_Email
*/
private \WC_Email $wc_email_instance;
/**
* Constructor.
*/
public function __construct() {
$editor_container = Email_Editor_Container::container();
$this->dependency_check = $editor_container->get( Dependency_Check::class );
}
/**
* Initialize the integration.
*
* @internal
*/
final public function init(): void {
if ( ! $this->dependency_check->are_dependencies_met() ) {
// If dependencies are not met, do not initialize the email editor integration.
return;
}
add_action( 'woocommerce_init', array( $this, 'initialize' ) );
// Register the post deletion cleanup hook early and unconditionally so it works in
// both admin and non-admin contexts (e.g. WP-CLI). This only needs $wpdb and the
// posts manager singleton — it must not depend on the full editor init chain.
add_action( 'before_delete_post', array( $this, 'delete_email_template_associated_with_email_editor_post' ), 10, 2 );
}
/**
* Initialize the integration.
*/
public function initialize() {
$this->init_logger();
$this->init_hooks();
$this->extend_post_api();
$this->extend_template_post_api();
$this->register_hooks();
}
/**
* Initialize the logger.
*/
public function init_logger() {
$editor_container = Email_Editor_Container::container();
$logger = $editor_container->get( Email_Editor_Logger::class );
// Register the WooCommerce logger with the email editor package.
$logger->set_logger( new Logger( wc_get_logger() ) );
}
/**
* Initialize hooks for required classes.
*/
public function init_hooks() {
$container = wc_get_container();
$container->get( PatternsController::class );
$container->get( TemplatesController::class );
$container->get( PersonalizationTagManager::class );
$container->get( BlockEmailRenderer::class );
$container->get( WCTransactionalEmails::class );
$this->editor_page_renderer = $container->get( PageRenderer::class );
$this->template_api_controller = $container->get( TemplateApiController::class );
$this->email_api_controller = $container->get( EmailApiController::class );
// Using any email class to get the instance.
$registered_emails = \WC_Emails::instance()->get_emails();
if ( isset( $registered_emails['WC_Email_New_Order'] ) ) {
$this->wc_email_instance = $registered_emails['WC_Email_New_Order'];
} else {
$first_email_key = array_key_first( $registered_emails );
$this->wc_email_instance = $registered_emails[ $first_email_key ];
}
}
/**
* Register hooks for the integration.
*/
public function register_hooks() {
add_filter( 'woocommerce_email_editor_post_types', array( $this, 'add_email_post_type' ) );
add_filter( 'woocommerce_is_email_editor_page', array( $this, 'is_editor_page' ), 10, 1 );
add_filter( 'replace_editor', array( $this, 'replace_editor' ), 10, 2 );
add_filter( 'woocommerce_email_editor_send_preview_email_rendered_data', array( $this, 'update_send_preview_email_rendered_data' ), 10, 2 );
add_filter( 'woocommerce_email_editor_send_preview_email_personalizer_context', array( $this, 'update_send_preview_email_personalizer_context' ) );
add_filter( 'woocommerce_email_editor_preview_post_template_html', array( $this, 'update_preview_post_template_html_data' ), 100, 1 );
add_action( 'woocommerce_email_editor_send_preview_email_before_wp_mail', array( $this, 'send_preview_email_before_wp_mail' ), 10 );
add_action( 'woocommerce_email_editor_send_preview_email_after_wp_mail', array( $this, 'send_preview_email_after_wp_mail' ), 10 );
add_filter( 'woocommerce_email_editor_send_preview_email_subject', array( $this, 'update_email_subject_for_send_preview_email' ), 10, 2 );
add_action( 'rest_api_init', array( $this->email_api_controller, 'register_routes' ) );
// Priority 11 ensures the email editor's `init` bootstrap (default priority 10)
// has registered the `woo_email` post type before we register meta against it.
add_action( 'init', array( WCEmailTemplateDivergenceDetector::class, 'register_meta' ), 11 );
add_action( 'woocommerce_updated', array( WCEmailTemplateDivergenceDetector::class, 'run_sweep' ), 20 );
add_action( WCEmailTemplateSyncBackfill::BACKFILL_COMPLETE_ACTION, array( WCEmailTemplateDivergenceDetector::class, 'run_sweep' ), 10 );
// Fresh installs never cross the 10.8 db-update boundary, so the RSM-149
// backfill never runs and `BACKFILL_COMPLETE_OPTION` is never written.
// Stamp it from the `woocommerce_newly_installed` action so `run_sweep()`
// doesn't sit dormant forever on new sites.
add_action( 'woocommerce_newly_installed', array( WCEmailTemplateDivergenceDetector::class, 'mark_backfill_complete_on_fresh_install' ), 20 );
add_action( WCEmailTemplateAutoApplier::AUTO_APPLY_AS_HOOK, array( WCEmailTemplateAutoApplier::class, 'run' ), 10 );
add_action( 'woocommerce_email_template_divergence_sweep_complete', array( WCEmailTemplateAutoApplier::class, 'schedule' ), 10 );
// RSM-145 Tracks instrumentation: fire `_backfill_completed` once when the
// RSM-149 sync-meta backfill finalises. The backfill class itself is in the
// 10.8 feature freeze, so we hook the existing action it already publishes.
add_action( WCEmailTemplateSyncBackfill::BACKFILL_COMPLETE_ACTION, array( WCEmailTemplateSyncTracker::class, 'on_backfill_complete' ), 20 );
}
/**
* Add WooCommerce email post type to the list of supported post types.
*
* @param array $post_types List of post types.
* @return array Modified list of post types.
*/
public function add_email_post_type( array $post_types ): array {
$post_types[] = array(
'name' => self::EMAIL_POST_TYPE,
'args' => array(
'labels' => array(
'name' => __( 'Emails', 'woocommerce' ),
'singular_name' => __( 'Email', 'woocommerce' ),
'add_new_item' => __( 'Add Email', 'woocommerce' ),
'edit_item' => __( 'Edit Email', 'woocommerce' ),
'new_item' => __( 'New Email', 'woocommerce' ),
'view_item' => __( 'View Email', 'woocommerce' ),
'search_items' => __( 'Search Emails', 'woocommerce' ),
),
'rewrite' => array( 'slug' => self::EMAIL_POST_TYPE ),
'supports' => array(
'title',
'editor' => array(
'default-mode' => 'template-locked',
),
'excerpt',
'custom-fields',
),
'capability_type' => self::EMAIL_POST_TYPE,
'capabilities' => array(
'edit_post' => 'manage_woocommerce',
'read_post' => 'manage_woocommerce',
'delete_post' => 'manage_woocommerce',
'edit_posts' => 'manage_woocommerce',
'edit_others_posts' => 'manage_woocommerce',
'delete_posts' => 'manage_woocommerce',
'publish_posts' => 'manage_woocommerce',
'read_private_posts' => 'manage_woocommerce',
'create_posts' => 'manage_woocommerce',
),
'map_meta_cap' => false,
),
);
return $post_types;
}
/**
* Check if current page is email editor page.
*
* @param bool $is_editor_page Current editor page status.
* @return bool Whether current page is email editor page.
*/
public function is_editor_page( bool $is_editor_page ): bool {
if ( $is_editor_page ) {
return $is_editor_page;
}
// We need to check early if we are on the email editor page. The check runs early so we can't use current_screen() here.
if ( is_admin() && isset( $_GET['post'] ) && isset( $_GET['action'] ) && 'edit' === $_GET['action'] ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- We are not verifying the nonce here because we are not using the nonce in the function and the data is okay in this context (WP-admin errors out gracefully).
$post = get_post( (int) $_GET['post'] ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- We are not verifying the nonce here because we are not using the nonce in the function and the data is okay in this context (WP-admin errors out gracefully).
return $post && self::EMAIL_POST_TYPE === $post->post_type;
}
return false;
}
/**
* Replace the default editor with our custom email editor.
*
* @param bool $replace Whether to replace the editor.
* @param WP_Post $post Post object.
* @return bool Whether the editor was replaced.
*/
public function replace_editor( $replace, $post ) {
$current_screen = get_current_screen();
if ( self::EMAIL_POST_TYPE === $post->post_type && $current_screen ) {
$this->editor_page_renderer->render();
return true;
}
return $replace;
}
/**
* Delete the email template associated with the email editor post when the post is permanently deleted.
*
* @param int $post_id The post ID.
* @param WP_Post $post The post object.
*/
public function delete_email_template_associated_with_email_editor_post( $post_id, $post ) {
if ( self::EMAIL_POST_TYPE !== $post->post_type ) {
return;
}
$post_manager = WCTransactionalEmailPostsManager::get_instance();
$email_type = $post_manager->get_email_type_from_post_id( $post_id, true );
if ( empty( $email_type ) ) {
return;
}
$post_manager->delete_email_template( $email_type );
}
/**
* Extend the post API for the wp_template post type to add and save the woocommerce_data field.
*/
public function extend_template_post_api(): void {
register_rest_field(
'wp_template',
'woocommerce_data',
array(
'get_callback' => array( $this->template_api_controller, 'get_template_data' ),
'update_callback' => array( $this->template_api_controller, 'save_template_data' ),
'schema' => $this->template_api_controller->get_template_data_schema(),
)
);
}
/**
* Filter email preview data to replace placeholders with actual content.
*
* This method retrieves the appropriate email type based on the request,
* generates the email content using the WooContentProcessor, and replaces
* the placeholder in the preview HTML.
*
* @param string $data The preview data.
* @param string $email_type The email type identifier (e.g., 'customer_processing_order').
* @param int $post_id The post ID.
* @return string The updated preview data with placeholders replaced.
*/
private function update_email_preview_data( $data, string $email_type, $post_id = 0 ) {
$type_param = EmailPreview::DEFAULT_EMAIL_TYPE;
if ( ! empty( $post_id ) ) {
$type_param = WCTransactionalEmailPostsManager::get_instance()->get_email_type_class_name_from_post_id( $post_id );
} elseif ( ! empty( $email_type ) ) {
$type_param = WCTransactionalEmailPostsManager::get_instance()->get_email_type_class_name_from_email_id( $email_type );
}
$email_preview = wc_get_container()->get( EmailPreview::class );
try {
$message = $email_preview->generate_placeholder_content( $type_param );
} catch ( \InvalidArgumentException $e ) {
// If the provided type was invalid, fall back to the default.
try {
$message = $email_preview->generate_placeholder_content( EmailPreview::DEFAULT_EMAIL_TYPE );
} catch ( \Throwable $e ) {
return $data;
}
} catch ( \Throwable $e ) {
return $data;
}
return str_replace( BlockEmailRenderer::WOO_EMAIL_CONTENT_PLACEHOLDER, $message, $data );
}
/**
* Filter email preview data used when sending a preview email.
*
* @param string $data The preview data.
* @param WP_Post $post The post object.
* @return string The updated preview data with placeholders replaced.
*/
public function update_send_preview_email_rendered_data( $data, $post ) {
$email_type = '';
$post_body = file_get_contents( 'php://input' );
if ( $post_body ) {
$decoded_body = json_decode( $post_body );
if ( json_last_error() === JSON_ERROR_NONE && isset( $decoded_body->postId ) ) { // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
$post_id = absint( $decoded_body->postId ); // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
$email_type = WCTransactionalEmailPostsManager::get_instance()->get_email_type_from_post_id( $post_id );
if ( ! empty( $email_type ) ) {
return $this->update_email_preview_data( $data, $email_type );
}
}
} elseif ( ! empty( $post ) && $post instanceof \WP_Post ) {
$email_type = WCTransactionalEmailPostsManager::get_instance()->get_email_type_from_post_id( $post->ID );
if ( ! empty( $email_type ) ) {
return $this->update_email_preview_data( $data, $email_type, $post->ID );
}
}
return $data;
}
/**
* Update the personalizer context for the send preview email.
*
* @param array $context The personalizer context.
* @return array The updated personalizer context.
*/
public function update_send_preview_email_personalizer_context( $context ) {
$post_manager = WCTransactionalEmailPostsManager::get_instance();
$email_id = $post_manager->get_email_type_from_post_id( get_the_ID() );
$email_type = $email_id ? $post_manager->get_email_type_class_name_from_email_id( $email_id ) : EmailPreview::DEFAULT_EMAIL_TYPE;
$email_preview = wc_get_container()->get( EmailPreview::class );
try {
$email_preview->set_email_type( $email_type );
} catch ( \InvalidArgumentException $e ) {
// If the email type is invalid, return the context data as is.
return $context;
}
$email = $email_preview->get_email();
$email->recipient = $context['recipient_email'] ?? '';
$personalizer = wc_get_container()->get( TransactionalEmailPersonalizer::class );
return $personalizer->prepare_context_data( $context, $email );
}
/**
* Filter email preview data used when previewing the email in new tab.
*
* @param string $data The preview HTML string.
* @return string The updated preview HTML with placeholders replaced.
*/
public function update_preview_post_template_html_data( $data ) {
// return early if the data does not contain the placeholder meaning it's already been processed.
if ( ! str_contains( (string) $data, BlockEmailRenderer::WOO_EMAIL_CONTENT_PLACEHOLDER ) ) {
return $data;
}
// phpcs:disable WordPress.Security.NonceVerification.Recommended
// Nonce verification is disabled here because the preview action doesn't modify data,
// and the check caused issues with the 'Preview in new tab' feature due to context changes.
$type_param = isset( $_GET['woo_email'] ) ? sanitize_text_field( wp_unslash( $_GET['woo_email'] ) ) : '';
// check for post id (preview id) in the request.
$post_id = isset( $_REQUEST['preview_id'] ) ? sanitize_text_field( wp_unslash( $_REQUEST['preview_id'] ) ) : '';
// phpcs:enable
return $this->update_email_preview_data( $data, $type_param, $post_id );
}
/**
* Extend the post API for the woo_email post type to add and save the woocommerce_data field.
*/
public function extend_post_api(): void {
register_rest_field(
self::EMAIL_POST_TYPE,
'woocommerce_data',
array(
'get_callback' => array( $this->email_api_controller, 'get_email_data' ),
'update_callback' => array( $this->email_api_controller, 'save_email_data' ),
'schema' => $this->email_api_controller->get_email_data_schema(),
)
);
}
/**
* Action hook callback before sending the preview email via wp_mail
*
* @since 10.6.0
* @return void
*/
public function send_preview_email_before_wp_mail() {
add_filter( 'wp_mail_from', array( $this->wc_email_instance, 'get_from_address' ) );
add_filter( 'wp_mail_from_name', array( $this->wc_email_instance, 'get_from_name' ) );
}
/**
* Action hook callback after sending the preview email via wp_mail.
*
* @since 10.6.0
* @return void
*/
public function send_preview_email_after_wp_mail() {
remove_filter( 'wp_mail_from', array( $this->wc_email_instance, 'get_from_address' ) );
remove_filter( 'wp_mail_from_name', array( $this->wc_email_instance, 'get_from_name' ) );
}
/**
* Update the email subject for the send preview email.
*
* @param string $subject The email subject.
* @param WP_Post $post The post object.
* @return string The updated email subject.
*/
public function update_email_subject_for_send_preview_email( $subject, $post ) {
if ( ! $post instanceof \WP_Post || self::EMAIL_POST_TYPE !== $post->post_type ) {
return $subject;
}
$post_manager = WCTransactionalEmailPostsManager::get_instance();
$email_type_class_name = $post_manager->get_email_type_class_name_from_post_id( $post->ID );
if ( empty( $email_type_class_name ) ) {
return $subject;
}
/**
* Validate the email type class name.
*
* @var EmailPreview $email_preview
*/
$email_preview = wc_get_container()->get( EmailPreview::class );
try {
$email_preview->set_email_type( $email_type_class_name );
return $email_preview->get_subject();
} catch ( \InvalidArgumentException $e ) {
return $subject;
} catch ( \Throwable $e ) {
return $subject;
}
}
}