'method_title' => __( 'Flat rate', 'woocommerce' ), 'method_id' => 'flat_rate', 'total' => '5.00', ) ); $order->add_item( $shipping_item ); $address = $this->get_dummy_address(); $order->set_billing_address( $address ); $order->set_shipping_address( $address ); /** * A dummy WC_Order used in email preview. * * @param WC_Order $order The dummy order object. * @param string $email_type The email type to preview. * * @since 9.6.0 */ return apply_filters( 'woocommerce_email_preview_dummy_order', $order, $this->email_type ); } /** * Apply a contextual status to the dummy order based on the previewed email type. * * @param WC_Order $order Dummy order instance. * @return WC_Order */ private function apply_dummy_order_status( WC_Order $order ): WC_Order { $email_type_status_map = array( 'WC_Email_Customer_Completed_Order' => OrderStatus::COMPLETED, 'WC_Email_Customer_Processing_Order' => OrderStatus::PROCESSING, 'WC_Email_Customer_On_Hold_Order' => OrderStatus::ON_HOLD, 'WC_Email_Customer_Failed_Order' => OrderStatus::FAILED, 'WC_Email_Customer_Cancelled_Order' => OrderStatus::CANCELLED, 'WC_Email_Customer_Refunded_Order' => OrderStatus::REFUNDED, 'WC_Email_New_Order' => OrderStatus::PROCESSING, 'WC_Email_Cancelled_Order' => OrderStatus::CANCELLED, 'WC_Email_Failed_Order' => OrderStatus::FAILED, ); $status = $email_type_status_map[ $this->email_type ] ?? OrderStatus::PROCESSING; $order->set_status( $status ); return $order; } /** * Get a dummy product. Also used with `woocommerce_order_item_product` filter * when email templates tries to get the product from the database. * * @return WC_Product */ private function get_dummy_product() { $product = new WC_Product(); $product->set_name( __( 'Dummy Product', 'woocommerce' ) ); $product->set_price( 25 ); /** * A dummy WC_Product used in email preview. * * @param WC_Product $product The dummy product object. * @param string $email_type The email type to preview. * * @since 9.6.0 */ return apply_filters( 'woocommerce_email_preview_dummy_product', $product, $this->email_type ); } /** * Get a dummy product variation. * * @return WC_Product_Variation */ private function get_dummy_product_variation() { $variation = new WC_Product_Variation(); $variation->set_name( __( 'Dummy Product Variation', 'woocommerce' ) ); $variation->set_price( 20 ); $variation->set_attributes( array( __( 'Color', 'woocommerce' ) => __( 'Red', 'woocommerce' ), __( 'Size', 'woocommerce' ) => __( 'Small', 'woocommerce' ), ) ); /** * A dummy WC_Product_Variation used in email preview. * * @param WC_Product_Variation $variation The dummy product variation object. * @param string $email_type The email type to preview. * * @since 9.7.0 */ return apply_filters( 'woocommerce_email_preview_dummy_product_variation', $variation, $this->email_type ); } /** * Get a dummy downloadable/virtual product. * * @return WC_Product */ private function get_dummy_downloadable_product() { $product = new WC_Product(); $product->set_name( __( 'Dummy Downloadable Product', 'woocommerce' ) ); $product->set_price( 15 ); $product->set_virtual( true ); $product->set_downloadable( true ); /** * A dummy downloadable WC_Product used in email preview. * * @param WC_Product $product The dummy downloadable product object. * @param string $email_type The email type to preview. * * @since 10.3.0 */ return apply_filters( 'woocommerce_email_preview_dummy_downloadable_product', $product, $this->email_type ); } /** * Get a dummy address. * * @return array */ private function get_dummy_address() { $address = array( 'first_name' => 'John', 'last_name' => 'Doe', 'company' => 'Company', 'email' => 'john@company.com', 'phone' => '555-555-5555', 'address_1' => '123 Fake Street', 'city' => 'Faketown', 'postcode' => '12345', 'country' => 'US', 'state' => 'CA', ); /** * A dummy address used in email preview as billing and shipping one. * * @param array $address The dummy address. * @param string $email_type The email type to preview. * * @since 9.6.0 */ return apply_filters( 'woocommerce_email_preview_dummy_address', $address, $this->email_type ); } /** * Get the placeholders for the email preview. * * @param mixed $email_object The object to render email with. Can be WC_Order, WP_User, etc. * @return array */ private function get_placeholders( $email_object ) { $placeholders = array(); if ( is_a( $email_object, 'WC_Order' ) ) { $placeholders['{order_date}'] = wc_format_datetime( $email_object->get_date_created() ); $placeholders['{order_number}'] = $email_object->get_order_number(); $placeholders['{order_billing_full_name}'] = $email_object->get_formatted_billing_full_name(); } /** * Placeholders for email preview. * * @param array $placeholders Placeholders for email subject. * @param string $email_type The email type to preview. * @param mixed $email_object The object to render email with. @since 9.9.0 * * @since 9.6.0 */ return apply_filters( 'woocommerce_email_preview_placeholders', $placeholders, $this->email_type, $email_object ); } /** * Set up filters for email preview. */ public function set_up_filters() { $this->switch_to_site_locale(); // Always show shipping address in the preview email. add_filter( 'woocommerce_order_needs_shipping_address', array( $this, 'enable_shipping_address' ) ); // Email templates fetch product from the database to show additional information, which are not // saved in WC_Order_Item_Product. This filter enables fetching that data also in email preview. add_filter( 'woocommerce_order_item_product', array( $this, 'get_dummy_product_when_not_set' ), 10, 1 ); // Enable email preview mode - this way transient values are fetched for live preview. add_filter( 'woocommerce_is_email_preview', array( $this, 'enable_preview_mode' ) ); // Use placeholder image included in WooCommerce files. add_filter( 'woocommerce_order_item_thumbnail', array( $this, 'get_placeholder_image' ) ); // Make products in preview considered downloadable and provide dummy file so WC core shows downloads. add_filter( 'woocommerce_is_downloadable', array( $this, 'force_product_downloadable' ), 10, 1 ); add_filter( 'woocommerce_product_file', array( $this, 'provide_dummy_product_file' ), 10, 1 ); // Provide dummy downloadable items for email preview. add_filter( 'woocommerce_order_get_downloadable_items', array( $this, 'get_dummy_downloadable_items' ), 10, 1 ); } /** * Clean up filters after email preview. */ public function clean_up_filters() { remove_filter( 'woocommerce_order_needs_shipping_address', array( $this, 'enable_shipping_address' ) ); remove_filter( 'woocommerce_order_item_product', array( $this, 'get_dummy_product_when_not_set' ), 10 ); remove_filter( 'woocommerce_is_email_preview', array( $this, 'enable_preview_mode' ) ); remove_filter( 'woocommerce_order_item_thumbnail', array( $this, 'get_placeholder_image' ) ); remove_filter( 'woocommerce_is_downloadable', array( $this, 'force_product_downloadable' ), 10 ); remove_filter( 'woocommerce_product_file', array( $this, 'provide_dummy_product_file' ), 10 ); remove_filter( 'woocommerce_order_get_downloadable_items', array( $this, 'get_dummy_downloadable_items' ), 10 ); $this->restore_locale(); } /** * Enable shipping address in the preview email. Not using __return_true so * we don't accidentally remove the same filter used by other plugin or theme. * * @return true */ public function enable_shipping_address() { return true; } /** * Enable preview mode to use transient values in email-styles.php. Not using __return_true * so we don't accidentally remove the same filter used by other plugin or theme. * * @return true */ public function enable_preview_mode() { return true; } /** * Get the placeholder image for the preview email. * * @return string */ public function get_placeholder_image() { return ''; } /** * Force products in preview to be considered downloadable so core renders downloads section. * * @param bool $is_downloadable Current value. * @return bool */ public function force_product_downloadable( $is_downloadable ) { /** * Filters whether the current request is an email preview. * * When true, products should be considered downloadable so the downloads * section renders in applicable emails during preview. * * @since 9.6.0 * * @param bool $is_email_preview Whether preview mode is active. */ if ( apply_filters( 'woocommerce_is_email_preview', false ) ) { return true; } return $is_downloadable; } /** * Provide a dummy product file so product->has_file() returns true in preview. * * @param array|null $file Current file array or null. * @return array|null */ public function provide_dummy_product_file( $file ) { /** * Filters whether the current request is an email preview. * * When true, provide a dummy product file array so downloadable template parts * can render during preview. * * @since 9.6.0 * * @param bool $is_email_preview Whether preview mode is active. */ if ( apply_filters( 'woocommerce_is_email_preview', false ) ) { return array( 'name' => __( 'Sample Download File.pdf', 'woocommerce' ), 'file' => 'sample-download.pdf', ); } return $file; } /** * Get dummy downloadable items for email preview. * * @param array $downloads Existing downloads. * @return array */ public function get_dummy_downloadable_items( $downloads ) { $dummy_downloads = array( array( 'product_name' => $this->get_dummy_downloadable_product()->get_name(), 'product_id' => $this->get_dummy_downloadable_product()->get_id(), 'download_url' => 'https://example.com/download', 'download_name' => __( 'Sample Download File.pdf', 'woocommerce' ), 'access_expires' => time() + ( 30 * DAY_IN_SECONDS ), ), ); return array_merge( $downloads, $dummy_downloads ); } /** * Generate placeholder content for a specific email type, typically used in the email editor. * * Encapsulates the logic for setting the email type, generating raw content, applying styles, * ensuring links open in new tabs, and handling errors based on WP_DEBUG. * * @param string $email_type_class_name The class name of the WC_Email type (e.g., 'WC_Email_Customer_Processing_Order'). * @return string The generated and styled HTML content. * @throws \RuntimeException If content generation fails. If rendering fails. */ public function generate_placeholder_content( string $email_type_class_name ): string { // Note: set_email_type can throw InvalidArgumentException. $this->set_email_type( $email_type_class_name ); $woo_content_processor = wc_get_container()->get( WooContentProcessor::class ); $generate_content_closure = function () use ( $woo_content_processor ) { // Note: If 'woocommerce_email_styles' filter was intentional and `prepare_css` isn't // the intended callback, adjust accordingly. This assumes `prepare_css` applies styles // needed for the Woo content block. add_filter( 'woocommerce_email_styles', array( $woo_content_processor, 'prepare_css' ), 10, 2 ); $content = $woo_content_processor->get_woo_content( $this->get_email() ); $content = $this->get_email()->style_inline( $content ); $content = $this->ensure_links_open_in_new_tab( $content ); return $content; }; $this->set_up_filters(); $message = ''; try { if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) { $message = $generate_content_closure(); } else { // Use output buffering to prevent partial renders with PHP notices or warnings when WP_DEBUG is off. ob_start(); try { $message = $generate_content_closure(); } catch ( Throwable $e ) { ob_end_clean(); // Let the caller handle the exception. throw new \RuntimeException( esc_html__( 'There was an error rendering the email editor placeholder content.', 'woocommerce' ), 0, $e ); } ob_end_clean(); } } finally { $this->clean_up_filters(); } return $message; } /** * Switch to the site locale. This is to ensure the email is displayed * in the store's language, as the customer would see it, not the admin's language. */ private function switch_to_site_locale() { if ( ! $this->locale_switched ) { wc_switch_to_site_locale(); $this->locale_switched = true; } } /** * Restore the original locale. */ private function restore_locale() { if ( $this->locale_switched ) { wc_restore_locale(); $this->locale_switched = false; } } }