关于php:如何获取WooCommerce订单详细信息

How to get WooCommerce order details

在WooCommerce中,从以下代码行:

1
$order = new WC_Order( $order_id );

如何从订单ID获取WooCommerce订单详细信息?


3.0版以上的WOOCOMMERCE订单

自Woocommerce大型重大更新3.0+以来,事情已经发生了很多变化:

  • 对于WC_Order对象,无法像以前一样直接访问属性,并且会引发一些错误。
  • 现在,在WC_Order对象实例上需要新的WC_OrderWC_Abstract_Order getter和setter方法。
  • 此外,还有一些用于订购商品的新类:

    • WC_Order_Item类,
    • WC_Order_Item_Product类,
    • WC_Order_Item_Tax类,
    • WC_Order_Item_Shipping类,
    • WC_Order_Item_Coupon类,
    • WC_Order_Item_Fee类。
  • 此外,WC_Data抽象类允许使用get_data()get_meta_data()get_meta()方法访问"订单"和"订单商品"数据。

Related:
? How to get Customer details from Order in WooCommerce?
? Get Order items and WC_Order_Item_Product in WooCommerce 3

因此,在foreach循环中将无法像以前那样访问Order items属性,而必须使用这些特定的getter和setter方法。

使用某些WC_OrderWC_Abstract_Order方法(示例):

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// Get an instance of the WC_Order object (same as before)
$order = wc_get_order( $order_id );

$order_id  = $order->get_id(); // Get the order ID
$parent_id = $order->get_parent_id(); // Get the parent order ID (for subscriptions…)

$user_id   = $order->get_user_id(); // Get the costumer ID
$user      = $order->get_user(); // Get the WP_User object

$order_status  = $order->get_status(); // Get the order status (see the conditional method has_status() below)
$currency      = $order->get_currency(); // Get the currency used  
$payment_method = $order->get_payment_method(); // Get the payment method ID
$payment_title = $order->get_payment_method_title(); // Get the payment method title
$date_created  = $order->get_date_created(); // Get date created (WC_DateTime object)
$date_modified = $order->get_date_modified(); // Get date modified (WC_DateTime object)

$billing_country = $order->get_billing_country(); // Customer billing country

// ... and so on ...

For order status as a conditional method (where"the_targeted_status" need to be defined and replaced by an order status to target a specific order status):

1
2
3
if ( $order->has_status('completed') ) {
    // Do something
}

获取并访问订单数据属性(在值数组中):

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
// Get an instance of the WC_Order object
$order = wc_get_order( $order_id );

$order_data = $order->get_data(); // The Order data

$order_id = $order_data['id'];
$order_parent_id = $order_data['parent_id'];
$order_status = $order_data['status'];
$order_currency = $order_data['currency'];
$order_version = $order_data['version'];
$order_payment_method = $order_data['payment_method'];
$order_payment_method_title = $order_data['payment_method_title'];
$order_payment_method = $order_data['payment_method'];
$order_payment_method = $order_data['payment_method'];

## Creation and modified WC_DateTime Object date string ##

// Using a formated date ( with php date() function as method)
$order_date_created = $order_data['date_created']->date('Y-m-d H:i:s');
$order_date_modified = $order_data['date_modified']->date('Y-m-d H:i:s');

// Using a timestamp ( with php getTimestamp() function as method)
$order_timestamp_created = $order_data['date_created']->getTimestamp();
$order_timestamp_modified = $order_data['date_modified']->getTimestamp();

$order_discount_total = $order_data['discount_total'];
$order_discount_tax = $order_data['discount_tax'];
$order_shipping_total = $order_data['shipping_total'];
$order_shipping_tax = $order_data['shipping_tax'];
$order_total = $order_data['total'];
$order_total_tax = $order_data['total_tax'];
$order_customer_id = $order_data['customer_id']; // ... and so on

## BILLING INFORMATION:

$order_billing_first_name = $order_data['billing']['first_name'];
$order_billing_last_name = $order_data['billing']['last_name'];
$order_billing_company = $order_data['billing']['company'];
$order_billing_address_1 = $order_data['billing']['address_1'];
$order_billing_address_2 = $order_data['billing']['address_2'];
$order_billing_city = $order_data['billing']['city'];
$order_billing_state = $order_data['billing']['state'];
$order_billing_postcode = $order_data['billing']['postcode'];
$order_billing_country = $order_data['billing']['country'];
$order_billing_email = $order_data['billing']['email'];
$order_billing_phone = $order_data['billing']['phone'];

## SHIPPING INFORMATION:

