Automattic\WooCommerce\Blocks\Utils

ProductAvailabilityUtils{}WC 1.0

Utility functions for product availability.

No Hooks.

Usage

$ProductAvailabilityUtils = new ProductAvailabilityUtils();
// use class methods

Methods

  1. public static get_product_availability( $product )

ProductAvailabilityUtils{} code WC 9.9.3

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;
		}

		// If the product is a variable product, check if it has any available variations.
		// We will show a custom availability message if it does.
		if ( $product->get_type() === ProductType::VARIABLE ) {
			if ( ! $product->has_available_variations() ) {
				$product_availability['availability'] = __( 'This product is currently out of stock and unavailable.', 'woocommerce' );
				$product_availability['class']        = 'out-of-stock';
			}
		} else {
			$product_availability = $product->get_availability();
		}

		return $product_availability;
	}
}