WooCommerce Code Reference

ProductAvailabilityUtils.php

Source code

<?php
declare(strict_types=1);
namespace Automattic\WooCommerce\Blocks\Utils;

use Automattic\WooCommerce\Blocks\Templates\ProductStockIndicator;
use Automattic\WooCommerce\Enums\ProductType;

/**
 * Utility functions for product availability.
 */
class ProductAvailabilityUtils {

	/**
	 * Get product availability information.
	 *
	 * @param \WC_Product $product Product object.
	 * @return string[] The product availability class and text.
	 */
	public static function get_product_availability( $product ) {
		$product_availability = array(
			'availability' => '',
			'class'        => '',
		);

		if ( ! $product ) {
			return $product_availability;
		}

		$product_availability = $product->get_availability();

		// If the product is a variable product, make sure at least one of its
		// variations is purchasable.
		if (
			isset( $product_availability['class'] ) &&
			( 'in-stock' === $product_availability['class'] || 'available-on-backorder' === $product_availability['class'] ) &&
			ProductType::VARIABLE === $product->get_type()
		) {
			if ( ! $product->has_purchasable_variations() ) {
				$product_availability['availability'] = __( 'Out of stock', 'woocommerce' );
				$product_availability['class']        = 'out-of-stock';
			}
		}

		return $product_availability;
	}
}