$order_shipping_first_name = $order_data['shipping']['first_name'];
$order_shipping_last_name = $order_data['shipping']['last_name'];
$order_shipping_company = $order_data['shipping']['company'];
$order_shipping_address_1 = $order_data['shipping']['address_1'];
$order_shipping_address_2 = $order_data['shipping']['address_2'];
$order_shipping_city = $order_data['shipping']['city'];
$order_shipping_state = $order_data['shipping']['state'];
$order_shipping_postcode = $order_data['shipping']['postcode'];
$order_shipping_country = $order_data['shipping']['country'];

获取订单项并使用WC_Order_Item_ProductWC_Order_Item方法访问数据:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
// Get an instance of the WC_Order object
$order = wc_get_order($order_id);

// Iterating through each WC_Order_Item_Product objects
foreach ($order->get_items() as $item_key => $item ):

    ## Using WC_Order_Item methods ##

    // Item ID is directly accessible from the $item_key in the foreach loop or
    $item_id = $item->get_id();

    ## Using WC_Order_Item_Product methods ##

    $product      = $item->get_product(); // Get the WC_Product object

    $product_id   = $item->get_product_id(); // the Product id
    $variation_id = $item->get_variation_id(); // the Variation id

    $item_type    = $item->get_type(); // Type of the order item ("line_item")

    $item_name    = $item->get_name(); // Name of the product
    $quantity     = $item->get_quantity();  
    $tax_class    = $item->get_tax_class();
    $line_subtotal     = $item->get_subtotal(); // Line subtotal (non discounted)
    $line_subtotal_tax = $item->get_subtotal_tax(); // Line subtotal tax (non discounted)
    $line_total        = $item->get_total(); // Line total (discounted)
    $line_total_tax    = $item->get_total_tax(); // Line total tax (discounted)

    ## Access Order Items data properties (in an array of values) ##
   $item_data    = $item->get_data();

    $product_name = $item_data['name'];
    $product_id   = $item_data['product_id'];
    $variation_id = $item_data['variation_id'];
    $quantity     = $item_data['quantity'];
    $tax_class    = $item_data['tax_class'];
    $line_subtotal     = $item_data['subtotal'];
    $line_subtotal_tax = $item_data['subtotal_tax'];
    $line_total        = $item_data['total'];
    $line_total_tax    = $item_data['total_tax'];

    // Get data from The WC_product object using methods (examples)
    $product        = $item->get_product(); // Get the WC_Product object

    $product_type   = $product->get_type();
    $product_sku    = $product->get_sku();
    $product_price  = $product->get_price();
    $stock_quantity = $product->get_stock_quantity();

endforeach;

So using get_data() method allow us to access to the protected data (associative array mode) …


ONLY FOR WOOCOMMERCE VERSIONS 2.5.x AND 2.6.x

For WOOCOMMERCE VERSION 3.0+ see THIS UPDATE

这是我做的一个自定义函数,目的是使您清楚了解与获取订单ID数据相关的信息。您将看到可以获得的所有不同RAW输出以及如何获取所需的数据…

使用print_r()函数(或也var_dump()函数)允许输出对象或数组的原始数据。

So first I output this data to show the object or the array hierarchy. Then I use different syntax depending on the type of that variable (string, array or object) to output the specific data needed.

IMPORTANT: With $order object you can use most of WC_order or WC_Abstract_Order methods (using the object syntax)…


