Automattic\WooCommerce\StoreApi\Routes\V1

ProductReviews::get_route_response │ protected │ WC 1.0

Get a collection of reviews.

Метод класса: ProductReviews{}

Хуков нет.

Возвращает

\WP_REST_Response.

Использование

// protected - в коде основоного (родительского) или дочернего класса
$result = $this->get_route_response( $request );
$request(WP_REST_Request) (обязательный)
Request object.

Код ProductReviews::get_route_response() WC 11.3.0

protected function get_route_response( \WP_REST_Request $request ) {
	$prepared_args = array(
		'type'          => 'review',
		'status'        => 'approve',
		'no_found_rows' => false,
		'offset'        => $request['offset'],
		'order'         => $request['order'],
		'number'        => $request['per_page'],
		'post__in'      => $request['product_id'],
		// Exclude reviews of non-published products.
		'post_status'   => ProductStatus::PUBLISH,
	);

	/**
	 * Map category id to list of product ids.
	 */
	if ( ! empty( $request['category_id'] ) ) {
		$category_ids = $request['category_id'];
		$child_ids    = [];
		foreach ( $category_ids as $category_id ) {
			$child_ids = array_merge( $child_ids, get_term_children( $category_id, 'product_cat' ) );
		}
		$category_ids              = array_unique( array_merge( $category_ids, $child_ids ) );
		$product_ids               = get_objects_in_term( $category_ids, 'product_cat' );
		$prepared_args['post__in'] = isset( $prepared_args['post__in'] ) ? array_merge( $prepared_args['post__in'], $product_ids ) : $product_ids;
	}

	if ( 'rating' === $request['orderby'] ) {
		$prepared_args['meta_query'] = array( // phpcs:ignore
			'relation' => 'OR',
			array(
				'key'     => 'rating',
				'compare' => 'EXISTS',
			),
			array(
				'key'     => 'rating',
				'compare' => 'NOT EXISTS',
			),
		);
	}
	$prepared_args['orderby'] = $this->normalize_query_param( $request['orderby'] );

	if ( empty( $request['offset'] ) ) {
		$prepared_args['offset'] = $prepared_args['number'] * ( absint( $request['page'] ) - 1 );
	}

	$unlocked_product_ids = $this->get_unlocked_password_protected_product_ids( $prepared_args['post__in'] ?? array() );
	sort( $unlocked_product_ids, SORT_NUMERIC );
	// We need to set a cache domain to prevent the comment query from being cached across different sets of unlocked products.
	$prepared_args['cache_domain'] = 'wc_store_api_product_reviews_' . implode( ',', $unlocked_product_ids );

	$exclude_password_protected_reviews = function ( $clauses ) use ( $unlocked_product_ids ) {
		return $this->exclude_password_protected_product_reviews( $clauses, $unlocked_product_ids );
	};

	$query_result  = array();
	$total_reviews = 0;
	$max_pages     = 0;

	add_filter( 'comments_clauses', $exclude_password_protected_reviews );
	try {
		$query        = new WP_Comment_Query();
		$query_result = $query->query( $prepared_args );

		$total_reviews = (int) $query->found_comments;
		$max_pages     = (int) $query->max_num_pages;

		if ( $total_reviews < 1 ) {
			// Out-of-bounds, run the query again without LIMIT for total count.
			unset( $prepared_args['number'], $prepared_args['offset'] );

			$query                  = new WP_Comment_Query();
			$prepared_args['count'] = true;

			$total_reviews = $query->query( $prepared_args );
			$max_pages     = $request['per_page'] ? ceil( $total_reviews / $request['per_page'] ) : 1;
		}
	} finally {
		remove_filter( 'comments_clauses', $exclude_password_protected_reviews );
	}

	$response_objects = array();
	foreach ( $query_result as $review ) {
		$data               = $this->prepare_item_for_response( $review, $request );
		$response_objects[] = $this->prepare_response_for_collection( $data );
	}

	$response = rest_ensure_response( $response_objects );
	$response = ( new Pagination() )->add_headers( $response, $request, $total_reviews, $max_pages );

	return $response;
}