WordPress action hook

woocommerce_product_on_backorder

Defined by WooCommerce and fired by 3 plugins in total, running on 7M+ sites between them.

“Action fires when an item in an order is backordered.”

How to use woocommerce_product_on_backorder

It's an action: your callback runs at that point and receives 1 argument. Nothing needs to be returned. Add this to your theme's functions.php or a small custom plugin:

functions.php
add_action( 'woocommerce_product_on_backorder', function( $arg1 ) {
	// Your code runs here.
}, 10, 1 );

Argument names come from WooCommerce's source. Other plugins may pass different values: check the call in the plugin you're targeting below.

3 plugins that fire woocommerce_product_on_backorder

Sorted by active installs. Each entry shows where the plugin calls the hook and what it passes.

  1. WooCommerce icon WooCommerce7+ million installs do_action( 'woocommerce_product_on_backorder', array( 'product' => wc_get_product( $change['product']->get_id() ), 'order_id' => $order->get_id(), 'quantity' => abs( $change['from'] - $change['to'] ), ) ) includes/wc-stock-functions.php:300
  2. ATUM WooCommerce Inventory Management and Stock Tracking icon ATUM WooCommerce Inventory Management and Stock Tracking10,000+ installs do_action( 'woocommerce_product_on_backorder', array( 'product' => wc_get_product( $change['product']->get_id() ), 'order_id' => $order->get_id(), 'quantity' => abs( $change['from'] - $change['to'] ), ) ) classes/Inc/Hooks.php:1306
  3. WholesaleX icon WholesaleX2,000+ installs do_action( 'woocommerce_product_on_backorder', array( 'product' => wc_get_product( $change['product']->get_id() ), 'order_id' => $order->get_id(), 'quantity' => abs( $change['from'] - $change['to'] ), ) ) includes/class-wholesalex-product.php:918

Need a customisation built on this hook?

Tell us what you want to change and which plugin it's for. We'll write it, test it and send it back as a small plugin.