ProductFilterRating.php
<?php
namespace Automattic\WooCommerce\Blocks\BlockTypes;
use Automattic\WooCommerce\Blocks\InteractivityComponents\CheckboxList;
use Automattic\WooCommerce\Blocks\InteractivityComponents\Dropdown;
use Automattic\WooCommerce\Blocks\Utils\ProductCollectionUtils;
use Automattic\WooCommerce\Blocks\QueryFilters;
use Automattic\WooCommerce\Blocks\Package;
/**
* Product Filter: Rating Block
*
* @package Automattic\WooCommerce\Blocks\BlockTypes
*/
final class ProductFilterRating extends AbstractBlock {
/**
* Block name.
*
* @var string
*/
protected $block_name = 'product-filter-rating';
const RATING_FILTER_QUERY_VAR = 'rating_filter';
/**
* Initialize this block type.
*
* - Hook into WP lifecycle.
* - Register the block with WordPress.
*/
protected function initialize() {
parent::initialize();
add_filter( 'collection_filter_query_param_keys', array( $this, 'get_filter_query_param_keys' ), 10, 2 );
add_filter( 'collection_active_filters_data', array( $this, 'register_active_filters_data' ), 10, 2 );
}
/**
* Register the query param keys.
*
* @param array $filter_param_keys The active filters data.
* @param array $url_param_keys The query param parsed from the URL.
*
* @return array Active filters param keys.
*/
public function get_filter_query_param_keys( $filter_param_keys, $url_param_keys ) {
$rating_param_keys = array_filter(
$url_param_keys,
function( $param ) {
return self::RATING_FILTER_QUERY_VAR === $param;
}
);
return array_merge(
$filter_param_keys,
$rating_param_keys
);
}
/**
* Register the active filters data.
*
* @param array $data The active filters data.
* @param array $params The query param parsed from the URL.
* @return array Active filters data.
*/
public function register_active_filters_data( $data, $params ) {
if ( empty( $params[ self::RATING_FILTER_QUERY_VAR ] ) ) {
return $data;
}
$active_ratings = array_filter(
explode( ',', $params[ self::RATING_FILTER_QUERY_VAR ] )
);
if ( empty( $active_ratings ) ) {
return $data;
}
$active_ratings = array_map(
function( $rating ) {
return array(
/* translators: %d is the rating value. */
'title' => sprintf( __( 'Rated %d out of 5', 'woocommerce' ), $rating ),
'attributes' => array(
'data-wc-on--click' => "{$this->get_full_block_name()}::actions.removeFilter",
'data-wc-context' => "{$this->get_full_block_name()}::" . wp_json_encode( array( 'value' => $rating ) ),
),
);
},
$active_ratings
);
$data['rating'] = array(
'type' => __( 'Rating', 'woocommerce' ),
'items' => $active_ratings,
);
return $data;
}
/**
* Include and render the block.
*
* @param array $attributes Block attributes. Default empty array.
* @param string $content Block content. Default empty string.
* @param WP_Block $block Block instance.
* @return string Rendered block type output.
*/
protected function render( $attributes, $content, $block ) {
// don't render if its admin, or ajax in progress.
if ( is_admin() || wp_doing_ajax() ) {
return '';
}
$rating_counts = $this->get_rating_counts( $block );
$display_style = $attributes['displayStyle'] ?? 'list';
$show_counts = $attributes['showCounts'] ?? false;
$filtered_rating_counts = array_filter(
$rating_counts,
function( $rating ) {
return $rating['count'] > 0;
}
);
$wrapper_attributes = get_block_wrapper_attributes(
array(
'data-wc-interactive' => $this->get_full_block_name(),
'data-has-filter' => empty( $filtered_rating_counts ) ? 'no' : 'yes',
)
);
if ( empty( $filtered_rating_counts ) ) {
return sprintf(
'<div %s></div>',
$wrapper_attributes
);
}
// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Nonce verification is not required here.
$selected_ratings_query_param = isset( $_GET[ self::RATING_FILTER_QUERY_VAR ] ) ? sanitize_text_field( wp_unslash( $_GET[ self::RATING_FILTER_QUERY_VAR ] ) ) : '';
$input = 'list' === $display_style ? CheckboxList::render(
array(
'items' => $this->get_checkbox_list_items( $filtered_rating_counts, $selected_ratings_query_param, $show_counts ),
'on_change' => "{$this->get_full_block_name()}::actions.onCheckboxChange",
)
) : Dropdown::render(
$this->get_dropdown_props( $filtered_rating_counts, $selected_ratings_query_param, $show_counts, $attributes['selectType'] )
);
return sprintf(
'<div %1$s>
%2$s
</div>',
$wrapper_attributes,
$input
);
}
/**
* Render the rating label.
*
* @param int $rating The rating to render.
* @param string $count_label The count label to render.
* @return string|false
*/
private function render_rating_label( $rating, $count_label ) {
$width = $rating * 20;
$rating_label = sprintf(
/* translators: %1$d is referring to rating value. Example: Rated 4 out of 5. */
__( 'Rated %1$d out of 5', 'woocommerce' ),
$rating,
);
ob_start();
?>
<div class="wc-block-components-product-rating">
<div class="wc-block-components-product-rating__stars" role="img" aria-label="<?php echo esc_attr( $rating_label ); ?>">
<span style="width: <?php echo esc_attr( $width ); ?>%" aria-hidden="true">
</span>
</div>
<span class="wc-block-components-product-rating-count">
<?php echo esc_html( $count_label ); ?>
</span>
</div>
<?php
return ob_get_clean();
}
/**
* Get the checkbox list items.
*
* @param array $rating_counts The rating counts.
* @param string $selected_ratings_query The url query param for selected ratings.
* @param bool $show_counts Whether to show the counts.
* @return array
*/
private function get_checkbox_list_items( $rating_counts, $selected_ratings_query, $show_counts ) {
$ratings_array = explode( ',', $selected_ratings_query );
return array_map(
function( $rating ) use ( $ratings_array, $show_counts ) {
$rating_str = (string) $rating['rating'];
$count = $rating['count'];
$count_label = $show_counts ? "($count)" : '';
$aria_label = sprintf(
/* translators: %1$d is referring to rating value. Example: Rated 4 out of 5. */
__( 'Rated %s out of 5', 'woocommerce' ),
$rating_str,
);
return array(
'id' => 'rating-' . $rating_str,
'checked' => in_array( $rating_str, $ratings_array, true ),
'label' => $this->render_rating_label( (int) $rating_str, $count_label ),
'aria_label' => $aria_label,
'value' => $rating_str,
);
},
$rating_counts
);
}
/**
* Get the dropdown props.
*
* @param mixed $rating_counts The rating counts.
* @param mixed $selected_ratings_query The url query param for selected ratings.
* @param bool $show_counts Whether to show the counts.
* @param string $select_type The select type. (single|multiple).
* @return array<array-key, array>
*/
private function get_dropdown_props( $rating_counts, $selected_ratings_query, $show_counts, $select_type ) {
$ratings_array = explode( ',', $selected_ratings_query );
$placeholder_text = 'single' === $select_type ? __( 'Select a rating', 'woocommerce' ) : __( 'Select ratings', 'woocommerce' );
$selected_items = array_reduce(
$rating_counts,
function( $carry, $rating ) use ( $ratings_array, $show_counts ) {
if ( in_array( (string) $rating['rating'], $ratings_array, true ) ) {
$count = $rating['count'];
$count_label = $show_counts ? "($count)" : '';
$rating_str = (string) $rating['rating'];
$carry[] = array(
/* translators: %d is referring to the average rating value. Example: Rated 4 out of 5. */
'label' => sprintf( __( 'Rated %d out of 5', 'woocommerce' ), $rating_str ) . ' ' . $count_label,
'value' => $rating['rating'],
);
}
return $carry;
},
array()
);
return array(
'items' => array_map(
function ( $rating ) use ( $show_counts ) {
$count = $rating['count'];
$count_label = $show_counts ? "($count)" : '';
$rating_str = (string) $rating['rating'];
return array(
/* translators: %d is referring to the average rating value. Example: Rated 4 out of 5. */
'label' => sprintf( __( 'Rated %d out of 5', 'woocommerce' ), $rating_str ) . ' ' . $count_label,
'value' => $rating['rating'],
);
},
$rating_counts
),
'select_type' => $select_type,
'selected_items' => $selected_items,
'action' => "{$this->get_full_block_name()}::actions.onDropdownChange",
'placeholder' => $placeholder_text,
);
}
/**
* Retrieve the rating filter data for current block.
*
* @param WP_Block $block Block instance.
*/
private function get_rating_counts( $block ) {
$filters = Package::container()->get( QueryFilters::class );
$query_vars = ProductCollectionUtils::get_query_vars( $block, 1 );
if ( ! empty( $query_vars['tax_query'] ) ) {
// phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_tax_query
$query_vars['tax_query'] = ProductCollectionUtils::remove_query_array( $query_vars['tax_query'], 'rating_filter', true );
}
$counts = $filters->get_rating_counts( $query_vars );
$data = array();
foreach ( $counts as $key => $value ) {
$data[] = array(
'rating' => $key,
'count' => $value,
);
}
return $data;
}
}
