<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Structured data's handler and generator using JSON-LD format.

[2] Fix | Delete

*

[3] Fix | Delete

* When making changes to this file, please make sure to test the generated

[4] Fix | Delete

* markup with Schema Markup Validator and Google Search Console.

[5] Fix | Delete

* * https://validator.schema.org/

[6] Fix | Delete

* * https://search.google.com/test/rich-results

[7] Fix | Delete

*

[8] Fix | Delete

* @package WooCommerce\Classes

[9] Fix | Delete

* @since 3.0.0

[10] Fix | Delete

* @version 3.0.0

[11] Fix | Delete

*/

[12] Fix | Delete

[13] Fix | Delete

use Automattic\WooCommerce\Enums\OrderStatus;

[14] Fix | Delete

use Automattic\WooCommerce\Enums\ProductType;

[15] Fix | Delete

use Automattic\WooCommerce\Enums\ProductStockStatus;

[16] Fix | Delete

[17] Fix | Delete

defined( 'ABSPATH' ) || exit;

[18] Fix | Delete

[19] Fix | Delete

/**

[20] Fix | Delete

* Structured data class.

[21] Fix | Delete

*/

[22] Fix | Delete

class WC_Structured_Data {

[23] Fix | Delete

[24] Fix | Delete

/**

[25] Fix | Delete

* Stores the structured data.

[26] Fix | Delete

*

[27] Fix | Delete

* @var array $_data Array of structured data.

[28] Fix | Delete

*/

[29] Fix | Delete

private $_data = array();

[30] Fix | Delete

[31] Fix | Delete

/**

[32] Fix | Delete

* Constructor.

[33] Fix | Delete

*/

[34] Fix | Delete

public function __construct() {

[35] Fix | Delete

// Generate structured data.

[36] Fix | Delete

add_action( 'woocommerce_before_main_content', array( $this, 'generate_website_data' ), 30 );

[37] Fix | Delete

add_action( 'woocommerce_breadcrumb', array( $this, 'generate_breadcrumblist_data' ), 10 );

[38] Fix | Delete

add_action( 'woocommerce_single_product_summary', array( $this, 'generate_product_data' ), 60 );

[39] Fix | Delete

add_action( 'woocommerce_email_order_details', array( $this, 'generate_order_data' ), 20, 3 );

[40] Fix | Delete

[41] Fix | Delete

// Output structured data.

[42] Fix | Delete

add_action( 'woocommerce_email_order_details', array( $this, 'output_email_structured_data' ), 30, 3 );

[43] Fix | Delete

add_action( 'wp_footer', array( $this, 'output_structured_data' ), 10 );

[44] Fix | Delete

}

[45] Fix | Delete

[46] Fix | Delete

/**

[47] Fix | Delete

* Sets data.

[48] Fix | Delete

*

[49] Fix | Delete

* @param array $data Structured data.

[50] Fix | Delete

* @param bool $reset Unset data (default: false).

[51] Fix | Delete

* @return bool

[52] Fix | Delete

*/

[53] Fix | Delete

public function set_data( $data, $reset = false ) {

[54] Fix | Delete

if ( ! isset( $data['@type'] ) || ! preg_match( '|^[a-zA-Z]{1,20}$|', $data['@type'] ) ) {

[55] Fix | Delete

return false;

[56] Fix | Delete

}

[57] Fix | Delete

[58] Fix | Delete

if ( $reset && isset( $this->_data ) ) {

[59] Fix | Delete

unset( $this->_data );

[60] Fix | Delete

}

[61] Fix | Delete

[62] Fix | Delete

$this->_data[] = $data;

[63] Fix | Delete

[64] Fix | Delete

return true;

[65] Fix | Delete

}

[66] Fix | Delete

[67] Fix | Delete

/**

[68] Fix | Delete

* Gets data.

[69] Fix | Delete

*

[70] Fix | Delete

* @return array

[71] Fix | Delete

*/

[72] Fix | Delete

public function get_data() {

[73] Fix | Delete

return $this->_data;

[74] Fix | Delete

}

[75] Fix | Delete

[76] Fix | Delete

/**

[77] Fix | Delete

* Structures and returns data.

[78] Fix | Delete

*

[79] Fix | Delete

* List of types available by default for specific request:

[80] Fix | Delete

*

[81] Fix | Delete

* 'product',

[82] Fix | Delete

* 'review',

[83] Fix | Delete

* 'breadcrumblist',

[84] Fix | Delete

* 'website',

[85] Fix | Delete

* 'order',

[86] Fix | Delete

*

[87] Fix | Delete

* @param array $types Structured data types.

[88] Fix | Delete

* @return array

[89] Fix | Delete

*/

[90] Fix | Delete

public function get_structured_data( $types ) {

[91] Fix | Delete

$data = array();

[92] Fix | Delete

[93] Fix | Delete

// Put together the values of same type of structured data.

[94] Fix | Delete

foreach ( $this->get_data() as $value ) {

[95] Fix | Delete

$data[ strtolower( $value['@type'] ) ][] = $value;

[96] Fix | Delete

}

[97] Fix | Delete

[98] Fix | Delete

// Wrap the multiple values of each type inside a graph... Then add context to each type.

[99] Fix | Delete

foreach ( $data as $type => $value ) {

[100] Fix | Delete

$data[ $type ] = count( $value ) > 1 ? array( '@graph' => $value ) : $value[0];

[101] Fix | Delete

$data[ $type ] = apply_filters( 'woocommerce_structured_data_context', array( '@context' => 'https://schema.org/' ), $data, $type, $value ) + $data[ $type ];

[102] Fix | Delete

}

[103] Fix | Delete

[104] Fix | Delete

// If requested types, pick them up... Finally change the associative array to an indexed one.

[105] Fix | Delete

$data = $types ? array_values( array_intersect_key( $data, array_flip( $types ) ) ) : array_values( $data );

[106] Fix | Delete

[107] Fix | Delete

if ( ! empty( $data ) ) {

[108] Fix | Delete

if ( 1 < count( $data ) ) {

[109] Fix | Delete

$data = apply_filters( 'woocommerce_structured_data_context', array( '@context' => 'https://schema.org/' ), $data, '', '' ) + array( '@graph' => $data );

[110] Fix | Delete

} else {

[111] Fix | Delete

$data = $data[0];

[112] Fix | Delete

}

[113] Fix | Delete

}

[114] Fix | Delete

[115] Fix | Delete

return $data;

[116] Fix | Delete

}

[117] Fix | Delete

[118] Fix | Delete

/**

[119] Fix | Delete

* Get data types for pages.

[120] Fix | Delete

*

[121] Fix | Delete

* @return array

[122] Fix | Delete

*/

[123] Fix | Delete

protected function get_data_type_for_page() {

[124] Fix | Delete

$types = array();

[125] Fix | Delete

$types[] = is_shop() || is_product_category() || is_product() ? 'product' : '';

[126] Fix | Delete

$types[] = is_shop() && is_front_page() ? 'website' : '';

[127] Fix | Delete

$types[] = is_product() ? 'review' : '';

[128] Fix | Delete

$types[] = 'breadcrumblist';

[129] Fix | Delete

$types[] = 'order';

[130] Fix | Delete

[131] Fix | Delete

return array_filter( apply_filters( 'woocommerce_structured_data_type_for_page', $types ) );

[132] Fix | Delete

}

[133] Fix | Delete

[134] Fix | Delete

/**

[135] Fix | Delete

* Makes sure email structured data only outputs on non-plain text versions.

[136] Fix | Delete

*

[137] Fix | Delete

* @param WP_Order $order Order data.

[138] Fix | Delete

* @param bool $sent_to_admin Send to admin (default: false).

[139] Fix | Delete

* @param bool $plain_text Plain text email (default: false).

[140] Fix | Delete

*/

[141] Fix | Delete

public function output_email_structured_data( $order, $sent_to_admin = false, $plain_text = false ) {

[142] Fix | Delete

if ( $plain_text ) {

[143] Fix | Delete

return;

[144] Fix | Delete

}

[145] Fix | Delete

echo '<div style="display: none; font-size: 0; max-height: 0; line-height: 0; padding: 0; mso-hide: all;">';

[146] Fix | Delete

$this->output_structured_data();

[147] Fix | Delete

echo '</div>';

[148] Fix | Delete

}

[149] Fix | Delete

[150] Fix | Delete

/**

[151] Fix | Delete

* Sanitizes, encodes and outputs structured data.

[152] Fix | Delete

*

[153] Fix | Delete

* Hooked into `wp_footer` action hook.

[154] Fix | Delete

* Hooked into `woocommerce_email_order_details` action hook.

[155] Fix | Delete

*/

[156] Fix | Delete

public function output_structured_data() {

[157] Fix | Delete

$types = $this->get_data_type_for_page();

[158] Fix | Delete

$data = $this->get_structured_data( $types );

[159] Fix | Delete

[160] Fix | Delete

if ( $data ) {

[161] Fix | Delete

echo '<script type="application/ld+json">' . wc_esc_json( wp_json_encode( $data ), true ) . '</script>'; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped

[162] Fix | Delete

}

[163] Fix | Delete

}

[164] Fix | Delete

[165] Fix | Delete

/*

[166] Fix | Delete

|--------------------------------------------------------------------------

[167] Fix | Delete

| Generators

[168] Fix | Delete

|--------------------------------------------------------------------------

[169] Fix | Delete

|

[170] Fix | Delete

| Methods for generating specific structured data types:

[171] Fix | Delete

|

[172] Fix | Delete

| - Product

[173] Fix | Delete

| - Review

[174] Fix | Delete

| - BreadcrumbList

[175] Fix | Delete

| - WebSite

[176] Fix | Delete

| - Order

[177] Fix | Delete

|

[178] Fix | Delete

| The generated data is stored into `$this->_data`.

[179] Fix | Delete

| See the methods above for handling `$this->_data`.

[180] Fix | Delete

|

[181] Fix | Delete

*/

[182] Fix | Delete

[183] Fix | Delete

/**

[184] Fix | Delete

* Generates Product structured data.

[185] Fix | Delete

*

[186] Fix | Delete

* Hooked into `woocommerce_single_product_summary` action hook.

[187] Fix | Delete

*

[188] Fix | Delete

* @param WC_Product $product Product data (default: null).

[189] Fix | Delete

*/

[190] Fix | Delete

public function generate_product_data( $product = null ) {

[191] Fix | Delete

if ( ! is_object( $product ) ) {

[192] Fix | Delete

global $product;

[193] Fix | Delete

}

[194] Fix | Delete

[195] Fix | Delete

if ( ! is_a( $product, 'WC_Product' ) ) {

[196] Fix | Delete

return;

[197] Fix | Delete

}

[198] Fix | Delete

[199] Fix | Delete

$shop_name = get_bloginfo( 'name' );

[200] Fix | Delete

$shop_url = home_url();

[201] Fix | Delete

$currency = get_woocommerce_currency();

[202] Fix | Delete

$permalink = get_permalink( $product->get_id() );

[203] Fix | Delete

$image = wp_get_attachment_url( $product->get_image_id() );

[204] Fix | Delete

[205] Fix | Delete

$markup = array(

[206] Fix | Delete

'@type' => 'Product',

[207] Fix | Delete

'@id' => $permalink . '#product', // Append '#product' to differentiate between this @id and the @id generated for the Breadcrumblist.

[208] Fix | Delete

'name' => wp_kses_post( $product->get_name() ),

[209] Fix | Delete

'url' => $permalink,

[210] Fix | Delete

'description' => wp_strip_all_tags( do_shortcode( $product->get_short_description() ? $product->get_short_description() : $product->get_description() ) ),

[211] Fix | Delete

);

[212] Fix | Delete

[213] Fix | Delete

if ( $image ) {

[214] Fix | Delete

$markup['image'] = $image;

[215] Fix | Delete

}

[216] Fix | Delete

[217] Fix | Delete

// Declare SKU or fallback to ID.

[218] Fix | Delete

if ( $product->get_sku() ) {

[219] Fix | Delete

$markup['sku'] = $product->get_sku();

[220] Fix | Delete

} else {

[221] Fix | Delete

$markup['sku'] = $product->get_id();

[222] Fix | Delete

}

[223] Fix | Delete

[224] Fix | Delete

// Prepare GTIN and load it if it's valid.

[225] Fix | Delete

$gtin = $this->prepare_gtin( $product->get_global_unique_id() );

[226] Fix | Delete

if ( $this->is_valid_gtin( $gtin ) ) {

[227] Fix | Delete

$markup['gtin'] = $gtin;

[228] Fix | Delete

}

[229] Fix | Delete

[230] Fix | Delete

if ( '' !== $product->get_price() ) {

[231] Fix | Delete

// Assume prices will be valid until the end of next year, unless on sale and there is an end date.

[232] Fix | Delete

$price_valid_until = gmdate( 'Y-12-31', time() + YEAR_IN_SECONDS );

[233] Fix | Delete

[234] Fix | Delete

if ( $product->is_type( ProductType::VARIABLE ) ) {

[235] Fix | Delete

$lowest = $product->get_variation_price( 'min', false );

[236] Fix | Delete

$highest = $product->get_variation_price( 'max', false );

[237] Fix | Delete

[238] Fix | Delete

if ( $lowest === $highest ) {

[239] Fix | Delete

$markup_offer = array(

[240] Fix | Delete

'@type' => 'Offer',

[241] Fix | Delete

'priceSpecification' => array(

[242] Fix | Delete

array(

[243] Fix | Delete

'@type' => 'UnitPriceSpecification',

[244] Fix | Delete

'price' => wc_format_decimal( $lowest, wc_get_price_decimals() ),

[245] Fix | Delete

'priceCurrency' => $currency,

[246] Fix | Delete

'valueAddedTaxIncluded' => wc_prices_include_tax(),

[247] Fix | Delete

'validThrough' => $price_valid_until,

[248] Fix | Delete

),

[249] Fix | Delete

),

[250] Fix | Delete

);

[251] Fix | Delete

} else {

[252] Fix | Delete

$markup_offer = array(

[253] Fix | Delete

'@type' => 'AggregateOffer',

[254] Fix | Delete

'lowPrice' => wc_format_decimal( $lowest, wc_get_price_decimals() ),

[255] Fix | Delete

'highPrice' => wc_format_decimal( $highest, wc_get_price_decimals() ),

[256] Fix | Delete

'offerCount' => count( $product->get_children() ),

[257] Fix | Delete

);

[258] Fix | Delete

[259] Fix | Delete

if ( $product->is_on_sale() ) {

[260] Fix | Delete

$lowest_child_sale_price = $product->get_variation_sale_price( 'min', false );

[261] Fix | Delete

foreach ( $product->get_variation_prices()['sale_price'] as $variation_id => $variation_price ) {

[262] Fix | Delete

if ( $variation_price === $lowest_child_sale_price ) {

[263] Fix | Delete

break;

[264] Fix | Delete

}

[265] Fix | Delete

}

[266] Fix | Delete

$date_on_sale_to = isset( $variation_id )

[267] Fix | Delete

? wc_get_product( $variation_id )->get_date_on_sale_to()

[268] Fix | Delete

: null;

[269] Fix | Delete

$sale_price_valid_until = $date_on_sale_to

[270] Fix | Delete

? gmdate( 'Y-m-d', $date_on_sale_to->getTimestamp() )

[271] Fix | Delete

: null;

[272] Fix | Delete

[273] Fix | Delete

$markup_offer['priceSpecification'] = array(

[274] Fix | Delete

array(

[275] Fix | Delete

'@type' => 'UnitPriceSpecification',

[276] Fix | Delete

'priceType' => 'https://schema.org/SalePrice',

[277] Fix | Delete

'price' => wc_format_decimal( $lowest_child_sale_price, wc_get_price_decimals() ),

[278] Fix | Delete

'priceCurrency' => $currency,

[279] Fix | Delete

'valueAddedTaxIncluded' => wc_prices_include_tax(),

[280] Fix | Delete

'validThrough' => $sale_price_valid_until ?? $price_valid_until,

[281] Fix | Delete

),

[282] Fix | Delete

);

[283] Fix | Delete

}

[284] Fix | Delete

}

[285] Fix | Delete

} elseif ( $product->is_type( ProductType::GROUPED ) ) {

[286] Fix | Delete

$tax_display_mode = get_option( 'woocommerce_tax_display_shop' );

[287] Fix | Delete

$children = array_filter( array_map( 'wc_get_product', $product->get_children() ), 'wc_products_array_filter_visible_grouped' );

[288] Fix | Delete

$price_function = 'incl' === $tax_display_mode ? 'wc_get_price_including_tax' : 'wc_get_price_excluding_tax';

[289] Fix | Delete

[290] Fix | Delete

foreach ( $children as $child ) {

[291] Fix | Delete

if ( '' !== $child->get_regular_price() ) {

[292] Fix | Delete

$child_prices[] = $price_function( $child, array( 'price' => $child->get_regular_price() ) );

[293] Fix | Delete

}

[294] Fix | Delete

if ( '' !== $child->get_sale_price() ) {

[295] Fix | Delete

$child_sale_prices[] = $price_function( $child, array( 'price' => $child->get_sale_price() ) );

[296] Fix | Delete

}

[297] Fix | Delete

}

[298] Fix | Delete

if ( empty( $child_prices ) ) {

[299] Fix | Delete

$min_price = 0;

[300] Fix | Delete

} else {

[301] Fix | Delete

$min_price = min( $child_prices );

[302] Fix | Delete

}

[303] Fix | Delete

if ( empty( $child_sale_prices ) ) {

[304] Fix | Delete

$min_sale_price = 0;

[305] Fix | Delete

} else {

[306] Fix | Delete

$min_sale_price = min( $child_sale_prices );

[307] Fix | Delete

}

[308] Fix | Delete

[309] Fix | Delete

$unit_price_specification = array(

[310] Fix | Delete

'@type' => 'UnitPriceSpecification',

[311] Fix | Delete

'price' => wc_format_decimal( $min_price, wc_get_price_decimals() ),

[312] Fix | Delete

'priceCurrency' => $currency,

[313] Fix | Delete

'valueAddedTaxIncluded' => wc_prices_include_tax(),

[314] Fix | Delete

'validThrough' => $price_valid_until,

[315] Fix | Delete

);

[316] Fix | Delete

if ( $product->is_on_sale() && $min_price !== $min_sale_price ) {

[317] Fix | Delete

// `priceType` should only be specified in prices which are not the current offer.

[318] Fix | Delete

// https://developers.google.com/search/docs/appearance/structured-data/merchant-listing#sale-pricing-example

[319] Fix | Delete

$unit_price_specification['priceType'] = 'https://schema.org/ListPrice';

[320] Fix | Delete

}

[321] Fix | Delete

$markup_offer = array(

[322] Fix | Delete

'@type' => 'Offer',

[323] Fix | Delete

'priceSpecification' => array(

[324] Fix | Delete

$unit_price_specification,

[325] Fix | Delete

),

[326] Fix | Delete

);

[327] Fix | Delete

[328] Fix | Delete

if ( $product->is_on_sale() && $min_price !== $min_sale_price ) {

[329] Fix | Delete

if ( $product->get_date_on_sale_to() ) {

[330] Fix | Delete

$sale_price_valid_until = gmdate( 'Y-m-d', $product->get_date_on_sale_to()->getTimestamp() );

[331] Fix | Delete

}

[332] Fix | Delete

[333] Fix | Delete

// We add the sale price to the top of the array so it's the first offer.

[334] Fix | Delete

// See https://github.com/woocommerce/woocommerce/issues/55043.

[335] Fix | Delete

array_unshift(

[336] Fix | Delete

$markup_offer['priceSpecification'],

[337] Fix | Delete

array(

[338] Fix | Delete

'@type' => 'UnitPriceSpecification',

[339] Fix | Delete

'price' => wc_format_decimal( $min_sale_price, wc_get_price_decimals() ),

[340] Fix | Delete

'priceCurrency' => $currency,

[341] Fix | Delete

'valueAddedTaxIncluded' => wc_prices_include_tax(),

[342] Fix | Delete

'validThrough' => $sale_price_valid_until ?? $price_valid_until,

[343] Fix | Delete

)

[344] Fix | Delete

);

[345] Fix | Delete

}

[346] Fix | Delete

} else {

[347] Fix | Delete

$unit_price_specification = array(

[348] Fix | Delete

'@type' => 'UnitPriceSpecification',

[349] Fix | Delete

'price' => wc_format_decimal( $product->get_regular_price(), wc_get_price_decimals() ),

[350] Fix | Delete

'priceCurrency' => $currency,

[351] Fix | Delete

'valueAddedTaxIncluded' => wc_prices_include_tax(),

[352] Fix | Delete

'validThrough' => $price_valid_until,

[353] Fix | Delete

);

[354] Fix | Delete

if ( $product->is_on_sale() ) {

[355] Fix | Delete

// `priceType` should only be specified in prices which are not the current offer.

[356] Fix | Delete

// https://developers.google.com/search/docs/appearance/structured-data/merchant-listing#sale-pricing-example

[357] Fix | Delete

$unit_price_specification['priceType'] = 'https://schema.org/ListPrice';

[358] Fix | Delete

}

[359] Fix | Delete

$markup_offer = array(

[360] Fix | Delete

'@type' => 'Offer',

[361] Fix | Delete

'priceSpecification' => array(

[362] Fix | Delete

$unit_price_specification,

[363] Fix | Delete

),

[364] Fix | Delete

);

[365] Fix | Delete

[366] Fix | Delete

if ( $product->is_on_sale() ) {

[367] Fix | Delete

if ( $product->get_date_on_sale_to() ) {

[368] Fix | Delete

$sale_price_valid_until = gmdate( 'Y-m-d', $product->get_date_on_sale_to()->getTimestamp() );

[369] Fix | Delete

}

[370] Fix | Delete

[371] Fix | Delete

// We add the sale price to the top of the array so it's the first offer.

[372] Fix | Delete

// See https://github.com/woocommerce/woocommerce/issues/55043.

[373] Fix | Delete

array_unshift(

[374] Fix | Delete

$markup_offer['priceSpecification'],

[375] Fix | Delete

array(

[376] Fix | Delete

'@type' => 'UnitPriceSpecification',

[377] Fix | Delete

'price' => wc_format_decimal( $product->get_sale_price(), wc_get_price_decimals() ),

[378] Fix | Delete

'priceCurrency' => $currency,

[379] Fix | Delete

'valueAddedTaxIncluded' => wc_prices_include_tax(),

[380] Fix | Delete

'validThrough' => $sale_price_valid_until ?? $price_valid_until,

[381] Fix | Delete

)

[382] Fix | Delete

);

[383] Fix | Delete

}

[384] Fix | Delete

}

[385] Fix | Delete

[386] Fix | Delete

if ( $product->is_in_stock() ) {

[387] Fix | Delete

$stock_status_schema = ( ProductStockStatus::ON_BACKORDER === $product->get_stock_status() ) ? 'BackOrder' : 'InStock';

[388] Fix | Delete

} else {

[389] Fix | Delete

$stock_status_schema = 'OutOfStock';

[390] Fix | Delete

}

[391] Fix | Delete

[392] Fix | Delete

$markup_offer += array(

[393] Fix | Delete

'priceValidUntil' => $sale_price_valid_until ?? $price_valid_until,

[394] Fix | Delete

'availability' => 'http://schema.org/' . $stock_status_schema,

[395] Fix | Delete

'url' => $permalink,

[396] Fix | Delete

'seller' => array(

[397] Fix | Delete

'@type' => 'Organization',

[398] Fix | Delete

'name' => $shop_name,

[399] Fix | Delete

'url' => $shop_url,

[400] Fix | Delete

),

[401] Fix | Delete

);

[402] Fix | Delete

if (

[403] Fix | Delete

( ! empty( $markup_offer['price'] ) ||

[404] Fix | Delete

! empty( $markup_offer['lowPrice'] ) ||

[405] Fix | Delete

! empty( $markup_offer['highPrice'] )

[406] Fix | Delete

) && empty( $markup_offer['priceCurrency'] )

[407] Fix | Delete

) {

[408] Fix | Delete

$markup_offer['priceCurrency'] = $currency;

[409] Fix | Delete

}

[410] Fix | Delete

[411] Fix | Delete

$markup['offers'] = array( apply_filters( 'woocommerce_structured_data_product_offer', $markup_offer, $product ) );

[412] Fix | Delete

}

[413] Fix | Delete

[414] Fix | Delete

if ( $product->get_rating_count() && wc_review_ratings_enabled() ) {

[415] Fix | Delete

$markup['aggregateRating'] = array(

[416] Fix | Delete

'@type' => 'AggregateRating',

[417] Fix | Delete

'ratingValue' => $product->get_average_rating(),

[418] Fix | Delete

'reviewCount' => $product->get_review_count(),

[419] Fix | Delete

);

[420] Fix | Delete

[421] Fix | Delete

// Markup 5 most recent rating/review.

[422] Fix | Delete

$comments = get_comments(

[423] Fix | Delete

array(

[424] Fix | Delete

'number' => 5,

[425] Fix | Delete

'post_id' => $product->get_id(),

[426] Fix | Delete

'status' => 'approve',

[427] Fix | Delete

'post_status' => 'publish',

[428] Fix | Delete

'post_type' => 'product',

[429] Fix | Delete

'parent' => 0,

[430] Fix | Delete

'meta_query' => array( // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_query

[431] Fix | Delete

array(

[432] Fix | Delete

'key' => 'rating',

[433] Fix | Delete

'type' => 'NUMERIC',

[434] Fix | Delete

'compare' => '>',

[435] Fix | Delete

'value' => 0,

[436] Fix | Delete

),

[437] Fix | Delete

),

[438] Fix | Delete

)

[439] Fix | Delete

);

[440] Fix | Delete

[441] Fix | Delete

if ( $comments ) {

[442] Fix | Delete

$markup['review'] = array();

[443] Fix | Delete

foreach ( $comments as $comment ) {

[444] Fix | Delete

$markup['review'][] = array(

[445] Fix | Delete

'@type' => 'Review',

[446] Fix | Delete

'reviewRating' => array(

[447] Fix | Delete

'@type' => 'Rating',

[448] Fix | Delete

'bestRating' => '5',

[449] Fix | Delete

'ratingValue' => get_comment_meta( $comment->comment_ID, 'rating', true ),

[450] Fix | Delete

'worstRating' => '1',

[451] Fix | Delete

),

[452] Fix | Delete

'author' => array(

[453] Fix | Delete

'@type' => 'Person',

[454] Fix | Delete

'name' => get_comment_author( $comment ),

[455] Fix | Delete

),

[456] Fix | Delete

'reviewBody' => get_comment_text( $comment ),

[457] Fix | Delete

'datePublished' => get_comment_date( 'c', $comment ),

[458] Fix | Delete

);

[459] Fix | Delete

}

[460] Fix | Delete

}

[461] Fix | Delete

}

[462] Fix | Delete

[463] Fix | Delete

// Check we have required data.

[464] Fix | Delete

if ( empty( $markup['aggregateRating'] ) && empty( $markup['offers'] ) && empty( $markup['review'] ) ) {

[465] Fix | Delete

return;

[466] Fix | Delete

}

[467] Fix | Delete

[468] Fix | Delete

$this->set_data( apply_filters( 'woocommerce_structured_data_product', $markup, $product ) );

[469] Fix | Delete

}

[470] Fix | Delete

[471] Fix | Delete

/**

[472] Fix | Delete

* Generates Review structured data.

[473] Fix | Delete

*

[474] Fix | Delete

* Hooked into `woocommerce_review_meta` action hook.

[475] Fix | Delete

*

[476] Fix | Delete

* @param WP_Comment $comment Comment data.

[477] Fix | Delete

*/

[478] Fix | Delete

public function generate_review_data( $comment ) {

[479] Fix | Delete

$markup = array();

[480] Fix | Delete

$markup['@type'] = 'Review';

[481] Fix | Delete

$markup['@id'] = get_comment_link( $comment->comment_ID );

[482] Fix | Delete

$markup['datePublished'] = get_comment_date( 'c', $comment->comment_ID );

[483] Fix | Delete

$markup['description'] = get_comment_text( $comment->comment_ID );

[484] Fix | Delete

$markup['itemReviewed'] = array(

[485] Fix | Delete

'@type' => 'Product',

[486] Fix | Delete

'name' => get_the_title( $comment->comment_post_ID ),

[487] Fix | Delete

);

[488] Fix | Delete

[489] Fix | Delete

// Skip replies unless they have a rating.

[490] Fix | Delete

$rating = get_comment_meta( $comment->comment_ID, 'rating', true );

[491] Fix | Delete

[492] Fix | Delete

if ( $rating ) {

[493] Fix | Delete

$markup['reviewRating'] = array(

[494] Fix | Delete

'@type' => 'Rating',

[495] Fix | Delete

'bestRating' => '5',

[496] Fix | Delete

'ratingValue' => $rating,

[497] Fix | Delete

'worstRating' => '1',

[498] Fix | Delete

);

[499] Fix | Delete