ProductReviewForm.php
<?php declare( strict_types = 1 );
namespace Automattic\WooCommerce\Blocks\BlockTypes\Reviews;
use Automattic\WooCommerce\Blocks\BlockTypes\AbstractBlock;
use Automattic\WooCommerce\Blocks\BlockTypes\EnableBlockJsonAssetsTrait;
/**
* ProductReviewForm class.
*/
class ProductReviewForm extends AbstractBlock {
use EnableBlockJsonAssetsTrait;
/**
* Block name.
*
* @var string
*/
protected $block_name = 'product-review-form';
/**
* Render the block.
*
* @param array $attributes Block attributes.
* @param string $content Block content.
* @param WP_Block $block Block instance.
* @return string Rendered block content.
*/
protected function render( $attributes, $content, $block ) {
if ( ! isset( $block->context['postId'] ) ) {
return '';
}
if ( post_password_required( $block->context['postId'] ) ) {
return '';
}
$product = wc_get_product( $block->context['postId'] );
if ( ! $product ) {
return '';
}
if ( get_option( 'woocommerce_review_rating_verification_required' ) !== 'no' && ! wc_customer_bought_product( '', get_current_user_id(), $product->get_id() ) ) {
return '<p class="woocommerce-verification-required">' . esc_html__( 'Only logged in customers who have purchased this product may leave a review.', 'woocommerce' ) . '</p>';
}
$interactivity_state = [];
$interactivity_config = [
'reviewRatingEnabled' => wc_review_ratings_enabled(),
];
$classes = [ 'comment-respond' ];
if ( isset( $attributes['textAlign'] ) ) {
$classes[] = 'has-text-align-' . $attributes['textAlign'];
}
if ( isset( $attributes['style']['elements']['link']['color']['text'] ) ) {
$classes[] = 'has-link-color';
}
$wrapper_attributes = get_block_wrapper_attributes(
[
'class' => implode( ' ', $classes ),
]
);
$commenter = wp_get_current_commenter();
$comment_form = [
/* translators: %s is product title */
'title_reply' => $product->get_review_count() > 0 ? esc_html__( 'Add a review', 'woocommerce' ) : sprintf( esc_html__( 'Be the first to review “%s”', 'woocommerce' ), esc_html( get_the_title( $block->context['postId'] ) ) ),
/* translators: %s is product title */
'title_reply_to' => esc_html__( 'Leave a Reply to %s', 'woocommerce' ),
'title_reply_before' => '<span id="reply-title" class="comment-reply-title" role="heading" aria-level="3">',
'title_reply_after' => '</span>',
'comment_notes_after' => '',
'label_submit' => esc_html__( 'Submit', 'woocommerce' ),
'logged_in_as' => '',
'comment_field' => '',
];
$name_email_required = (bool) get_option( 'require_name_email', 1 );
$fields = [
'author' => [
'label' => __( 'Name', 'woocommerce' ),
'type' => 'text',
'value' => $commenter['comment_author'],
'required' => $name_email_required,
'autocomplete' => 'name',
],
'email' => [
'label' => __( 'Email', 'woocommerce' ),
'type' => 'email',
'value' => $commenter['comment_author_email'],
'required' => $name_email_required,
'autocomplete' => 'email',
],
];
$comment_form['fields'] = [];
foreach ( $fields as $key => $field ) {
$field_html = '<p class="comment-form-' . esc_attr( $key ) . '">';
$field_html .= '<label for="' . esc_attr( $key ) . '">' . esc_html( $field['label'] );
if ( $field['required'] ) {
$field_html .= ' <span class="required">*</span>';
}
$field_html .= '</label><input id="' . esc_attr( $key ) . '" name="' . esc_attr( $key ) . '" type="' . esc_attr( $field['type'] ) . '" autocomplete="' . esc_attr( $field['autocomplete'] ) . '" value="' . esc_attr( $field['value'] ) . '" size="30" ' . ( $field['required'] ? 'required' : '' ) . ' /></p>';
$comment_form['fields'][ $key ] = $field_html;
}
$account_page_url = wc_get_page_permalink( 'myaccount' );
if ( $account_page_url ) {
/* translators: %s opening and closing link tags respectively */
$comment_form['must_log_in'] = '<p class="must-log-in">' . sprintf( esc_html__( 'You must be %1$slogged in%2$s to post a review.', 'woocommerce' ), '<a href="' . esc_url( $account_page_url ) . '">', '</a>' ) . '</p>';
}
if ( wc_review_ratings_enabled() ) {
$interactivity_state['selectedStar'] = '';
$interactivity_state['hoveredStar'] = '0';
$interactivity_state['ratingError'] = '';
$interactivity_state['hasRatingError'] = false;
$interactivity_config['i18nRequiredRatingText'] = esc_attr__( 'Please select a rating', 'woocommerce' );
$interactivity_config['reviewRatingRequired'] = wc_review_ratings_required();
$comment_form['comment_field'] = '<div class="comment-form-rating"><label for="rating-selector" id="comment-form-rating-label">' .
esc_html__( 'Your rating', 'woocommerce' ) . ( wc_review_ratings_required() ? ' <span class="required">*</span>' : '' ) .
'</label><select name="rating" id="rating-selector" data-wp-init="callbacks.hideRatingSelector" data-wp-bind--value="state.selectedStar" ' . ( wc_review_ratings_required() ? ' required' : '' ) . '>
<option value="">' . esc_html__( 'Rate…', 'woocommerce' ) . '</option>
<option value="5">' . esc_html__( 'Perfect', 'woocommerce' ) . '</option>
<option value="4">' . esc_html__( 'Good', 'woocommerce' ) . '</option>
<option value="3">' . esc_html__( 'Average', 'woocommerce' ) . '</option>
<option value="2">' . esc_html__( 'Not that bad', 'woocommerce' ) . '</option>
<option value="1">' . esc_html__( 'Very poor', 'woocommerce' ) . '</option>
</select>' .
'<p role="radiogroup" aria-labelledby="comment-form-rating-label" class="stars-wrapper" data-wp-init="callbacks.showRatingStars" hidden data-wp-bind--aria-invalid="state.hasRatingError"' . ( wc_review_ratings_required() ? ' aria-required="true"' : '' ) . ' aria-describedby="rating-error">' . $this->render_stars() .
( wc_review_ratings_required() ? '<small id="rating-error" data-wp-text="state.ratingError" class="rating-error" data-wp-bind--hidden="!state.hasRatingError" role="alert"></small>' : '' ) .
'</p></div>';
}
$comment_form['comment_field'] .= '<p class="comment-form-comment"><label for="comment">' . esc_html__( 'Your review', 'woocommerce' ) . ' <span class="required">*</span></label><textarea id="comment" name="comment" cols="45" rows="8" required></textarea></p>';
add_filter( 'comment_form_defaults', 'post_comments_form_block_form_defaults' );
ob_start();
echo '<div id="review_form_wrapper" data-wp-interactive="woocommerce/product-reviews"><div id="review_form">';
/**
* Filters the comment form arguments.
*
* @since 9.9.0
* @param array $comment_form The comment form arguments.
* @param int $post_id The post ID.
*/
comment_form( apply_filters( 'woocommerce_product_review_comment_form_args', $comment_form ), $block->context['postId'] );
echo '</div></div>';
$form = ob_get_clean();
remove_filter( 'comment_form_defaults', 'post_comments_form_block_form_defaults' );
$form = str_replace( 'class="comment-respond"', $wrapper_attributes, $form );
$p = new \WP_HTML_Tag_Processor( $form );
if ( $p->next_tag( 'form' ) ) {
$p->set_attribute( 'data-wp-on--submit', 'actions.handleSubmit' );
}
if ( ! empty( $interactivity_state ) ) {
wp_interactivity_state( 'woocommerce/product-reviews', $interactivity_state );
}
if ( ! empty( $interactivity_config ) ) {
wp_interactivity_config( 'woocommerce/product-reviews', $interactivity_config );
}
return $p->get_updated_html();
}
/**
* Render stars for rating selector.
*/
private function render_stars() {
ob_start();
echo '<span class="stars">';
for ( $i = 1; $i < 6; $i++ ) {
?>
<button
role="radio"
type="button"
<?php /* translators: %d is the rating value from 1 to 5 */ ?>
aria-label='<?php echo esc_attr( sprintf( _n( '%d of 5 star', '%d of 5 stars', $i, 'woocommerce' ), $i ) ); ?>'
data-wp-on-async--mouseenter="actions.hoverStar"
data-wp-on-async--mouseleave="actions.leaveStar"
data-wp-on-async--click="actions.selectStar"
data-wp-on-async--keydown="actions.changeRatingWithKeyboard"
data-wp-class--is-hovered="state.isStarHovered"
data-wp-class--is-selected="state.isStarSelected"
data-wp-bind--aria-checked="state.isStarSelected"
<?php echo wp_interactivity_data_wp_context( [ 'starValue' => $i ] ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped ?>
>
<svg
width='24'
height='24'
viewBox='0 0 24 24'
aria-hidden="true"
focusable="false"
>
<path d="M12 17.27L18.18 21l-1.64-7.03L22 9.24l-7.19-.61L12 2 9.19 8.63 2 9.24l5.46 4.73L5.82 21z" fill="none" stroke="currentColor" stroke-width="1.5"/>
</svg>
</button>
<?php
}
echo '</span>';
return ob_get_clean();
}
}
