Automattic\WooCommerce\Blocks\BlockTypes

ProductStockIndicator::render │ protected │ WC 1.0

Renders the stock indicator block.

This method handles both direct product context and global product context, ensuring the stock indicator displays correctly in various template scenarios.

Method of the class: ProductStockIndicator{}

No Hooks.

Returns

String. Rendered block type output.

Usage

// protected - for code of main (parent) or child class
$result = $this->render( $attributes, $content, $block );

$attributes(array) (required)

Block attributes.
Default: empty array

$content(string) (required)

Block content.
Default: empty string

$block(WP_Block) (required)

Block instance.

ProductStockIndicator::render() ProductStockIndicator::render code ^{WC 10.6.2}

protected function render( $attributes, $content, $block ) {
	global $product;

	if ( ! empty( $content ) ) {
		parent::register_block_type_assets();
		$this->register_chunk_translations( [ $this->block_name ] );
		return $content;
	}
	$post_id           = isset( $block->context['postId'] ) ? $block->context['postId'] : '';
	$product_to_render = wc_get_product( $post_id );

	// Use the global product if the product to render can't be retrieved from the context.
	if ( ! $product_to_render instanceof WC_Product ) {
		$product_to_render = $product;
	}

	if ( ! $product_to_render || in_array( $product_to_render->get_type(), $this->get_product_types_without_stock_indicator(), true ) ) {
		return '';
	}

	$availability = ProductAvailabilityUtils::get_product_availability( $product_to_render );

	$is_descendant_of_product_collection       = isset( $block->context['query']['isProductCollectionBlock'] );
	$is_descendant_of_grouped_product_selector = isset( $block->context['isDescendantOfGroupedProductSelector'] );
	$is_interactive                            = ! $is_descendant_of_product_collection && ! $is_descendant_of_grouped_product_selector && $product_to_render->is_type( ProductType::VARIABLE );

	if ( empty( $availability['availability'] ) && ! $is_interactive ) {
		return '';
	}

	$total_stock        = $product_to_render->get_stock_quantity();
	$classes_and_styles = StyleAttributesUtils::get_classes_and_styles_by_attributes( $attributes );

	$classnames  = isset( $classes_and_styles['classes'] ) ? ' ' . $classes_and_styles['classes'] . ' ' : '';
	$classnames .= sprintf( ' wc-block-components-product-stock-indicator--%s', $availability['class'] );

	$is_backorder_notification_visible = $product_to_render->is_in_stock() && $product_to_render->backorders_require_notification();

	if ( empty( $content ) && $is_backorder_notification_visible && $total_stock > 0 ) {
		$low_stock_text = sprintf(
			/* translators: %d is number of items in stock for product */
			__( '%d left in stock', 'woocommerce' ),
			$total_stock
		);
	}

	$wrapper_attributes = array();
	$watch_attribute    = '';

	if ( $is_interactive && 'out-of-stock' !== $availability['class'] ) {
		$variations                = $product_to_render->get_available_variations( 'objects' );
		$formatted_variations_data = array();
		foreach ( $variations as $variation ) {
			$variation_availability = $variation->get_availability();
			if ( is_string( $variation_availability['availability'] ) && ! empty( $variation_availability['availability'] ) ) {
				$formatted_variations_data[ $variation->get_id() ] = array(
					'availability' => $variation_availability['availability'],
				);
			}
		}

		wp_interactivity_config(
			'woocommerce',
			array(
				'products' => array(
					$product_to_render->get_id() => array(
						'availability' => $availability['availability'],
						'variations'   => $formatted_variations_data,
					),
				),
			)
		);

		wp_enqueue_script_module( 'woocommerce/product-elements' );
		$wrapper_attributes['data-wp-interactive'] = 'woocommerce/product-elements';
		$wrapper_attributes['data-wp-text']        = 'state.productData.availability';
		$wrapper_attributes['aria-live']           = 'polite';
		$wrapper_attributes['aria-atomic']         = 'true';
	}

	$output_text = $low_stock_text ?? $availability['availability'];

	$output  = '';
	$output .= '<div class="wc-block-components-product-stock-indicator wp-block-woocommerce-product-stock-indicator ' . esc_attr( $classnames ) . '"';
	$output .= isset( $classes_and_styles['styles'] ) ? ' style="' . esc_attr( $classes_and_styles['styles'] ) . '"' : '';
	if ( $is_interactive && 'out-of-stock' !== $availability['class'] ) {
		$output .= ' ' . get_block_wrapper_attributes( $wrapper_attributes );
	}
	$output .= '>';
	$output .= wp_kses_post( $output_text );
	$output .= '</div>';

	return $output;
}