WooCommerce : obtenez les informations sur la commande (total, articles, etc.) à partir de l'objet $order

Publié: 2018-05-16

En tant que freelance en développement WooCommerce, je répète chaque jour de nombreuses opérations de codage qui me font perdre du temps. L'un d'eux est : « Comment obtenir ____ si j'ai la variable/objet $order ? “.

Par exemple, « Comment puis-je obtenir le total de la commande » ? Ou "Comment puis-je obtenir les articles de la commande " ? Ou peut-être l'ID de commande, l'ID client, les informations de facturation , le mode de paiement, les remboursements totaux, etc. ... j'espère que cet article vous aidera également à gagner du temps !

Comme nous l'avons vu dans d'autres articles, obtenir des informations sur le produit à partir de l'objet $product et obtenir des informations sur le panier à partir de l'objet $cart, vous ne pouvez pas toujours avoir un accès direct à la variable $order.

Parfois, vous pouvez avoir le $order_id disponible par exemple. Dans ce scénario, vous pouvez "obtenir" l'objet de commande avec la fonction wc_get_order WooCommerce.

Il est également possible d'obtenir des informations sur la commande $ si vous êtes dans un modèle d'e-mail. Cela peut être utile pour afficher des informations supplémentaires sur $order dans vos communications transactionnelles ou déclencher des fonctions personnalisées. Quoi qu'il en soit, profitez-en!

1. Vous avez accès à la variable $order

Les crochets (do_action et apply_filters) utilisent des arguments supplémentaires qui sont transmis à la fonction. S'ils vous permettent d'utiliser l'objet « $ commande », vous êtes en affaires. Voici comment obtenir toutes les informations sur la commande :

// Get Order ID and Key
$order->get_id();
$order->get_order_key();

// Get Order Totals $0.00
$order->get_formatted_order_total();
$order->get_cart_tax();
$order->get_currency();
$order->get_discount_tax();
$order->get_discount_to_display();
$order->get_discount_total();
$order->get_fees();
$order->get_formatted_line_subtotal();
$order->get_shipping_tax();
$order->get_shipping_total();
$order->get_subtotal();
$order->get_subtotal_to_display();
$order->get_tax_location();
$order->get_tax_totals();
$order->get_taxes();
$order->get_total();
$order->get_total_discount();
$order->get_total_tax();
$order->get_total_refunded();
$order->get_total_tax_refunded();
$order->get_total_shipping_refunded();
$order->get_item_count_refunded();
$order->get_total_qty_refunded();
$order->get_qty_refunded_for_item();
$order->get_total_refunded_for_item();
$order->get_tax_refunded_for_item();
$order->get_total_tax_refunded_by_rate_id();
$order->get_remaining_refund_amount();
 
// Get and Loop Over Order Items
foreach ( $order->get_items() as $item_id => $item ) {
   $product_id = $item->get_product_id();
   $variation_id = $item->get_variation_id();
   $product = $item->get_product(); // see link above to get $product info
   $product_name = $item->get_name();
   $quantity = $item->get_quantity();
   $subtotal = $item->get_subtotal();
   $total = $item->get_total();
   $tax = $item->get_subtotal_tax();
   $tax_class = $item->get_tax_class();
   $tax_status = $item->get_tax_status();
   $allmeta = $item->get_meta_data();
   $somemeta = $item->get_meta( '_whatever', true );
   $item_type = $item->get_type(); // e.g. "line_item"
}

// Other Secondary Items Stuff
$order->get_items_key();
$order->get_items_tax_classes();
$order->get_item_count();
$order->get_item_total();
$order->get_downloadable_items();
$order->get_coupon_codes();
 
// Get Order Lines
$order->get_line_subtotal();
$order->get_line_tax();
$order->get_line_total();
 
// Get Order Shipping
$order->get_shipping_method();
$order->get_shipping_methods();
$order->get_shipping_to_display();
 
// Get Order Dates
$order->get_date_created();
$order->get_date_modified();
$order->get_date_completed();
$order->get_date_paid();
 
// Get Order User, Billing & Shipping Addresses
$order->get_customer_id();
$order->get_user_id();
$order->get_user();
$order->get_customer_ip_address();
$order->get_customer_user_agent();
$order->get_created_via();
$order->get_customer_note();
$order->get_address_prop();
$order->get_billing_first_name();
$order->get_billing_last_name();
$order->get_billing_company();
$order->get_billing_address_1();
$order->get_billing_address_2();
$order->get_billing_city();
$order->get_billing_state();
$order->get_billing_postcode();
$order->get_billing_country();
$order->get_billing_email();
$order->get_billing_phone();
$order->get_shipping_first_name();
$order->get_shipping_last_name();
$order->get_shipping_company();
$order->get_shipping_address_1();
$order->get_shipping_address_2();
$order->get_shipping_city();
$order->get_shipping_state();
$order->get_shipping_postcode();
$order->get_shipping_country();
$order->get_address();
$order->get_shipping_address_map_url();
$order->get_formatted_billing_full_name();
$order->get_formatted_shipping_full_name();
$order->get_formatted_billing_address();
$order->get_formatted_shipping_address();
 
// Get Order Payment Details
$order->get_payment_method();
$order->get_payment_method_title();
$order->get_transaction_id();
 
// Get Order URLs
$order->get_checkout_payment_url();
$order->get_checkout_order_received_url();
$order->get_cancel_order_url();
$order->get_cancel_order_url_raw();
$order->get_cancel_endpoint();
$order->get_view_order_url();
$order->get_edit_order_url();
 
// Get Order Status
$order->get_status();

// Get Thank You Page URL
$order->get_checkout_order_received_url();

2. Vous avez accès à la variable $order_id

Si vous avez accès à l'ID de la commande (encore une fois, généralement, do_action ou apply_filters peuvent vous le donner), vous devez d'abord obtenir l'objet de la commande. Ensuite, faites exactement les mêmes choses que ci-dessus.

// Get $order object from order ID
 
$order = wc_get_order( $order_id );
 
// Now you have access to (see above)...
 
if ( $order ) {
   $order->get_formatted_order_total( );
   // etc.
   // etc.
}

3. Vous avez accès à la variable $email

Si vous travaillez avec des e-mails WooCommerce, vous aurez souvent l'objet $email disponible en tant que paramètre. Afin d'obtenir l'objet à partir de cela, vous avez besoin d'une étape supplémentaire. Ensuite, faites exactement les mêmes choses que ci-dessus.

// Get $order object from $email
 
$order = $email->object;
 
// Now you have access to (see above)...
 
if ( $order ) {
   $order->get_id();
   $order->get_formatted_order_total( );
   // etc.
   // etc.
}