As a WooCommerce development freelancer, every day I repeat many coding operations that make me waste time. One of them is: “How to get ____ if I have the $order variable/object?“.
For example, “How can I get the order total“? Or “How can I get the order items“? Or maybe the order ID, customer ID, billing info, payment method, total refunds and so on… hopefully this article will help you save time as well!
As we’ve seen in other articles, get product info from $product object and get cart info from $cart object, not always you can have direct access to the $order variable.
Sometimes, you may have the $order_id available for example. In that scenario, you can “get” the order object with the wc_get_order WooCommerce function.
It’s also possible to gain $order information if you are in an email template. This can be helpful to show additional $order information in your transactional communications or trigger custom functions. Either way, enjoy!
1. You have access to $order variable
Hooks (do_action and apply_filters) use additional arguments which are passed on to the function. If they allow you to use the “$order” object you’re in business. Here’s how to get all the order information:
// 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();
$name = $item->get_name();
$quantity = $item->get_quantity();
$subtotal = $item->get_subtotal();
$total = $item->get_total();
$tax = $item->get_subtotal_tax();
$taxclass = $item->get_tax_class();
$taxstat = $item->get_tax_status();
$allmeta = $item->get_meta_data();
$somemeta = $item->get_meta( '_whatever', true );
$type = $item->get_type();
}
// 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();
// 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();
2. You have access to $order_id variable
If you have access to the order ID (once again, usually the do_action or apply_filters might give you this), you have to get the order object first. Then do the exact same things as above.
// 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. You have access to $email variable
If you are working with WooCommerce emails, often you will have the $email object available as parameter. In order to get the object from that, you need an additional step. Then do the exact same things as above.
// 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.
}
Hi
Already thank’s for this … it really helps me!
Just a question … is it possible to use it with multiple $order_id?
I would like to make a resume (Products and quantity) of a group of X orders.
Any idea?
Best regards
Hi Vincent, thanks so much for your comment! Yes, this is definitely possible, but I’m afraid it’s custom work. If you’d like to get a quote, feel free to contact me here. Thanks a lot for your understanding!
Hi I want to display some ACF fields i get when i import products with WP All import in the admin’s order page. By default woo only shows the item title, sku, quantity and price. Is the code you posted the right way to go? can you give me a hint? i’m totally lost. I know i can create a custom field inside the admin’s order page with ACF, but then i’ll have to fill in the content manually. That’s not what i need. What i need is that the field created in admin’s order page automatically pulls product information that is already loaded…for ex the tax fee applied to that product or whatever i need. Don’t confuse with the data the customer fills in when he makes an order, no. The data i need is already loaded in the product when i make the import with WP All import. Thanks
Hi Alejandro, thanks so much for your comment! Yes, this is definitely possible, but I’m afraid it’s custom work. If you’d like to get a quote, feel free to contact me here. Thanks a lot for your understanding!
Thank you for this. It is very useful. Does this work on the checkout page before the order has actually been submitted? Is there another way to access the product information on that page otherwise?
I tried this
function product_requires_camper() { $order = wc_get_order( $order_id ); if ( $order ) { return "<h1>HELLO I'M HERE</h1>"; } }and used shortcode to add it to the checkout page. The message did not appear when I opened the checkout page.
No, $order does not exists yet. Use https://businessbloomer.com/woocommerce-get-cart-info-total-items-etc-from-cart-object/ instead
Rodolfo, your website is an incredible resource.
I am looking to add a simple bar in the WP admin bar that can take me directly to the edit order page.
Since we have this function: $order->get_edit_order_url(); wondering how you might achieve this? I cannot believe there is not a single plugin or even code snippet to achieve this. Often we get phone calls from customers and we need to go right to a specific order. This would allow in 1 single step.
Any advice on how this might be achieved?
Never mind my friend – thank you. We built a plugin that now handles this for normal naming convention of orders as well as changed naming conventions due to plugins.
Please keep up the amazing work you do. I have used several of your code snippets and enjoy reading your extensively annotated work.
Stay safe!
Awesome!
its possibility catch de category of de product/s que customer buyed? i need this dato for send different email for the customer in the moment of de buyed. Thanks
Yes, it’s possible. Do you need to send a custom, additional email – or to customize an existing order email?
Hi, I am trying to put a unit price of each item before quantity column on woocommerce email. Below is what I have done and it displays the unit price but if the item is discounted, this will show the discounted price. How can i make the unit price shows before discount price?
Thanks in advance.
Hi James, thanks so much for your comment! Yes, this is definitely possible, but I’m afraid it’s custom work. If you’d like to get a quote, feel free to contact me here. Thanks a lot for your understanding!
Thanks for this list! I’m trying to make good use of it. So I’ve set up an action in my functions.php file like this (is this a good place to hook into Woo?):
and I am trying to get all kinds of stuff from about the Order, so I’ve started with the following:
function bazaarvoice_data () { global $woocommerce; global $order_id, $order; $order_id = $order->get_id(); echo $order_id; }And, when I run things, I keep getting this error:
[22-Sep-2019 22:58:45 UTC] PHP Fatal error: Call to a member function get_id() on string in /mnt/objectivefs/dev_sites/gunvault/wp-content/themes/Avada-Child-Theme/functions.php on line 50
So, I figure I’m missing something, but what? Do I need to add something to the get_id()? Or is it something else?
Huge thanks in advance.
~Walt
Hi Walt – that’s the wrong hook as the $order doesn’t exist yet. Try with “woocommerce_thankyou” instead, which gives you access to $order_id
hello,
I have used woocommerce_thankyou hook but still, am getting error ‘site blocked’.
No idea
How do I display the number of orders and the number of downloads per user in user profile?
I want to show the number of orders and number of download per user in user profile.
Shahoo, thanks so much for your comment! Yes, this is definitely possible, but I’m afraid it’s custom work. If you’d like to get a quote, feel free to contact me here. Thanks a lot for your understanding!
Hi,
I used a total different template for those emails and unfortunately, I don’t manage to get the total discount…
From this list (awesome btw), I should use either `$order->get_discount_total();` or `$order->get_total_discount();` but both display 0 while if I come back to the default woocommerce email template, the discount is displayed.
The discount I’m talking about is not a coupon but a buy 2 get 1 free that has been coded in the store. But since Woocommerce template gets it, why can’t it?
Thanks for the help,
Any idea?
Hello Nicolas, thanks so much for your comment! Yes, this is definitely possible, but I’m afraid it’s custom work. If you’d like to get a quote, feel free to contact me here. Thanks a lot for your understanding!
use this snippet to get the all used coupon to this order.
Thanks!
Hello, I want to show the Order Status in the PDF Invoice, how can I do it?
get_status($order_status); ?>
Hello Mergim, thanks so much for your comment! Yes, this is definitely possible, but I’m afraid it’s custom work. If you’d like to get a quote, feel free to contact me here. Thanks a lot for your understanding!
This is Very Helpful ….. Thanks alot
Great!
Hi expert,
Regards.
I am using Woocommerce Multi Vendor Market Place (bu WCLovers) along with its WooCommerce Frontend Manager.
I want to add more orders fields in Vendor Dashboard. In a view of Order List, like Billing Address for example.
Please assist.
Thank you
Edo
Edo, please ask their support team
Hi Rodolfo!
How can I have access in the $order object?
Hey Mike! On which page are you?
Can you help me ? Of course, for a fee. I want to add data to the order confirmation – everything is OK, but they are not showing off. Will you do such a service for me?
Hello Jacek, thanks so much for your comment! Yes, if you’d like to get a quote, feel free to contact me here. Thanks a lot! ~R
Hello Rodolfo,
I have created a custom template in my theme file and would to get Woocommerce order details variable in that page. However when I tried to echo $order->get_total(), internet server error with notice “Failed to load resource” appeared. Is there possibility whereby the code only function if the php is in Woocommerce plugin directory?
Thank you.
Hey Will, thanks for your comment! The code will work everywhere (however, it’s better if you place it in functions.php) as long as you have access to the $order variable
Hi Rodolfo,
I would like to add a script at the “thank you page” in WooCommerce to run a URL like:
Could you help me getting this parameters?
Thank you
Upss! I forgot to wrap it between tags.
This is the URL:
Hey Marco, thanks for your comment! Please see https://businessbloomer.com/woocommerce-add-conversion-tracking-code-thank-page/ and then given you have access to “$order_id”, you can “echo” those values with PHP inside the script. Hope this helps
Hey Rodolfo,
I tried to publish:
add_action( 'woocommerce_thankyou', 'bbloomer_conversion_tracking_thank_you_page' ); function bbloomer_conversion_tracking_thank_you_page() { $order = wc_get_order( $order_id ); echo $order->get_order_number(); echo $order->get_formatted_order_total(); ?> <?php }But the page seems blocked. When I remove the code above and I reload the page, then it works. I think that the problem is related to de $order. I am not a developer.
Thank you very much for your help.
Hey Marco, thanks for your comment! You need to pass “$order_id” to the function
Yeah, sure, but I don’t know how to do it… 🙁
Could you help me?
Thanks!
Marco unfortunately this is custom work and I cannot provide a complementary solution here via the blog comments. If you’d like to get a quote, feel free to contact me here. Thanks a lot for your understanding! ~R
Sure! I completely understand. Finally I got the solution.
Thanks for your help!
Awesome 🙂
Marosseculi, if you’re still here would you mind sharing how you got the order_id and order_total into the link? I understand where to put the code (functions.php) but I’m unsure of how those values get written into the link.
Great Blogpost, Thanks Rodolfo.
🙂