Automattic\WooCommerce\Blocks\BlockTypes

ProductRating::render() │ protected │ WC 1.0

Include and render the block.

Method of the class: ProductRating{}

No Hooks.

Return

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.

ProductRating::render() ProductRating::render code ^{WC 9.4.2}

protected function render( $attributes, $content, $block ) {
	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 = wc_get_product( $post_id );

	if ( $product && $product->get_review_count() > 0
		&& $product->get_reviews_allowed()
		&& wc_reviews_enabled() ) {
		$product_reviews_count                    = $product->get_review_count();
		$product_rating                           = $product->get_average_rating();
		$parsed_attributes                        = $this->parse_attributes( $attributes );
		$is_descendent_of_single_product_block    = $parsed_attributes['isDescendentOfSingleProductBlock'];
		$is_descendent_of_single_product_template = $parsed_attributes['isDescendentOfSingleProductTemplate'];

		$styles_and_classes            = StyleAttributesUtils::get_classes_and_styles_by_attributes( $attributes );
		$text_align_styles_and_classes = StyleAttributesUtils::get_text_align_class_and_style( $attributes );

		/**
		 * Filter the output from wc_get_rating_html.
		 *
		 * @param string $html   Star rating markup. Default empty string.
		 * @param float  $rating Rating being shown.
		 * @param int    $count  Total number of ratings.
		 * @return string
		 */
		$filter_rating_html = function( $html, $rating, $count ) use ( $post_id, $product_rating, $product_reviews_count, $is_descendent_of_single_product_block, $is_descendent_of_single_product_template ) {
			$product_permalink = get_permalink( $post_id );
			$reviews_count     = $count;
			$average_rating    = $rating;

			if ( $product_rating ) {
				$average_rating = $product_rating;
			}

			if ( $product_reviews_count ) {
				$reviews_count = $product_reviews_count;
			}

			if ( 0 < $average_rating || false === $product_permalink ) {
				/* translators: %s: rating */
				$label                  = sprintf( __( 'Rated %s out of 5', 'woocommerce' ), $average_rating );
				$customer_reviews_count = sprintf(
					/* translators: %s is referring to the total of reviews for a product */
					_n(
						'(%s customer review)',
						'(%s customer reviews)',
						$reviews_count,
						'woocommerce'
					),
					esc_html( $reviews_count )
				);

				if ( $is_descendent_of_single_product_block ) {
					$customer_reviews_count = '<a href="' . esc_url( $product_permalink ) . '#reviews">' . $customer_reviews_count . '</a>';
				} elseif ( $is_descendent_of_single_product_template ) {
					$customer_reviews_count = '<a class="woocommerce-review-link" rel="nofollow" href="#reviews">' . $customer_reviews_count . '</a>';
				}

				$reviews_count_html = sprintf( '<span class="wc-block-components-product-rating__reviews_count">%1$s</span>', $customer_reviews_count );
				$html               = sprintf(
					'<div class="wc-block-components-product-rating__container">
						<div class="wc-block-components-product-rating__stars wc-block-grid__product-rating__stars" role="img" aria-label="%1$s">
							%2$s
						</div>
						%3$s
					</div>
					',
					esc_attr( $label ),
					wc_get_star_rating_html( $average_rating, $reviews_count ),
					$is_descendent_of_single_product_block || $is_descendent_of_single_product_template ? $reviews_count_html : ''
				);
			} else {
				$html = '';
			}

			return $html;
		};

		add_filter(
			'woocommerce_product_get_rating_html',
			$filter_rating_html,
			10,
			3
		);

		$rating_html = wc_get_rating_html( $product->get_average_rating() );

		remove_filter(
			'woocommerce_product_get_rating_html',
			$filter_rating_html,
			10
		);

		return sprintf(
			'<div class="wc-block-components-product-rating wc-block-grid__product-rating %1$s %2$s" style="%3$s">
				%4$s
			</div>',
			esc_attr( $text_align_styles_and_classes['class'] ?? '' ),
			esc_attr( $styles_and_classes['classes'] ),
			esc_attr( $styles_and_classes['styles'] ?? '' ),
			$rating_html
		);
	}
	return '';
}