如何在WooCommerce订单列表（HPOS）实现订单项元数据列排序

问题背景 #

已在WooCommerce后台订单列表中添加了基于订单项元字段wcrp_rental_products_rent_from的自定义列my-column2，并注册了该列的可排序属性，但无法实现实际排序功能。

现有代码如下：

自定义列内容渲染代码 #

function display_wc_order_list_custom_column_content( $column, $order ){
    switch ( $column ) {
        case 'my-column2' :
            if ( ! empty($order) ) {
                foreach ( $order->get_items() as $item_id => $item ) {
                    if (! empty($item->get_meta('wcrp_rental_products_rent_from'))) {
                        $fulfilment_date = date_i18n( 'd. M Y', strtotime( $item->get_meta('wcrp_rental_products_rent_from') ) );
                        echo $fulfilment_date;
                    }
                }
            } else {
                echo '<small>(<em>no value</em>)</small>';
            }
            break;
    }
}
add_action( 'manage_woocommerce_page_wc-orders_columns', 'display_wc_order_list_custom_column_content' );

可排序列注册代码 #

add_filter( 'manage_woocommerce_page_wc-orders_sortable_columns', 'rudr_sortable_column' );
function rudr_sortable_column( $columns ) {
    $columns['my-column2'] = 'eventdate';
    return $columns;
}

解决方案：实现订单项元字段排序逻辑 #

由于订单项元字段存储在wp_woocommerce_order_itemmeta表（而非订单的post meta表），需要通过关联数据库表来实现排序。添加以下代码即可完成排序功能：

add_action( 'pre_get_posts', 'sort_orders_by_rental_item_meta' );
function sort_orders_by_rental_item_meta( $query ) {
    global $pagenow, $wpdb;

    // 仅针对后台订单列表的查询生效
    if ( is_admin() && 'edit.php' === $pagenow && 'shop_order' === $query->get( 'post_type' ) && 'eventdate' === $query->get( 'orderby' ) ) {
        
        // 关联订单项表和订单项元表
        $query->query_vars['join'] .= "
            LEFT JOIN {$wpdb->prefix}woocommerce_order_items oi ON {$wpdb->posts}.ID = oi.order_id
            LEFT JOIN {$wpdb->prefix}woocommerce_order_itemmeta oim ON oi.order_item_id = oim.order_item_id
        ";
        
        // 筛选出目标元字段
        $query->query_vars['where'] .= " AND oim.meta_key = 'wcrp_rental_products_rent_from' ";
        
        // 按订单项元值排序：此处取每个订单的最早租赁日期，可改为MAX()取最晚日期
        $order_dir = $query->get( 'order' ) ?: 'ASC';
        $query->query_vars['orderby'] = "MIN(oim.meta_value) {$order_dir}";
        
        // 按订单ID分组，避免同一订单被多次查询
        $query->query_vars['groupby'] = "{$wpdb->posts}.ID";
    }
}

代码说明 #

1. 关联数据库表：通过LEFT JOIN关联订单表与订单项表、订单项元表，获取订单项的元字段数据。
2. 筛选目标字段：指定只针对wcrp_rental_products_rent_from这个元字段进行排序。
3. 排序规则：使用MIN(oim.meta_value)取每个订单中最早的租赁日期作为排序依据，若需要按最晚日期排序，可替换为MAX(oim.meta_value)。
4. 分组去重：通过GROUP BY确保每个订单只显示一次，避免因多个订单项导致的重复结果。

内容的提问来源于stack exchange，提问作者Danny