这是代码:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
function get_order_details($order_id){

    // 1) Get the Order object
    $order = wc_get_order( $order_id );

    // OUTPUT
    echo 'RAW OUTPUT OF THE ORDER OBJECT: ';
    print_r($order);
    echo '';
    echo 'THE ORDER OBJECT (Using the object syntax notation):';
    echo '$order->order_type: ' . $order->order_type . '';
    echo '$order->id: ' . $order->id . '';
    echo '<h4>THE POST OBJECT:</h4>';
    echo '$order->post->ID: ' . $order->post->ID . '';
    echo '$order->post->post_author: ' . $order->post->post_author . '';
    echo '$order->post->post_date: ' . $order->post->post_date . '';
    echo '$order->post->post_date_gmt: ' . $order->post->post_date_gmt . '';
    echo '$order->post->post_content: ' . $order->post->post_content . '';
    echo '$order->post->post_title: ' . $order->post->post_title . '';
    echo '$order->post->post_excerpt: ' . $order->post->post_excerpt . '';
    echo '$order->post->post_status: ' . $order->post->post_status . '';
    echo '$order->post->comment_status: ' . $order->post->comment_status . '';
    echo '$order->post->ping_status: ' . $order->post->ping_status . '';
    echo '$order->post->post_password: ' . $order->post->post_password . '';
    echo '$order->post->post_name: ' . $order->post->post_name . '';
    echo '$order->post->to_ping: ' . $order->post->to_ping . '';
    echo '$order->post->pinged: ' . $order->post->pinged . '';
    echo '$order->post->post_modified: ' . $order->post->post_modified . '';
    echo '$order->post->post_modified_gtm: ' . $order->post->post_modified_gtm . '';
    echo '$order->post->post_content_filtered: ' . $order->post->post_content_filtered . '';
    echo '$order->post->post_parent: ' . $order->post->post_parent . '';
    echo '$order->post->guid: ' . $order->post->guid . '';
    echo '$order->post->menu_order: ' . $order->post->menu_order . '';
    echo '$order->post->post_type: ' . $order->post->post_type . '';
    echo '$order->post->post_mime_type: ' . $order->post->post_mime_type . '';
    echo '$order->post->comment_count: ' . $order->post->comment_count . '';
    echo '$order->post->filter: ' . $order->post->filter . '';
    echo '<h4>THE ORDER OBJECT (again):</h4>';
    echo '$order->order_date: ' . $order->order_date . '';
    echo '$order->modified_date: ' . $order->modified_date . '';
    echo '$order->customer_message: ' . $order->customer_message . '';
    echo '$order->customer_note: ' . $order->customer_note . '';
    echo '$order->post_status: ' . $order->post_status . '';
    echo '$order->prices_include_tax: ' . $order->prices_include_tax . '';
    echo '$order->tax_display_cart: ' . $order->tax_display_cart . '';
    echo '$order->display_totals_ex_tax: ' . $order->display_totals_ex_tax . '';
    echo '$order->display_cart_ex_tax: ' . $order->display_cart_ex_tax . '';
    echo '$order->formatted_billing_address->protected: ' . $order->formatted_billing_address->protected . '';
    echo '$order->formatted_shipping_address->protected: ' . $order->formatted_shipping_address->protected . '';
    echo '- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ';

    // 2) Get the Order meta data
    $order_meta = get_post_meta($order_id);

    echo 'RAW OUTPUT OF THE ORDER META DATA (ARRAY): ';
    print_r($order_meta);
    echo '';
    echo 'THE ORDER META DATA (Using the array syntax notation):';
    echo '$order_meta[_order_key][0]: ' . $order_meta[_order_key][0] . '';
    echo '$order_meta[_order_currency][0]: ' . $order_meta[_order_currency][0] . '';
    echo '$order_meta[_prices_include_tax][0]: ' . $order_meta[_prices_include_tax][0] . '';
    echo '$order_meta[_customer_user][0]: ' . $order_meta[_customer_user][0] . '';
    echo '$order_meta[_billing_first_name][0]: ' . $order_meta[_billing_first_name][0] . '';
    echo 'And so on ……… ';
    echo '- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ';

    // 3) Get the order items
    $items = $order->get_items();

    echo 'RAW OUTPUT OF THE ORDER ITEMS DATA (ARRAY): ';

    foreach ( $items as $item_id => $item_data ) {

        echo '<h4>RAW OUTPUT OF THE ORDER ITEM NUMBER: '. $item_id .'): </h4>';
        print_r($item_data);
        echo '';
        echo 'Item ID: ' . $item_id. '';
        echo '$item_data["product_id"] (product ID): ' . $item_data['product_id'] . '';
        echo '$item_data["name"] (product Name): ' . $item_data['name'] . '';

        // Using get_item_meta() method
        echo 'Item quantity (product quantity): ' . $order->get_item_meta($item_id, '_qty', true) . '';
        echo 'Item line total (product quantity): ' . $order->get_item_meta($item_id, '_line_total', true) . '';
        echo 'And so on ……… ';
        echo '- - - - - - - - - - - - - ';
    }
    echo '- - - - - - E N D - - - - - ';
}

代码在您的活动子主题(或主题)的function.php文件中,或者在任何插件文件中。

用法(例如,如果您的订单ID为159):

1
get_order_details(159);

此代码已经过测试并且可以工作。

Updated code on November 21, 2016


