Commit 209abefced6 for woocommerce
commit 209abefced6283999db52f9a685bc942760ca393
Author: Burak Pars Aydin <hi@burakaydin.net>
Date: Thu Nov 12 12:59:28 2026 +0300
HPOS - Add export support for orders in Tools > Export (#59459)
* Add initial class structure for HPOS order export integration
* Continue implementing HPOS export handler logic
* Refactor the logic, introduce methods
* Begin work on order export functionality
* Use rss2_head instead of rss2_item action
* Add XML export for HPOS orders
* [WIP] Add export_order_to_xml() and maybe_backfill_hpos_order()
* Include essential postmeta in HPOS order export to support valid import
* Stream HPOS orders in WordPress exports
* Add changelog entry for HPOS order exports
* Skip nameless metadata in order exports
* Keep stored totals and core WXR shape in HPOS order exports
- Export the stored order total instead of the value rounded to the
current price decimals on load.
- Use core's http:// WXR namespaces, add wfw, and fire rss2_head.
- Leave _edit_last out with the other source-site user IDs.
- Skip the admin output buffer only for the Orders export download
that the handler serves (HPOS authoritative, compatibility mode
off), so every other export download keeps it.
- Load orders 100 at a time, so the runtime cache is flushed less
often on sites without a persistent object cache.
- Lift the time limit so large stores do not get a truncated file.
- Keep the order cache groups in memory during the download, so the
export does not write every order to a persistent object cache.
- Export the address index meta, which order search reads on the
importing site.
- Write the exporting user as the item author, so the WordPress
importer does not warn about every order, and the order key as the
post password, as the posts data store does.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NM9YXrrrEAc27JhcHMxqoh
Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NM9YXvDzJFFht4DvTKoMJX
Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NM9YXuosxswakSqmyCYNRx
* Free export memory on any object cache and keep carriage returns in WXR
Use MemoryManager::flush_caches() between batches so the HPOS order export
also releases memory on object cache drop-ins that do not support
flush_runtime.
Write carriage returns as character references. XML parsers drop literal
ones, which changed string lengths inside serialized meta and made it
fail to unserialize on import.
Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NM9YXtQ4yWmRDFpTLGyvVr
* Keep stored currency, billing email and terms in HPOS order exports
Export the stored currency and billing email when loading the order
rejects them, and write the order's taxonomy terms as WXR categories,
as the WordPress exporter does for posts.
Clear the output buffers in the exporter instead of skipping
WC_Admin::buffer(), so streaming also works when another plugin opened
a buffer, and earlier output stays out of the file.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NM9YXvAe8xBiM4r65ubQwb
---------
Co-authored-by: Ján Mikláš <neosinner@gmail.com>
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
diff --git a/plugins/woocommerce/changelog/59459-add-44352 b/plugins/woocommerce/changelog/59459-add-44352
new file mode 100644
index 00000000000..a581dba002f
--- /dev/null
+++ b/plugins/woocommerce/changelog/59459-add-44352
@@ -0,0 +1,4 @@
+Significance: patch
+Type: fix
+
+Include HPOS orders when downloading Orders from Tools > Export with compatibility mode off.
diff --git a/plugins/woocommerce/includes/admin/class-wc-admin.php b/plugins/woocommerce/includes/admin/class-wc-admin.php
index 5d4bd856372..c29a80d407f 100644
--- a/plugins/woocommerce/includes/admin/class-wc-admin.php
+++ b/plugins/woocommerce/includes/admin/class-wc-admin.php
@@ -11,6 +11,7 @@ declare(strict_types=1);
use Automattic\WooCommerce\Admin\PageController;
use Automattic\WooCommerce\Internal\Admin\EmailPreview\EmailPreview;
+use Automattic\WooCommerce\Internal\Admin\ImportExport\HposOrderExportHandler;
if ( ! defined( 'ABSPATH' ) ) {
exit; // Exit if accessed directly.
@@ -117,6 +118,9 @@ class WC_Admin {
}
switch ( $screen->id ) {
+ case 'export':
+ wc_get_container()->get( HposOrderExportHandler::class );
+ break;
case 'dashboard':
case 'dashboard-network':
include __DIR__ . '/class-wc-admin-dashboard-setup.php';
diff --git a/plugins/woocommerce/src/Internal/Admin/ImportExport/HposOrderExportHandler.php b/plugins/woocommerce/src/Internal/Admin/ImportExport/HposOrderExportHandler.php
new file mode 100644
index 00000000000..af3079719b8
--- /dev/null
+++ b/plugins/woocommerce/src/Internal/Admin/ImportExport/HposOrderExportHandler.php
@@ -0,0 +1,518 @@
+<?php
+declare( strict_types = 1 );
+
+namespace Automattic\WooCommerce\Internal\Admin\ImportExport;
+
+use Automattic\WooCommerce\Caches\OrderCache;
+use Automattic\WooCommerce\Enums\OrderStatus;
+use Automattic\WooCommerce\Internal\DataStores\Orders\CustomOrdersTableController;
+use Automattic\WooCommerce\Internal\DataStores\Orders\DataSynchronizer;
+use Automattic\WooCommerce\Internal\DataStores\Orders\OrdersTableDataStore;
+use Automattic\WooCommerce\Internal\DataStores\Orders\OrdersTableDataStoreMeta;
+use Automattic\WooCommerce\Internal\ProductFeed\Utils\MemoryManager;
+use WC_Order;
+use WC_Order_Factory;
+
+defined( 'ABSPATH' ) || exit;
+
+/**
+ * Exports orders from HPOS through WordPress Tools > Export.
+ *
+ * @since 11.4.0
+ */
+class HposOrderExportHandler {
+
+ /**
+ * Number of orders loaded at a time.
+ */
+ private const BATCH_SIZE = 100;
+
+ /**
+ * The HPOS controller.
+ *
+ * @var CustomOrdersTableController
+ */
+ private CustomOrdersTableController $controller;
+
+ /**
+ * The order data synchronizer.
+ *
+ * @var DataSynchronizer
+ */
+ private DataSynchronizer $synchronizer;
+
+ /**
+ * The HPOS meta data store.
+ *
+ * @var OrdersTableDataStoreMeta
+ */
+ private OrdersTableDataStoreMeta $meta_store;
+
+ /**
+ * The order object cache.
+ *
+ * @var OrderCache
+ */
+ private OrderCache $order_cache;
+
+ /**
+ * Frees the in-memory caches between batches.
+ *
+ * @var MemoryManager
+ */
+ private MemoryManager $memory_manager;
+
+ /**
+ * Register the export hook.
+ */
+ public function __construct() {
+ add_action( 'export_wp', array( $this, 'handle_export_wp' ), PHP_INT_MAX );
+ }
+
+ /**
+ * Initialize dependencies.
+ *
+ * @internal
+ *
+ * @param CustomOrdersTableController $controller The HPOS controller.
+ * @param DataSynchronizer $synchronizer The order data synchronizer.
+ * @param OrdersTableDataStoreMeta $meta_store The HPOS meta data store.
+ * @param OrderCache $order_cache The order object cache.
+ * @param MemoryManager $memory_manager Frees the in-memory caches between batches.
+ */
+ final public function init( CustomOrdersTableController $controller, DataSynchronizer $synchronizer, OrdersTableDataStoreMeta $meta_store, OrderCache $order_cache, MemoryManager $memory_manager ): void {
+ $this->controller = $controller;
+ $this->synchronizer = $synchronizer;
+ $this->meta_store = $meta_store;
+ $this->order_cache = $order_cache;
+ $this->memory_manager = $memory_manager;
+ }
+
+ /**
+ * Serve the Orders download from HPOS with compatibility mode off.
+ *
+ * @internal
+ *
+ * @param mixed $args WordPress export arguments.
+ */
+ public function handle_export_wp( $args ): void {
+ if ( ! is_array( $args ) || 'shop_order' !== ( $args['content'] ?? '' ) ) {
+ return;
+ }
+
+ $screen = function_exists( 'get_current_screen' ) ? get_current_screen() : null;
+ if ( ! $screen || 'export' !== $screen->id || ! current_user_can( 'export' ) ) {
+ return;
+ }
+
+ $post_type = get_post_type_object( 'shop_order' );
+ if ( ! $post_type || ! $post_type->can_export || ! $this->controller->custom_orders_table_usage_is_enabled() || $this->synchronizer->data_sync_is_enabled() ) {
+ return;
+ }
+
+ $sitename = sanitize_key( get_bloginfo( 'name' ) );
+ $sitename = '' === $sitename ? '' : $sitename . '.';
+ $date = gmdate( 'Y-m-d' );
+ $filename = $sitename . 'WordPress.' . $date . '.xml';
+
+ /** This filter is documented in wp-admin/includes/export.php. */
+ $filtered_filename = apply_filters( 'export_wp_filename', $filename, $sitename, $date ); // phpcs:ignore WooCommerce.Commenting.CommentHooks.MissingSinceComment -- WordPress core filter.
+ $filename = is_string( $filtered_filename ) && '' !== $filtered_filename ? $filtered_filename : $filename;
+
+ // Stream instead of holding the export in memory, and keep earlier output out of the file.
+ self::clean_buffers();
+
+ nocache_headers();
+ header( 'Content-Type: text/xml; charset=UTF-8' );
+ header( 'Content-Disposition: attachment; filename="' . sanitize_file_name( $filename ) . '"' );
+
+ wc_set_time_limit( 0 );
+
+ // Loading an order writes it to the object cache. Keep the order object, order data and order meta groups
+ // in memory for this request, so the export does not push every order through a persistent cache.
+ wp_cache_add_non_persistent_groups( array( $this->order_cache->get_object_type(), 'orders_data', 'orders_meta' ) );
+
+ // Core exports post rows after rss2_head, including mirrors that can be stale or deleted in HPOS.
+ $this->stream_export();
+ exit;
+ }
+
+ /**
+ * Stream a WXR document containing the current HPOS orders.
+ */
+ private function stream_export(): void {
+ global $wpdb;
+
+ echo "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n";
+ ?>
+<rss version="2.0"
+ xmlns:excerpt="http://wordpress.org/export/1.2/excerpt/"
+ xmlns:content="http://purl.org/rss/1.0/modules/content/"
+ xmlns:wfw="http://wellformedweb.org/CommentAPI/"
+ xmlns:dc="http://purl.org/dc/elements/1.1/"
+ xmlns:wp="http://wordpress.org/export/1.2/">
+<channel>
+ <?php
+ self::write_fields(
+ array(
+ 'title' => get_bloginfo( 'name' ),
+ 'link' => home_url(),
+ 'description' => get_bloginfo( 'description' ),
+ 'wp:wxr_version' => '1.2',
+ 'wp:base_site_url' => is_multisite() ? network_home_url() : home_url(),
+ 'wp:base_blog_url' => home_url(),
+ )
+ );
+
+ /** This action is documented in wp-includes/feed-rss2.php. */
+ do_action( 'rss2_head' ); // phpcs:ignore WooCommerce.Commenting.CommentHooks.MissingSinceComment -- WordPress core action.
+
+ $table = OrdersTableDataStore::get_orders_table_name();
+ $last_id = 0;
+ $taxonomies = get_object_taxonomies( 'shop_order' );
+
+ // Bound the scan at the newest ID when the export starts.
+ // phpcs:ignore WordPress.DB.DirectDatabaseQuery, WordPress.DB.PreparedSQL.InterpolatedNotPrepared, WordPress.DB.PreparedSQL.NotPrepared -- The table name comes from the order data store.
+ $max_id = (int) $wpdb->get_var( "SELECT MAX(id) FROM $table" );
+ while ( $last_id < $max_id ) {
+ // Select stored values that loading an order can change or drop: unregistered statuses, the total's precision,
+ // and a currency or billing email that its setter now rejects.
+ // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching -- Stream IDs and statuses in primary key order.
+ $batch = $wpdb->get_results(
+ $wpdb->prepare(
+ "SELECT id, status, total_amount, currency, billing_email FROM $table WHERE id > %d AND id <= %d AND type = %s AND status <> %s ORDER BY id LIMIT %d", // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- The table name comes from the order data store.
+ $last_id,
+ $max_id,
+ 'shop_order',
+ OrderStatus::AUTO_DRAFT,
+ self::BATCH_SIZE
+ ),
+ OBJECT_K
+ );
+ if ( ! $batch ) {
+ break;
+ }
+
+ $order_ids = array_map( 'intval', array_keys( $batch ) );
+ $last_id = (int) array_key_last( $batch );
+
+ // Skip orders deleted after their ID was selected.
+ $orders = WC_Order_Factory::get_orders( $order_ids, true );
+ $order_meta = $this->meta_store->get_meta_data_for_object_ids( $order_ids );
+ list( $notes, $note_meta ) = self::get_notes( $order_ids );
+ $terms = self::get_terms( $order_ids, $taxonomies );
+ foreach ( $orders as $order ) {
+ if ( ! $order instanceof WC_Order || 'shop_order' !== $order->get_type() ) {
+ continue;
+ }
+ $id = $order->get_id();
+ $this->export_order_to_xml( $order, $batch[ $id ], $order_meta[ $id ] ?? array(), $terms[ $id ] ?? array(), $notes[ $id ] ?? array(), $note_meta );
+ }
+
+ // Also frees memory on object caches that cannot flush their runtime cache.
+ $this->memory_manager->flush_caches();
+ }
+
+ echo "</channel>\n</rss>\n";
+ }
+
+ /**
+ * Read comments and their raw meta in batches, as the WordPress exporter does for each post.
+ *
+ * @param int[] $order_ids The orders in the batch.
+ * @return array{array<int, \stdClass[]>, array<int, \stdClass[]>}
+ */
+ private static function get_notes( array $order_ids ): array {
+ global $wpdb;
+
+ $id_placeholders = implode( ', ', array_fill( 0, count( $order_ids ), '%d' ) );
+ // phpcs:disable WordPress.DB.DirectDatabaseQuery, WordPress.DB.PreparedSQL.InterpolatedNotPrepared, WordPress.DB.PreparedSQLPlaceholders.UnfinishedPrepare, WordPress.DB.PreparedSQLPlaceholders.ReplacementsWrongNumber -- The IN lists contain one placeholder per ID. Table names come from wpdb.
+ $notes = $wpdb->get_results(
+ $wpdb->prepare(
+ "SELECT * FROM $wpdb->comments WHERE comment_post_ID IN ($id_placeholders) AND comment_approved <> %s ORDER BY comment_ID",
+ array_merge( $order_ids, array( 'spam' ) )
+ )
+ );
+ if ( ! $notes ) {
+ return array( array(), array() );
+ }
+
+ $notes_by_order = array();
+ foreach ( $notes as $note ) {
+ $notes_by_order[ (int) $note->comment_post_ID ][] = $note;
+ }
+
+ $comment_ids = array_column( $notes, 'comment_ID' );
+ $id_placeholders = implode( ', ', array_fill( 0, count( $comment_ids ), '%d' ) );
+ $meta_rows = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $wpdb->commentmeta WHERE comment_id IN ($id_placeholders) ORDER BY meta_id", $comment_ids ) );
+ // phpcs:enable WordPress.DB.DirectDatabaseQuery, WordPress.DB.PreparedSQL.InterpolatedNotPrepared, WordPress.DB.PreparedSQLPlaceholders.UnfinishedPrepare, WordPress.DB.PreparedSQLPlaceholders.ReplacementsWrongNumber
+
+ $meta_by_comment = array();
+ foreach ( $meta_rows as $meta ) {
+ $meta_by_comment[ (int) $meta->comment_id ][] = $meta;
+ }
+
+ return array( $notes_by_order, $meta_by_comment );
+ }
+
+ /**
+ * Read the terms assigned to the orders, as the WordPress exporter does for each post.
+ *
+ * @param int[] $order_ids The orders in the batch.
+ * @param string[] $taxonomies The taxonomies registered for orders.
+ * @return array<int, \WP_Term[]>
+ */
+ private static function get_terms( array $order_ids, array $taxonomies ): array {
+ if ( ! $taxonomies ) {
+ return array();
+ }
+
+ $terms = wp_get_object_terms(
+ $order_ids,
+ $taxonomies,
+ array(
+ 'fields' => 'all_with_object_id',
+ 'update_term_meta_cache' => false,
+ )
+ );
+ if ( ! is_array( $terms ) ) {
+ return array();
+ }
+
+ $terms_by_order = array();
+ foreach ( $terms as $term ) {
+ // The all_with_object_id field adds object_id to each term.
+ $terms_by_order[ (int) $term->object_id ][] = $term; // @phpstan-ignore property.notFound
+ }
+ return $terms_by_order;
+ }
+
+ /**
+ * Write one order as a WXR item.
+ *
+ * @param WC_Order $order The order.
+ * @param \stdClass $stored The stored status, total, currency and billing email.
+ * @param \stdClass[] $meta_rows Raw HPOS metadata.
+ * @param \WP_Term[] $terms Terms assigned to this order.
+ * @param \stdClass[] $notes Comments on this order.
+ * @param array<int, \stdClass[]> $note_meta Raw metadata by comment ID.
+ */
+ private function export_order_to_xml( WC_Order $order, \stdClass $stored, array $meta_rows, array $terms, array $notes, array $note_meta ): void {
+ $order_id = $order->get_id();
+ $date_created = $order->get_date_created( 'edit' );
+ $date_updated = $order->get_date_modified( 'edit' ) ?? $date_created;
+ $link = add_query_arg(
+ array(
+ 'p' => $order_id,
+ 'post_type' => 'shop_order',
+ ),
+ home_url( '/' )
+ );
+ $title = 'Order #' . $order_id;
+
+ // phpcs:disable WooCommerce.Commenting.CommentHooks.MissingHookComment, WooCommerce.Commenting.CommentHooks.MissingSinceComment -- Export filters are documented in wp-admin/includes/export.php.
+ echo "<item>\n";
+ self::write_fields(
+ array(
+ 'title' => apply_filters( 'the_title_export', $title ),
+ 'link' => $link,
+ 'pubDate' => $date_created ? gmdate( 'D, d M Y H:i:s +0000', $date_created->getTimestamp() ) : '',
+ // The WordPress importer warns about every item that has no author.
+ 'dc:creator' => wp_get_current_user()->user_login,
+ 'guid' => $link,
+ 'description' => '',
+ 'content:encoded' => apply_filters( 'the_content_export', '' ),
+ 'excerpt:encoded' => apply_filters( 'the_excerpt_export', $order->get_customer_note( 'edit' ) ),
+ 'wp:post_id' => $order_id,
+ 'wp:post_date' => $date_created ? $date_created->date( 'Y-m-d H:i:s' ) : '',
+ 'wp:post_date_gmt' => $date_created ? gmdate( 'Y-m-d H:i:s', $date_created->getTimestamp() ) : '',
+ 'wp:post_modified' => $date_updated ? $date_updated->date( 'Y-m-d H:i:s' ) : '',
+ 'wp:post_modified_gmt' => $date_updated ? gmdate( 'Y-m-d H:i:s', $date_updated->getTimestamp() ) : '',
+ 'wp:comment_status' => 'closed',
+ 'wp:ping_status' => 'closed',
+ 'wp:post_name' => 'order-' . $order_id,
+ 'wp:status' => $stored->status,
+ 'wp:post_parent' => $order->get_parent_id( 'edit' ),
+ 'wp:menu_order' => 0,
+ 'wp:post_type' => 'shop_order',
+ 'wp:post_password' => $order->get_order_key( 'edit' ),
+ 'wp:is_sticky' => 0,
+ )
+ );
+ // phpcs:enable WooCommerce.Commenting.CommentHooks.MissingHookComment, WooCommerce.Commenting.CommentHooks.MissingSinceComment
+
+ foreach ( $terms as $term ) {
+ // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- escape_xml_text() escapes XML text.
+ printf( "<category domain=\"%s\" nicename=\"%s\">%s</category>\n", esc_attr( $term->taxonomy ), esc_attr( $term->slug ), self::escape_xml_text( $term->name ) );
+ }
+
+ $core_meta = self::get_core_meta( $order, $stored );
+ foreach ( $core_meta as $key => $value ) {
+ self::write_post_meta( $order_id, $key, (string) maybe_serialize( $value ) );
+ }
+
+ // Source-site customer and payment token IDs can refer to unrelated accounts on import.
+ $excluded_keys = array( '_customer_user', '_payment_tokens', '_edit_lock', '_edit_last', DataSynchronizer::DELETED_RECORD_META_KEY );
+ foreach ( $meta_rows as $meta ) {
+ $key = $meta->meta_key ?? null;
+ if ( is_string( $key ) && '' !== $key && ! array_key_exists( $key, $core_meta ) && ! in_array( $key, $excluded_keys, true ) ) {
+ self::write_post_meta( $order_id, $key, (string) $meta->meta_value );
+ }
+ }
+
+ foreach ( $notes as $note ) {
+ echo "<wp:comment>\n";
+ self::write_fields(
+ array(
+ 'wp:comment_id' => $note->comment_ID,
+ 'wp:comment_author' => $note->comment_author,
+ 'wp:comment_author_email' => $note->comment_author_email,
+ 'wp:comment_author_url' => sanitize_url( $note->comment_author_url ),
+ 'wp:comment_author_IP' => $note->comment_author_IP,
+ 'wp:comment_date' => $note->comment_date,
+ 'wp:comment_date_gmt' => $note->comment_date_gmt,
+ 'wp:comment_content' => $note->comment_content,
+ 'wp:comment_approved' => $note->comment_approved,
+ 'wp:comment_type' => $note->comment_type,
+ 'wp:comment_parent' => $note->comment_parent,
+ 'wp:comment_user_id' => $note->user_id,
+ )
+ );
+ foreach ( $note_meta[ (int) $note->comment_ID ] ?? array() as $meta ) {
+ /** This filter is documented in wp-admin/includes/export.php. */
+ if ( ! apply_filters( 'wxr_export_skip_commentmeta', false, $meta->meta_key, $meta ) ) { // phpcs:ignore WooCommerce.Commenting.CommentHooks.MissingSinceComment -- WordPress core filter.
+ self::write_meta( 'commentmeta', $meta->meta_key, $meta->meta_value );
+ }
+ }
+ echo "</wp:comment>\n";
+ }
+ echo "</item>\n";
+ }
+
+ /**
+ * Project HPOS order properties onto the keys used by legacy order posts.
+ *
+ * @param WC_Order $order The order.
+ * @param \stdClass $stored The stored total, currency and billing email.
+ * @return array
+ */
+ private static function get_core_meta( WC_Order $order, \stdClass $stored ): array {
+ $data = $order->get_base_data();
+ $stored_total = (string) ( $stored->total_amount ?? '' );
+ $stored_currency = (string) ( $stored->currency ?? '' );
+ $stored_email = (string) ( $stored->billing_email ?? '' );
+ $meta = array(
+ '_order_currency' => '' !== $stored_currency ? $stored_currency : $data['currency'],
+ '_order_version' => $data['version'],
+ // Loading an order rounds its total to the current price decimals, so keep the stored value when they differ.
+ '_order_total' => (float) $stored_total === (float) $data['total'] ? $data['total'] : wc_format_decimal( $stored_total, false, true ),
+ '_order_tax' => $data['cart_tax'],
+ '_order_shipping' => $data['shipping_total'],
+ '_order_shipping_tax' => $data['shipping_tax'],
+ '_cart_discount' => $data['discount_total'],
+ '_cart_discount_tax' => $data['discount_tax'],
+ '_date_paid' => $data['date_paid'] ? $data['date_paid']->getTimestamp() : '',
+ '_date_completed' => $data['date_completed'] ? $data['date_completed']->getTimestamp() : '',
+ '_new_order_email_sent' => $order->get_new_order_email_sent( 'edit' ) ? 'true' : 'false',
+ );
+
+ foreach ( array( 'order_key', 'payment_method', 'payment_method_title', 'transaction_id', 'customer_ip_address', 'customer_user_agent', 'created_via', 'cart_hash' ) as $field ) {
+ $meta[ '_' . $field ] = $data[ $field ];
+ }
+ foreach ( array( 'prices_include_tax', 'download_permissions_granted', 'recorded_sales', 'recorded_coupon_usage_counts', 'order_stock_reduced' ) as $field ) {
+ $meta[ '_' . $field ] = wc_bool_to_string( wc_string_to_bool( $data[ $field ] ) );
+ }
+ foreach ( array( 'billing', 'shipping' ) as $address_type ) {
+ foreach ( $data[ $address_type ] as $key => $value ) {
+ $meta[ '_' . $address_type . '_' . $key ] = $value;
+ }
+ }
+ if ( '' !== $stored_email ) {
+ $meta['_billing_email'] = $stored_email;
+ }
+
+ return $meta;
+ }
+
+ /**
+ * Apply the core post-meta export filter before writing a row.
+ *
+ * @param int $order_id The order ID.
+ * @param string $key The meta key.
+ * @param string $value The stored meta value.
+ */
+ private static function write_post_meta( int $order_id, string $key, string $value ): void {
+ $meta = (object) array(
+ 'meta_id' => 0,
+ 'post_id' => $order_id,
+ 'meta_key' => $key, // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_key -- Shape expected by the WordPress export filter.
+ 'meta_value' => $value, // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_value -- Shape expected by the WordPress export filter.
+ );
+
+ /** This filter is documented in wp-admin/includes/export.php. */
+ if ( ! apply_filters( 'wxr_export_skip_postmeta', false, $key, $meta ) ) { // phpcs:ignore WooCommerce.Commenting.CommentHooks.MissingSinceComment -- WordPress core filter.
+ self::write_meta( 'postmeta', $meta->meta_key, $meta->meta_value );
+ }
+ }
+
+ /**
+ * Write a post or comment meta element.
+ *
+ * @param string $element The element name.
+ * @param mixed $key The meta key.
+ * @param mixed $value The meta value.
+ */
+ private static function write_meta( string $element, $key, $value ): void {
+ echo '<wp:' . esc_attr( $element ) . ">\n";
+ self::write_fields(
+ array(
+ 'wp:meta_key' => $key,
+ 'wp:meta_value' => $value,
+ )
+ );
+ echo '</wp:' . esc_attr( $element ) . ">\n";
+ }
+
+ /**
+ * Write XML text elements, treating even CDATA delimiters in data as literal text.
+ *
+ * Carriage returns are written as character references, because XML parsers drop literal ones
+ * and that breaks the string lengths in serialized values.
+ *
+ * @param array $fields Element names and values.
+ */
+ private static function write_fields( array $fields ): void {
+ foreach ( $fields as $tag => $value ) {
+ // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- escape_xml_text() escapes XML text.
+ printf( "<%1\$s>%2\$s</%1\$s>\n", esc_attr( $tag ), self::escape_xml_text( is_scalar( $value ) ? (string) $value : '' ) );
+ }
+ }
+
+ /**
+ * Escape XML text, including CDATA delimiters and invalid code points.
+ *
+ * @param string $text The text.
+ * @return string
+ */
+ private static function escape_xml_text( string $text ): string {
+ return str_replace( "\r", ' ', htmlspecialchars( $text, ENT_XML1 | ENT_NOQUOTES | ENT_SUBSTITUTE | ENT_DISALLOWED, 'UTF-8' ) );
+ }
+
+ /**
+ * Remove the output buffers opened earlier in the request, as WC_Download_Handler does for downloads.
+ */
+ private static function clean_buffers(): void {
+ foreach ( array_reverse( ob_get_status( true ) ) as $buffer ) {
+ if ( $buffer['flags'] & PHP_OUTPUT_HANDLER_REMOVABLE ) {
+ ob_end_clean();
+ continue;
+ }
+
+ // The buffers below this one can't be reached.
+ if ( $buffer['flags'] & PHP_OUTPUT_HANDLER_CLEANABLE ) {
+ ob_clean();
+ }
+ return;
+ }
+ }
+}
diff --git a/plugins/woocommerce/tests/php/includes/admin/class-wc-admin-test.php b/plugins/woocommerce/tests/php/includes/admin/class-wc-admin-test.php
index d5d4141ee6a..de7e73ae38c 100644
--- a/plugins/woocommerce/tests/php/includes/admin/class-wc-admin-test.php
+++ b/plugins/woocommerce/tests/php/includes/admin/class-wc-admin-test.php
@@ -261,6 +261,33 @@ class WC_Admin_Test extends WC_Unit_Test_Case {
}
}
+ /**
+ * @testdox The Export screen registers the HPOS order export handler.
+ */
+ public function test_export_screen_registers_hpos_order_export_handler(): void {
+ remove_all_actions( 'export_wp' );
+ wc_get_container()->reset_all_resolved();
+
+ try {
+ set_current_screen( 'export' );
+
+ // Read the hook table directly: resolving the handler here would register the hook by itself.
+ global $wp_filter;
+ $callbacks = isset( $wp_filter['export_wp'] ) ? ( $wp_filter['export_wp']->callbacks[ PHP_INT_MAX ] ?? array() ) : array();
+ $handlers = array_filter(
+ $callbacks,
+ static function ( $callback ) {
+ return is_array( $callback['function'] )
+ && $callback['function'][0] instanceof \Automattic\WooCommerce\Internal\Admin\ImportExport\HposOrderExportHandler
+ && 'handle_export_wp' === $callback['function'][1];
+ }
+ );
+ $this->assertCount( 1, $handlers, 'The Export screen should hook the HPOS order export handler on export_wp.' );
+ } finally {
+ set_current_screen( 'front' );
+ }
+ }
+
/**
* Invokes prevent_admin_access() with a synthetic request and returns its redirect location.
*
diff --git a/plugins/woocommerce/tests/php/src/Internal/Admin/ImportExport/HposOrderExportHandlerTest.php b/plugins/woocommerce/tests/php/src/Internal/Admin/ImportExport/HposOrderExportHandlerTest.php
new file mode 100644
index 00000000000..85500c5500b
--- /dev/null
+++ b/plugins/woocommerce/tests/php/src/Internal/Admin/ImportExport/HposOrderExportHandlerTest.php
@@ -0,0 +1,315 @@
+<?php
+declare( strict_types = 1 );
+
+namespace Automattic\WooCommerce\Tests\Internal\Admin\ImportExport;
+
+use Automattic\WooCommerce\Enums\OrderStatus;
+use Automattic\WooCommerce\Internal\Admin\ImportExport\HposOrderExportHandler;
+use Automattic\WooCommerce\Internal\DataStores\Orders\OrdersTableDataStore;
+use Automattic\WooCommerce\RestApi\UnitTests\Helpers\OrderHelper;
+use Automattic\WooCommerce\RestApi\UnitTests\HPOSToggleTrait;
+use DOMDocument;
+use DOMXPath;
+use ReflectionClassConstant;
+use ReflectionMethod;
+use WC_Order;
+use WC_Unit_Test_Case;
+
+/**
+ * Tests for the HPOS order exporter.
+ */
+class HposOrderExportHandlerTest extends WC_Unit_Test_Case {
+ use HPOSToggleTrait;
+
+ /**
+ * The System Under Test.
+ *
+ * @var HposOrderExportHandler
+ */
+ private HposOrderExportHandler $sut;
+
+ /**
+ * Enable HPOS with compatibility mode off.
+ */
+ public function setUp(): void {
+ parent::setUp();
+ OrderHelper::create_order_custom_table_if_not_exist();
+ add_filter( 'wc_allow_changing_orders_storage_while_sync_is_pending', '__return_true' );
+ $this->toggle_cot_authoritative( true );
+ $this->disable_cot_sync();
+ $this->sut = wc_get_container()->get( HposOrderExportHandler::class );
+ }
+
+ /**
+ * Restore the order storage settings.
+ */
+ public function tearDown(): void {
+ $this->clean_up_cot_setup();
+ parent::tearDown();
+ }
+
+ /**
+ * @testdox Leaves the response to WordPress when the order post type disables export.
+ */
+ public function test_honors_order_post_type_export_opt_out(): void {
+ wp_set_current_user( self::factory()->user->create( array( 'role' => 'administrator' ) ) );
+ $this->assertTrue( current_user_can( 'export' ) );
+ set_current_screen( 'export' );
+ $post_type = get_post_type_object( 'shop_order' );
+ $can_export = $post_type->can_export;
+
+ add_filter(
+ 'export_wp_filename',
+ function () {
+ $this->fail( 'The HPOS handler started an export for a disabled post type.' );
+ }
+ );
+
+ try {
+ $post_type->can_export = false;
+ $this->expectOutputString( '' );
+ $this->sut->handle_export_wp( array( 'content' => 'shop_order' ) );
+ } finally {
+ $post_type->can_export = $can_export;
+ set_current_screen( 'front' );
+ }
+ }
+
+ /**
+ * @testdox Leaves the response to WordPress when compatibility mode is on.
+ */
+ public function test_leaves_export_to_wordpress_when_sync_is_enabled(): void {
+ wp_set_current_user( self::factory()->user->create( array( 'role' => 'administrator' ) ) );
+ set_current_screen( 'export' );
+ $this->enable_cot_sync();
+
+ add_filter(
+ 'export_wp_filename',
+ function () {
+ $this->fail( 'The HPOS handler started an export while compatibility mode was on.' );
+ }
+ );
+
+ try {
+ $this->expectOutputString( '' );
+ $this->sut->handle_export_wp( array( 'content' => 'shop_order' ) );
+ } finally {
+ set_current_screen( 'front' );
+ }
+ }
+
+ /**
+ * @testdox Exports the stored order total when the current price decimals would round it.
+ */
+ public function test_exports_stored_total_without_current_rounding(): void {
+ $order = $this->create_order();
+ global $wpdb;
+ $wpdb->update( OrdersTableDataStore::get_orders_table_name(), array( 'total_amount' => '12.505' ), array( 'id' => $order->get_id() ) );
+ update_option( 'woocommerce_price_num_decimals', 0 );
+ wp_cache_flush();
+
+ $xpath = $this->export();
+
+ $this->assertSame( '12.505', $xpath->evaluate( 'string(/rss/channel/item/wp:postmeta[wp:meta_key = "_order_total"]/wp:meta_value)' ), 'The export should keep the stored total, not the rounded one.' );
+ }
+
+ /**
+ * @testdox Exports each current order once across batches, even when legacy copies remain.
+ */
+ public function test_exports_only_current_orders_across_batches(): void {
+ $this->enable_cot_sync();
+ $mirrored = $this->create_order();
+ $deleted = $this->create_order();
+ $this->assertSame( 'shop_order', get_post_type( $mirrored->get_id() ) );
+
+ $this->disable_cot_sync();
+ $deleted_id = $deleted->get_id();
+ $deleted->delete( true );
+ $this->assertSame( 'shop_order', get_post_type( $deleted_id ) );
+
+ $expected_ids = array( (string) $mirrored->get_id() );
+ $batch_size = ( new ReflectionClassConstant( HposOrderExportHandler::class, 'BATCH_SIZE' ) )->getValue();
+ for ( $i = 0; $i <= $batch_size; ++$i ) {
+ $expected_ids[] = (string) $this->create_order()->get_id();
+ }
+ $legacy_status_id = (int) end( $expected_ids );
+ global $wpdb;
+ $wpdb->update( OrdersTableDataStore::get_orders_table_name(), array( 'status' => 'wc-legacy-status' ), array( 'id' => $legacy_status_id ) );
+ $this->create_order( OrderStatus::AUTO_DRAFT );
+
+ $xpath = $this->export();
+ $ids = array();
+ foreach ( $xpath->query( '/rss/channel/item/wp:post_id' ) as $node ) {
+ $ids[] = $node->textContent; // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- Native DOM property.
+ }
+ $this->assertSame( $expected_ids, $ids );
+ $this->assertSame( 'wc-legacy-status', $xpath->evaluate( 'string(/rss/channel/item[last()]/wp:status)' ) );
+ }
+
+ /**
+ * @testdox Preserves order fields, repeated metadata and raw note metadata in valid WXR.
+ */
+ public function test_exports_order_fields_and_metadata(): void {
+ update_option( 'timezone_string', 'America/New_York' );
+ wp_set_current_user( self::factory()->user->create( array( 'role' => 'administrator' ) ) );
+
+ $order = $this->create_order();
+ $order->set_date_created( 1705312800 );
+ $order->set_customer_id( 123 );
+ $order->set_order_key( 'wc_order_export_test' );
+ $order->set_billing_first_name( '山田 & Jane' );
+ $order->set_shipping_city( 'New York' );
+ $order->set_customer_note( 'Gift ]]> & card 🎁' );
+ $order->add_meta_data( 'label', 'A' );
+ $order->add_meta_data( 'label', 'B' );
+ $order->add_meta_data( '_export_skip', 'secret' );
+ $order->add_meta_data( 'gift_message', array( 'text' => "Line 1\r\nLine 2" ) );
+ $order->save();
+
+ global $wpdb;
+ $wpdb->insert(
+ OrdersTableDataStore::get_meta_table_name(),
+ array(
+ 'order_id' => $order->get_id(),
+ 'meta_key' => null, // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_key -- Insert one legacy fixture row.
+ 'meta_value' => 'Value without a key', // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_value -- Insert one legacy fixture row.
+ )
+ );
+ wp_cache_flush();
+
+ $note_id = $order->add_order_note( 'Packed ]]> & ready', 1 );
+ add_comment_meta( $note_id, '123', array( 'carrier' => 'A & B' ) );
+ add_comment_meta( $note_id, '_export_skip', 'secret' );
+
+ $skip = static function ( $skip, $key ) {
+ return $skip || '_export_skip' === $key;
+ };
+ add_filter( 'wxr_export_skip_postmeta', $skip, 10, 2 );
+ add_filter( 'wxr_export_skip_commentmeta', $skip, 10, 2 );
+ add_filter( 'woocommerce_order_get_total', 'floatval' );
+
+ $xpath = $this->export();
+ $this->assertSame( 1.0, $xpath->evaluate( 'count(/rss/channel/generator)' ), 'The rss2_head action should add the generator to the channel.' );
+ $item = $xpath->query( '/rss/channel/item' )->item( 0 );
+ $this->assertSame( 'wc-processing', $xpath->evaluate( 'string(wp:status)', $item ) );
+ $this->assertSame( '2024-01-15 05:00:00', $xpath->evaluate( 'string(wp:post_date)', $item ) );
+ $this->assertSame( '2024-01-15 10:00:00', $xpath->evaluate( 'string(wp:post_date_gmt)', $item ) );
+ $this->assertSame( 'Gift ]]> & card 🎁', $xpath->evaluate( 'string(excerpt:encoded)', $item ) );
+ $this->assertSame( '山田 & Jane', $xpath->evaluate( 'string(wp:postmeta[wp:meta_key = "_billing_first_name"]/wp:meta_value)', $item ) );
+ $this->assertSame( 'New York', $xpath->evaluate( 'string(wp:postmeta[wp:meta_key = "_shipping_city"]/wp:meta_value)', $item ) );
+ $this->assertSame( wp_get_current_user()->user_login, $xpath->evaluate( 'string(dc:creator)', $item ), 'An empty author makes the WordPress importer warn about every order.' );
+ $this->assertSame( 'wc_order_export_test', $xpath->evaluate( 'string(wp:post_password)', $item ) );
+ $this->assertStringContainsString( 'New York', $xpath->evaluate( 'string(wp:postmeta[wp:meta_key = "_shipping_address_index"]/wp:meta_value)', $item ), 'Order search on the importing site reads the address index.' );
+ $this->assertSame( '12.50', $xpath->evaluate( 'string(wp:postmeta[wp:meta_key = "_order_total"]/wp:meta_value)', $item ) );
+ $this->assertSame( 2.0, $xpath->evaluate( 'count(wp:postmeta[wp:meta_key = "label"])', $item ) );
+ $this->assertSame( 0.0, $xpath->evaluate( 'count(wp:postmeta[wp:meta_key = "_customer_user"] | .//wp:meta_key[. = "_export_skip"])', $item ) );
+ $this->assertSame( 0.0, $xpath->evaluate( 'count(wp:postmeta[wp:meta_value = "Value without a key"])', $item ) );
+ $this->assertSame( array( 'text' => "Line 1\r\nLine 2" ), maybe_unserialize( $xpath->evaluate( 'string(wp:postmeta[wp:meta_key = "gift_message"]/wp:meta_value)', $item ) ), 'A lost carriage return breaks the serialized string length.' );
+
+ $note = $xpath->query( 'wp:comment[wp:commentmeta/wp:meta_key = "123"]', $item )->item( 0 );
+ $this->assertNotNull( $note );
+ $this->assertSame( 'Packed ]]> & ready', $xpath->evaluate( 'string(wp:comment_content)', $note ) );
+ $this->assertSame( '1', $xpath->evaluate( 'string(wp:commentmeta[wp:meta_key = "is_customer_note"]/wp:meta_value)', $note ) );
+ $this->assertSame( array( 'carrier' => 'A & B' ), maybe_unserialize( $xpath->evaluate( 'string(wp:commentmeta[wp:meta_key = "123"]/wp:meta_value)', $note ) ) );
+ }
+
+ /**
+ * @testdox Exports the stored currency and billing email when loading the order rejects them.
+ */
+ public function test_exports_stored_values_rejected_on_load(): void {
+ $order = $this->create_order();
+ $order->set_billing_email( 'customer@example.com' );
+ $order->save();
+
+ global $wpdb;
+ $wpdb->update(
+ OrdersTableDataStore::get_orders_table_name(),
+ array(
+ 'currency' => 'XYZ',
+ 'billing_email' => 'not-an-email',
+ ),
+ array( 'id' => $order->get_id() )
+ );
+ $wpdb->update(
+ OrdersTableDataStore::get_addresses_table_name(),
+ array( 'email' => 'not-an-email' ),
+ array(
+ 'order_id' => $order->get_id(),
+ 'address_type' => 'billing',
+ )
+ );
+ wp_cache_flush();
+
+ $loaded = wc_get_order( $order->get_id() );
+ $this->assertSame( '', $loaded->get_currency( 'edit' ), 'Loading the order should drop the unknown currency.' );
+ $this->assertSame( '', $loaded->get_billing_email( 'edit' ), 'Loading the order should drop the invalid billing email.' );
+
+ $xpath = $this->export();
+
+ $this->assertSame( 'XYZ', $xpath->evaluate( 'string(/rss/channel/item/wp:postmeta[wp:meta_key = "_order_currency"]/wp:meta_value)' ) );
+ $this->assertSame( 'not-an-email', $xpath->evaluate( 'string(/rss/channel/item/wp:postmeta[wp:meta_key = "_billing_email"]/wp:meta_value)' ) );
+ }
+
+ /**
+ * @testdox Exports the terms assigned to orders as WXR categories.
+ */
+ public function test_exports_order_terms(): void {
+ register_taxonomy( 'order_export_tag', 'shop_order' );
+
+ try {
+ $order = $this->create_order();
+ $term = wp_insert_term( 'VIP & Co', 'order_export_tag', array( 'slug' => 'vip' ) );
+ wp_set_object_terms( $order->get_id(), array( $term['term_id'] ), 'order_export_tag' );
+
+ $xpath = $this->export();
+
+ $category = '/rss/channel/item/category[@domain = "order_export_tag"]';
+ $this->assertSame( 1.0, $xpath->evaluate( "count($category)" ) );
+ $this->assertSame( 'vip', $xpath->evaluate( "string($category/@nicename)" ) );
+ $this->assertSame( get_term( $term['term_id'] )->name, $xpath->evaluate( "string($category)" ), 'The export should keep the stored term name, as the WordPress exporter does.' );
+ } finally {
+ unregister_taxonomy( 'order_export_tag' );
+ }
+ }
+
+ /**
+ * Create a fixture order.
+ *
+ * @param string $status The order status.
+ * @return WC_Order
+ */
+ private function create_order( string $status = OrderStatus::PROCESSING ): WC_Order {
+ $order = new WC_Order();
+ $order->set_status( $status );
+ $order->set_total( '12.50' );
+ $order->save();
+ return $order;
+ }
+
+ /**
+ * Parse the stream without sending HTTP headers or ending the test process.
+ *
+ * @return DOMXPath
+ */
+ private function export(): DOMXPath {
+ $stream = new ReflectionMethod( $this->sut, 'stream_export' );
+ if ( PHP_VERSION_ID < 80100 ) {
+ $stream->setAccessible( true );
+ }
+
+ ob_start();
+ try {
+ $stream->invoke( $this->sut );
+ } finally {
+ $xml = (string) ob_get_clean();
+ }
+
+ $document = new DOMDocument();
+ $this->assertTrue( $document->loadXML( $xml ) );
+ $xpath = new DOMXPath( $document );
+ $xpath->registerNamespace( 'wp', 'http://wordpress.org/export/1.2/' );
+ $xpath->registerNamespace( 'excerpt', 'http://wordpress.org/export/1.2/excerpt/' );
+ $xpath->registerNamespace( 'dc', 'http://purl.org/dc/elements/1.1/' );
+ return $xpath;
+ }
+}