访问直接属性及其相关的解释

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
// Get an instance of the WC_Order object
            $order = wc_get_order($order_id);
            $order_data = array(
                    'order_id' => $order->get_id(),
                    'order_number' => $order->get_order_number(),
                    'order_date' => date('Y-m-d H:i:s', strtotime(get_post($order->get_id())->post_date)),
                    'status' => $order->get_status(),
                    'shipping_total' => $order->get_total_shipping(),
                    'shipping_tax_total' => wc_format_decimal($order->get_shipping_tax(), 2),
                    'fee_total' => wc_format_decimal($fee_total, 2),
                    'fee_tax_total' => wc_format_decimal($fee_tax_total, 2),
                    'tax_total' => wc_format_decimal($order->get_total_tax(), 2),
                    'cart_discount' => (defined('WC_VERSION') && (WC_VERSION >= 2.3)) ? wc_format_decimal($order->get_total_discount(), 2) : wc_format_decimal($order->get_cart_discount(), 2),
                    'order_discount' => (defined('WC_VERSION') && (WC_VERSION >= 2.3)) ? wc_format_decimal($order->get_total_discount(), 2) : wc_format_decimal($order->get_order_discount(), 2),
                    'discount_total' => wc_format_decimal($order->get_total_discount(), 2),
                    'order_total' => wc_format_decimal($order->get_total(), 2),
                    'order_currency' => $order->get_currency(),
                    'payment_method' => $order->get_payment_method(),
                    'shipping_method' => $order->get_shipping_method(),
                    'customer_id' => $order->get_user_id(),
                    'customer_user' => $order->get_user_id(),
                    'customer_email' => ($a = get_userdata($order->get_user_id() )) ? $a->user_email : '',
                    'billing_first_name' => $order->get_billing_first_name(),
                    'billing_last_name' => $order->get_billing_last_name(),
                    'billing_company' => $order->get_billing_company(),
                    'billing_email' => $order->get_billing_email(),
                    'billing_phone' => $order->get_billing_phone(),
                    'billing_address_1' => $order->get_billing_address_1(),
                    'billing_address_2' => $order->get_billing_address_2(),
                    'billing_postcode' => $order->get_billing_postcode(),
                    'billing_city' => $order->get_billing_city(),
                    'billing_state' => $order->get_billing_state(),
                    'billing_country' => $order->get_billing_country(),
                    'shipping_first_name' => $order->get_shipping_first_name(),
                    'shipping_last_name' => $order->get_shipping_last_name(),
                    'shipping_company' => $order->get_shipping_company(),
                    'shipping_address_1' => $order->get_shipping_address_1(),
                    'shipping_address_2' => $order->get_shipping_address_2(),
                    'shipping_postcode' => $order->get_shipping_postcode(),
                    'shipping_city' => $order->get_shipping_city(),
                    'shipping_state' => $order->get_shipping_state(),
                    'shipping_country' => $order->get_shipping_country(),
                    'customer_note' => $order->get_customer_note(),
                    'download_permissions' => $order->is_download_permitted() ? $order->is_download_permitted() : 0,
            );

额外细节

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
  $line_items_shipping = $order->get_items('shipping');
            foreach ($line_items_shipping as $item_id => $item) {
                if (is_object($item)) {
                    if ($meta_data = $item->get_formatted_meta_data('')) :
                        foreach ($meta_data as $meta_id => $meta) :
                            if (in_array($meta->key, $line_items_shipping)) {
                                continue;
                            }
                            // html entity decode is not working preoperly
                            $shipping_items[] = implode('|', array('item:' . wp_kses_post($meta->display_key), 'value:' . str_replace('', 'X', strip_tags($meta->display_value))));
                        endforeach;
                    endif;
                }
            }

            //get fee and total
            $fee_total = 0;
            $fee_tax_total = 0;

            foreach ($order->get_fees() as $fee_id => $fee) {

                $fee_items[] = implode('|', array(
                        'name:' .  html_entity_decode($fee['name'], ENT_NOQUOTES, 'UTF-8'),
                        'total:' . wc_format_decimal($fee['line_total'], 2),
                        'tax:' . wc_format_decimal($fee['line_tax'], 2),
                ));

                $fee_total += $fee['line_total'];
                $fee_tax_total += $fee['line_tax'];
            }

            // get tax items
            foreach ($order->get_tax_totals() as $tax_code => $tax) {            
                $tax_items[] = implode('|', array(
                    'rate_id:'.$tax->id,
                    'code:' . $tax_code,
                    'total:' . wc_format_decimal($tax->amount, 2),
                    'label:'.$tax->label,                
                    'tax_rate_compound:'.$tax->is_compound,
                ));
            }

            // add coupons
            foreach ($order->get_items('coupon') as $_ => $coupon_item) {

                $coupon = new WC_Coupon($coupon_item['name']);

                $coupon_post = get_post((WC()->version < '2.7.0') ? $coupon->id : $coupon->get_id());
                $discount_amount = !empty($coupon_item['discount_amount']) ? $coupon_item['discount_amount'] : 0;
                $coupon_items[] = implode('|', array(
                        'code:' . $coupon_item['name'],
                        'description:' . ( is_object($coupon_post) ? $coupon_post->post_excerpt : '' ),
                        'amount:' . wc_format_decimal($discount_amount, 2),
                ));
            }

            foreach ($order->get_refunds() as $refunded_items){
                $refund_items[] = implode('|', array(
                    'amount:' . $refunded_items->get_amount(),
            'reason:' . $refunded_items->get_reason(),
                    'date:'. date('Y-m-d H-i-s',strtotime((WC()->version < '2.7.0') ? $refunded_items->date_created : $refunded_items->get_date_created())),
                ));
            }

1
$order = new WC_Order(get_query_var('order-received'));