Source: model/woocommerce.php

  1. <?php
  3. namespace wpbuddy\rich_snippets;
  5. if ( ! defined( 'ABSPATH' ) ) {
  6. 	exit;
  7. } // Exit if accessed directly
  10. /**
  11.  * Class WooCommerce_Model.
  12.  *
  13.  * Recognizes the WooCommerce plugin and provides new fields.
  14.  *
  15.  * @package wpbuddy\rich_snippets
  16.  *
  17.  * @since   2.2.0
  18.  */
  19. final class WooCommerce_Model {
  21. 	/**
  22. 	 * @param $values
  23. 	 *
  24. 	 * @return mixed
  25. 	 */
  26. 	public static function internal_subselect( $values ) {
  28. 		if ( ! function_exists( 'WC' ) ) {
  29. 			return $values;
  30. 		}
  32. 		$number_values = [];
  34. 		$values['http://schema.org/AggregateRating'][] = array(
  35. 			'id'     => 'woocommerce_rating',
  36. 			'label'  => esc_html_x( 'WooCommerce: Product Rating', 'subselect field', 'rich-snippets-schema' ),
  37. 			'method' => array( 'wpbuddy\rich_snippets\WooCommerce_Model', 'rating' ),
  38. 		);
  40. 		$values['http://schema.org/Rating'][] = array(
  41. 			'id'     => 'woocommerce_rating',
  42. 			'label'  => esc_html_x( 'WooCommerce: Product Rating', 'subselect field', 'rich-snippets-schema' ),
  43. 			'method' => array( 'wpbuddy\rich_snippets\WooCommerce_Model', 'rating' ),
  44. 		);
  46. 		$values['http://schema.org/AggregateRating'][] = array(
  47. 			'id'     => 'woocommerce_review_rating',
  48. 			'label'  => esc_html_x( 'WooCommerce: Product Review Rating', 'subselect field', 'rich-snippets-schema' ),
  49. 			'method' => array( 'wpbuddy\rich_snippets\WooCommerce_Model', 'review_rating' ),
  50. 		);
  52. 		$values['http://schema.org/Rating'][] = array(
  53. 			'id'     => 'woocommerce_review_rating',
  54. 			'label'  => esc_html_x( 'WooCommerce: Product Review Rating', 'subselect field', 'rich-snippets-schema' ),
  55. 			'method' => array( 'wpbuddy\rich_snippets\WooCommerce_Model', 'review_rating' ),
  56. 		);
  58. 		$values['http://schema.org/Text'][] = array(
  59. 			'id'     => 'woocommerce_sku',
  60. 			'label'  => esc_html_x( 'WooCommerce: Stock Keeping Unit', 'subselect field', 'rich-snippets-schema' ),
  61. 			'method' => array( 'wpbuddy\rich_snippets\WooCommerce_Model', 'sku' ),
  62. 		);
  64. 		$values['http://schema.org/Text'][] = array(
  65. 			'id'     => 'woocommerce_currency_code',
  66. 			'label'  => esc_html_x( 'WooCommerce: Currency Code', 'subselect field', 'rich-snippets-schema' ),
  67. 			'method' => array( 'wpbuddy\rich_snippets\WooCommerce_Model', 'currency_code' ),
  68. 		);
  70. 		$values['http://schema.org/Offer'][] = array(
  71. 			'id'     => 'woocommerce_offers',
  72. 			'label'  => esc_html_x( 'WooCommerce: Offers', 'subselect field', 'rich-snippets-schema' ),
  73. 			'method' => array( 'wpbuddy\rich_snippets\WooCommerce_Model', 'offers' ),
  74. 		);
  76. 		$number_values[] = array(
  77. 			'id'     => 'woocommerce_height',
  78. 			'label'  => esc_html_x( 'WooCommerce: Product Height', 'subselect field', 'rich-snippets-schema' ),
  79. 			'method' => array( 'wpbuddy\rich_snippets\WooCommerce_Model', 'height' ),
  80. 		);
  82. 		$number_values[] = array(
  83. 			'id'     => 'woocommerce_width',
  84. 			'label'  => esc_html_x( 'WooCommerce: Product Width', 'subselect field', 'rich-snippets-schema' ),
  85. 			'method' => array( 'wpbuddy\rich_snippets\WooCommerce_Model', 'width' ),
  86. 		);
  88. 		$number_values[] = array(
  89. 			'id'     => 'woocommerce_weight',
  90. 			'label'  => esc_html_x( 'WooCommerce: Product Weight', 'subselect field', 'rich-snippets-schema' ),
  91. 			'method' => array( 'wpbuddy\rich_snippets\WooCommerce_Model', 'weight' ),
  92. 		);
  94. 		$number_values[] = array(
  95. 			'id'     => 'textfield_woocommerce_product_attribute',
  96. 			'label'  => esc_html_x( 'WooCommerce: Product attribute', 'subselect field', 'rich-snippets-schema' ),
  97. 			'method' => array( 'wpbuddy\rich_snippets\WooCommerce_Model', 'attribute' ),
  98. 		);
  100. 		$number_values[] = $values['http://schema.org/URL'][] = array(
  101. 			'id'     => 'textfield_woocommerce_product_attribute',
  102. 			'label'  => esc_html_x( 'WooCommerce: Product attribute', 'subselect field', 'rich-snippets-schema' ),
  103. 			'method' => array( 'wpbuddy\rich_snippets\WooCommerce_Model', 'attribute' ),
  104. 		);
  106. 		$values['http://schema.org/Review'][] = array(
  107. 			'id'     => 'woocommerce_reviews',
  108. 			'label'  => esc_html_x( 'WooCommerce: Product reviews', 'subselect field', 'rich-snippets-schema' ),
  109. 			'method' => array( 'wpbuddy\rich_snippets\WooCommerce_Model', 'reviews' ),
  110. 		);
  112. 		$values['http://schema.org/Number'][] = array(
  113. 			'id'     => 'woocommerce_price',
  114. 			'label'  => esc_html_x( 'WooCommerce: Product Price', 'subselect field', 'rich-snippets-schema' ),
  115. 			'method' => array( 'wpbuddy\rich_snippets\WooCommerce_Model', 'price' ),
  116. 		);
  118. 		$values['http://schema.org/Number'][] = array(
  119. 			'id'     => 'woocommerce_sales_price',
  120. 			'label'  => esc_html_x( 'WooCommerce: Product Sales Price', 'subselect field', 'rich-snippets-schema' ),
  121. 			'method' => array( 'wpbuddy\rich_snippets\WooCommerce_Model', 'sales_price' ),
  122. 		);
  124. 		$values['http://schema.org/ItemAvailability'][] = array(
  125. 			'id'     => 'woocommerce_sales_price',
  126. 			'label'  => esc_html_x( 'WooCommerce: Availability', 'subselect field', 'rich-snippets-schema' ),
  127. 			'method' => array( 'wpbuddy\rich_snippets\WooCommerce_Model', 'availability' ),
  128. 		);
  130. 		$values['http://schema.org/Date'][] = array(
  131. 			'id'     => 'woocommerce_sales_end_date',
  132. 			'label'  => esc_html_x( 'WooCommerce: Sales End Date', 'subselect field', 'rich-snippets-schema' ),
  133. 			'method' => array( 'wpbuddy\rich_snippets\WooCommerce_Model', 'sales_end_date' ),
  134. 		);
  136. 		$values['http://schema.org/Date'][] = array(
  137. 			'id'     => 'woocommerce_sales_start_date',
  138. 			'label'  => esc_html_x( 'WooCommerce: Sales Start Date', 'subselect field', 'rich-snippets-schema' ),
  139. 			'method' => array( 'wpbuddy\rich_snippets\WooCommerce_Model', 'sales_start_date' ),
  140. 		);
  142. 		$values['http://schema.org/DateTime'][] = array(
  143. 			'id'     => 'woocommerce_sales_end_datetime',
  144. 			'label'  => esc_html_x( 'WooCommerce: Sales End Date and Time', 'subselect field', 'rich-snippets-schema' ),
  145. 			'method' => array( 'wpbuddy\rich_snippets\WooCommerce_Model', 'sales_end_datetime' ),
  146. 		);
  148. 		$values['http://schema.org/DateTime'][] = array(
  149. 			'id'     => 'woocommerce_sales_start_date',
  150. 			'label'  => esc_html_x( 'WooCommerce: Sales Start Date and Time', 'subselect field', 'rich-snippets-schema' ),
  151. 			'method' => array( 'wpbuddy\rich_snippets\WooCommerce_Model', 'sales_start_datetime' ),
  152. 		);
  154. 		$number_values[] = array(
  155. 			'id'     => 'woocommerce_stock_number',
  156. 			'label'  => esc_html_x( 'WooCommerce: Stock Number', 'subselect field', 'rich-snippets-schema' ),
  157. 			'method' => array( 'wpbuddy\rich_snippets\WooCommerce_Model', 'stock_number' ),
  158. 		);
  160. 		$values['http://schema.org/Text'][] = array(
  161. 			'id'     => 'woocommerce_weight_unit',
  162. 			'label'  => esc_html_x( 'WooCommerce: Weight Unit', 'subselect field', 'rich-snippets-schema' ),
  163. 			'method' => array( 'wpbuddy\rich_snippets\WooCommerce_Model', 'weight_unit' ),
  164. 		);
  166. 		$values['http://schema.org/Text'][] = $values['http://schema.org/Thing'][] = array(
  167. 			'id'     => 'textfield_woocommerce_product_attribute',
  168. 			'label'  => esc_html_x( 'WooCommerce: Product attribute', 'subselect field', 'rich-snippets-schema' ),
  169. 			'method' => array( 'wpbuddy\rich_snippets\WooCommerce_Model', 'attribute' ),
  170. 		);
  172. 		$values['http://schema.org/QuantitativeValue'] = array_merge( $values['http://schema.org/QuantitativeValue'], $number_values );
  173. 		$values['http://schema.org/Number']            = array_merge( $values['http://schema.org/Number'], $number_values );
  174. 		$values['http://schema.org/Integer']           = array_merge( $values['http://schema.org/Integer'], $number_values );
  176. 		return $values;
  177. 	}
  180. 	/**
  181. 	 * Returns the value of the current rating.
  182. 	 *
  183. 	 * @param                                     $val
  184. 	 * @param \wpbuddy\rich_snippets\Rich_Snippet $rich_snippet
  185. 	 * @param array $meta_info
  186. 	 *
  187. 	 * @return string
  188. 	 * @since 2.2.0
  189. 	 *
  190. 	 */
  191. 	public static function rating( $val, Rich_Snippet $rich_snippet, array $meta_info ) {
  193. 		$product = wc_get_product( $meta_info['current_post_id'] );
  195. 		if ( ! $product instanceof \WC_Product ) {
  196. 			$rating_value = 0;
  197. 			$rating_count = 0;
  198. 		} else {
  199. 			$rating_value = floatval( $product->get_average_rating( 'raw' ) );
  200. 			$rating_count = floatval( $product->get_rating_count( 'raw' ) );
  201. 		}
  203. 		# force SNIP to not include aggregateRating at all because there are no ratings
  204. 		# This is because rating_count cannot be zero for Googles Structured Data Tester
  205. 		if ( $rating_count <= 0 ) {
  206. 			return '';
  207. 		}
  209. 		$rating_snippet       = new Rich_Snippet();
  210. 		$rating_snippet->type = 'AggregateRating';
  213. 		$rating_snippet->set_props( array(
  214. 			array(
  215. 				'name'  => 'ratingCount',
  216. 				'value' => $rating_count,
  217. 			),
  218. 			array(
  219. 				'name'  => 'bestRating',
  220. 				'value' => 5,
  221. 			),
  222. 			array(
  223. 				'name'  => 'ratingValue',
  224. 				'value' => $rating_value,
  225. 			),
  226. 			array(
  227. 				'name'  => 'worstRating',
  228. 				'value' => $rating_count <= 0 ? 0 : 1, # worstRating must be 0 if ratingCount is 0
  229. 			),
  230. 		) );
  232. 		$rating_snippet->prepare_for_output();
  234. 		return $rating_snippet;
  235. 	}
  238. 	/**
  239. 	 * Returns the value of the current review rating.
  240. 	 *
  241. 	 * @param                                     $val
  242. 	 * @param \wpbuddy\rich_snippets\Rich_Snippet $rich_snippet
  243. 	 * @param array $meta_info
  244. 	 *
  245. 	 * @return string
  246. 	 * @since 2.6.0
  247. 	 *
  248. 	 */
  249. 	public static function review_rating( $val, Rich_Snippet $rich_snippet, array $meta_info ) {
  250. 		$product = wc_get_product( $meta_info['current_post_id'] );
  252. 		if ( ! $product instanceof \WC_Product ) {
  253. 			$rating_value = 0;
  254. 			$review_count = 0;
  255. 		} else {
  256. 			$rating_value = floatval( $product->get_average_rating( 'raw' ) );
  257. 			$review_count = floatval( $product->get_review_count( 'raw' ) );
  258. 		}
  260. 		# force SNIP to not include aggregateRating at all because there are no ratings
  261. 		# This is because review_count cannot be zero for Googles Structured Data Tester
  262. 		if ( $review_count <= 0 ) {
  263. 			return '';
  264. 		}
  266. 		$rating_snippet       = new Rich_Snippet();
  267. 		$rating_snippet->type = 'AggregateRating';
  269. 		$rating_snippet->set_props( array(
  270. 			array(
  271. 				'name'  => 'reviewCount',
  272. 				'value' => $review_count,
  273. 			),
  274. 			array(
  275. 				'name'  => 'bestRating',
  276. 				'value' => 5,
  277. 			),
  278. 			array(
  279. 				'name'  => 'ratingValue',
  280. 				'value' => $rating_value,
  281. 			),
  282. 			array(
  283. 				'name'  => 'worstRating',
  284. 				'value' => $review_count <= 0 ? 0 : 1, # worstRating must be 0 if ratingCount is 0
  285. 			),
  286. 		) );
  288. 		$rating_snippet->prepare_for_output();
  290. 		return $rating_snippet;
  291. 	}
  294. 	/**
  295. 	 * Returns the value of the current SKU.
  296. 	 *
  297. 	 * @param                                     $val
  298. 	 * @param \wpbuddy\rich_snippets\Rich_Snippet $rich_snippet
  299. 	 * @param array $meta_info
  300. 	 *
  301. 	 * @return string
  302. 	 * @since 2.2.0
  303. 	 *
  304. 	 */
  305. 	public static function sku( $val, Rich_Snippet $rich_snippet, array $meta_info ) {
  307. 		$product = wc_get_product( $meta_info['current_post_id'] );
  309. 		if ( $product instanceof \WC_Product || is_subclass_of( $product, 'WC_Product', false ) ) {
  310. 			return (string) $product->get_sku( 'raw' );
  311. 		}
  313. 		return '';
  314. 	}
  317. 	/**
  318. 	 * Returns the weight unit.
  319. 	 *
  320. 	 * @param                                     $val
  321. 	 * @param Rich_Snippet $rich_snippet
  322. 	 * @param array $meta_info
  323. 	 *
  324. 	 * @return string
  325. 	 * @since 2.11.0
  326. 	 *
  327. 	 */
  328. 	public static function weight_unit( $val, Rich_Snippet $rich_snippet, array $meta_info ) {
  330. 		return (string) get_option( 'woocommerce_weight_unit' );
  331. 	}
  334. 	/**
  335. 	 * Returns the products end sales date.
  336. 	 *
  337. 	 * @param                                     $val
  338. 	 * @param \wpbuddy\rich_snippets\Rich_Snippet $rich_snippet
  339. 	 * @param array $meta_info
  340. 	 *
  341. 	 * @return string
  342. 	 * @since 2.11.0
  343. 	 *
  344. 	 */
  345. 	public static function sales_end_date( $val, Rich_Snippet $rich_snippet, array $meta_info ) {
  347. 		$product = wc_get_product( $meta_info['current_post_id'] );
  349. 		$not_on_sale_time = (string) date_i18n( 'Y-m-d', strtotime( 'NOW + 1 year' ) );
  351. 		if ( $product instanceof \WC_Product || is_subclass_of( $product, 'WC_Product', false ) ) {
  352. 			if ( $product->is_on_sale() && $product->get_date_on_sale_to() ) {
  353. 				return date_i18n( 'Y-m-d', $product->get_date_on_sale_to()->getTimestamp() );
  354. 			}
  355. 		}
  357. 		return $not_on_sale_time;
  358. 	}
  361. 	/**
  362. 	 * Returns the products end sales datetime.
  363. 	 *
  364. 	 * @param                                     $val
  365. 	 * @param \wpbuddy\rich_snippets\Rich_Snippet $rich_snippet
  366. 	 * @param array $meta_info
  367. 	 *
  368. 	 * @return string
  369. 	 * @since 2.11.0
  370. 	 *
  371. 	 */
  372. 	public static function sales_end_datetime( $val, Rich_Snippet $rich_snippet, array $meta_info ) {
  374. 		return date_i18n( 'c', strtotime( self::sales_end_date( $val, $rich_snippet, $meta_info ) ) );
  375. 	}
  378. 	/**
  379. 	 * Returns the products start sales date.
  380. 	 *
  381. 	 * @param                                     $val
  382. 	 * @param \wpbuddy\rich_snippets\Rich_Snippet $rich_snippet
  383. 	 * @param array $meta_info
  384. 	 *
  385. 	 * @return string
  386. 	 * @since 2.11.0
  387. 	 *
  388. 	 */
  389. 	public static function sales_start_date( $val, Rich_Snippet $rich_snippet, array $meta_info ) {
  391. 		$product = wc_get_product( $meta_info['current_post_id'] );
  393. 		$not_on_sale_time = (string) date_i18n( 'Y-m-d', strtotime( 'NOW - 1 DAY' ) );
  395. 		if ( $product instanceof \WC_Product || is_subclass_of( $product, 'WC_Product', false ) ) {
  396. 			if ( $product->is_on_sale() && $product->get_date_on_sale_from() ) {
  397. 				return date_i18n( 'Y-m-d', $product->get_date_on_sale_from()->getTimestamp() );
  398. 			}
  399. 		}
  401. 		return $not_on_sale_time;
  402. 	}
  405. 	/**
  406. 	 * Returns the products start sales date and time.
  407. 	 *
  408. 	 * @param                                     $val
  409. 	 * @param \wpbuddy\rich_snippets\Rich_Snippet $rich_snippet
  410. 	 * @param array $meta_info
  411. 	 *
  412. 	 * @return string
  413. 	 * @since 2.11.0
  414. 	 *
  415. 	 */
  416. 	public static function sales_start_datetime( $val, Rich_Snippet $rich_snippet, array $meta_info ) {
  418. 		return date_i18n( 'c', strtotime( self::sales_start_date( $val, $rich_snippet, $meta_info ) ) );
  419. 	}
  422. 	/**
  423. 	 * Returns the value of the current product price
  424. 	 *
  425. 	 * @param                                     $val
  426. 	 * @param Rich_Snippet $rich_snippet
  427. 	 * @param array $meta_info
  428. 	 *
  429. 	 * @return float|string
  430. 	 * @since 2.11.0
  431. 	 *
  432. 	 */
  433. 	public static function price( $val, Rich_Snippet $rich_snippet, array $meta_info ) {
  435. 		$product = wc_get_product( $meta_info['current_post_id'] );
  437. 		if ( $product instanceof \WC_Product || is_subclass_of( $product, 'WC_Product', false ) ) {
  438. 			return number_format( floatval( $product->get_price( 'edit' ) ), 2, '.', '' );
  439. 		}
  441. 		return '';
  442. 	}
  445. 	/**
  446. 	 * Returns the value of the current products availability.
  447. 	 *
  448. 	 * @param                                     $val
  449. 	 * @param Rich_Snippet $rich_snippet
  450. 	 * @param array $meta_info
  451. 	 *
  452. 	 * @return float|string
  453. 	 * @since 2.11.0
  454. 	 */
  455. 	public static function availability( $val, Rich_Snippet $rich_snippet, array $meta_info ) {
  457. 		return self::get_availability( intval( $meta_info['current_post_id'] ) );
  458. 	}
  461. 	/**
  462. 	 * @param int $product_id
  463. 	 *
  464. 	 * @return string
  465. 	 * @since 2.15.2
  466. 	 */
  467. 	public static function get_availability( int $product_id ): string {
  468. 		$product = wc_get_product( $product_id );
  470. 		if ( $product instanceof \WC_Product || is_subclass_of( $product, 'WC_Product', false ) ) {
  472. 			switch ( $product->get_stock_status() ) {
  473. 				case 'onbackorder':
  474. 					return 'https://schema.org/PreOrder';
  475. 				case 'instock':
  476. 					$stock_quantity = $product->get_stock_quantity( 'edit' );
  478. 					if ( function_exists( 'wc_get_low_stock_amount' ) ) {
  479. 						$low_stock_amount = intval( wc_get_low_stock_amount( $product ) );
  481. 						if ( $stock_quantity <= $low_stock_amount ) {
  482. 							if ( (bool) get_option( 'wpb_rs/setting/wc_availability_use_preorder', false ) ) {
  483. 								return 'https://schema.org/PreOrder';
  484. 							} else {
  485. 								return 'https://schema.org/LimitedAvailability';
  486. 							}
  487. 						}
  488. 					}
  490. 					return 'http://schema.org/InStock';
  491. 				case 'outofstock':
  492. 					return 'http://schema.org/OutOfStock';
  493. 			}
  494. 		}
  496. 		return '';
  497. 	}
  499. 	/**
  500. 	 * Returns the value of the current product sales price.
  501. 	 *
  502. 	 * @param                                     $val
  503. 	 * @param Rich_Snippet $rich_snippet
  504. 	 * @param array $meta_info
  505. 	 *
  506. 	 * @return float|string
  507. 	 * @since 2.11.0
  508. 	 *
  509. 	 */
  510. 	public static function sales_price( $val, Rich_Snippet $rich_snippet, array $meta_info ) {
  512. 		$product = wc_get_product( $meta_info['current_post_id'] );
  514. 		if ( $product instanceof \WC_Product || is_subclass_of( $product, 'WC_Product', false ) ) {
  515. 			return number_format( floatval( $product->get_sale_price( 'edit' ) ), 2, '.', '' );
  516. 		}
  518. 		return '';
  519. 	}
  522. 	/**
  523. 	 * Returns the value of the stock number.
  524. 	 *
  525. 	 * @param                                     $val
  526. 	 * @param Rich_Snippet $rich_snippet
  527. 	 * @param array $meta_info
  528. 	 *
  529. 	 * @return \stdClass
  530. 	 * @since 2.11.0
  531. 	 *
  532. 	 */
  533. 	public static function stock_number( $val, Rich_Snippet $rich_snippet, array $meta_info ) {
  535. 		$product = wc_get_product( $meta_info['current_post_id'] );
  537. 		if ( $product instanceof \WC_Product || is_subclass_of( $product, 'WC_Product', false ) ) {
  538. 			$stock = $product->get_manage_stock( 'edit' );
  540. 			$obj               = new \stdClass();
  541. 			$obj->{'@context'} = 'http://schema.org';
  542. 			$obj->{'@type'}    = 'Offer';
  543. 			$obj->value        = $stock;
  545. 			return $obj;
  546. 		}
  548. 		return new \stdClass();
  549. 	}
  552. 	/**
  553. 	 * Returns the currency code.
  554. 	 *
  555. 	 * @param                                     $val
  556. 	 * @param Rich_Snippet $rich_snippet
  557. 	 * @param array $meta_info
  558. 	 *
  559. 	 * @return float|string
  560. 	 * @since 2.11.0
  561. 	 *
  562. 	 */
  563. 	public static function currency_code( $val, Rich_Snippet $rich_snippet, array $meta_info ) {
  564. 		return get_woocommerce_currency();
  565. 	}
  568. 	/**
  569. 	 * Returns the offer for a WooCommerce product.
  570. 	 *
  571. 	 * @param int $post_id
  572. 	 *
  573. 	 * @return \stdClass
  574. 	 * @since 2.2.0
  575. 	 *
  576. 	 */
  577. 	private static function offer( $post_id ) {
  579. 		/**
  580. 		 * @var \WC_Product_Variation
  581. 		 */
  582. 		$product = wc_get_product( $post_id );
  584. 		if ( ! ( $product instanceof \WC_Product || is_subclass_of( $product, 'WC_Product', false ) ) ) {
  585. 			return new \stdClass();
  586. 		}
  588. 		$obj                = new \stdClass();
  589. 		$obj->{'@context'}  = 'http://schema.org';
  590. 		$obj->{'@type'}     = 'Offer';
  591. 		$obj->availability  = self::get_availability( intval( $post_id ) );
  592. 		$obj->priceCurrency = get_woocommerce_currency();
  593. 		$obj->price         = wc_format_decimal( $product->get_price(), wc_get_price_decimals() );
  594. 		$obj->url           = $product->get_permalink();
  596. 		$sale_date = $product->get_date_on_sale_to( 'raw' );
  598. 		if ( ! $sale_date instanceof \DateTime ) {
  599. 			# If there is no sales date create a fake date to avoid Googles warnings
  600. 			# @see https://rich-snippets.io/offers-pricevaliduntil-recommended/
  601. 			$obj->priceValidUntil = (string) date_i18n( 'c', strtotime( 'NOW + 1 year' ) );
  602. 		} else {
  603. 			$obj->priceValidUntil = $sale_date->date( 'c' );
  604. 		}
  606. 		return $obj;
  607. 	}
  609. 	/**
  610. 	 * Returns a snippet of all offers.
  611. 	 *
  612. 	 * @param                                     $val
  613. 	 * @param \wpbuddy\rich_snippets\Rich_Snippet $rich_snippet
  614. 	 * @param array $meta_info
  615. 	 *
  616. 	 * @return \stdClass
  617. 	 *
  618. 	 * @since 2.2.0
  619. 	 */
  620. 	public static function offers( $val, Rich_Snippet $rich_snippet, array $meta_info ) {
  622. 		$product = wc_get_product( $meta_info['current_post_id'] );
  624. 		if ( $product instanceof \WC_Product_Variable ) {
  625. 			$lowest  = $product->get_variation_price( 'min', false );
  626. 			$highest = $product->get_variation_price( 'max', false );
  628. 			if ( $lowest === $highest ) {
  629. 				return self::offer( $meta_info['current_post_id'] );
  630. 			} else {
  631. 				$obj                = new \stdClass();
  632. 				$obj->{'@context'}  = 'http://schema.org';
  633. 				$obj->{'@type'}     = 'AggregateOffer';
  634. 				$obj->lowPrice      = wc_format_decimal( $lowest, wc_get_price_decimals() );
  635. 				$obj->highPrice     = wc_format_decimal( $highest, wc_get_price_decimals() );
  636. 				$obj->priceCurrency = get_woocommerce_currency();
  637. 				$obj->offerCount    = count( $product->get_children() );
  638. 				$obj->url           = $product->get_permalink();
  640. 				return $obj;
  641. 			}
  643. 		} elseif ( $product instanceof \WC_Product ) {
  644. 			return self::offer( $meta_info['current_post_id'] );
  645. 		}
  647. 		return new \stdClass();
  648. 	}
  651. 	/**
  652. 	 * Returns the height of a product.
  653. 	 *
  654. 	 * @param                                     $val
  655. 	 * @param \wpbuddy\rich_snippets\Rich_Snippet $rich_snippet
  656. 	 * @param array $meta_info
  657. 	 *
  658. 	 * @return \stdClass
  659. 	 * @since 2.2.0
  660. 	 *
  661. 	 */
  662. 	public static function height( $val, Rich_Snippet $rich_snippet, array $meta_info ) {
  664. 		return self::get_product_quantitive_snippet( $meta_info['current_post_id'], 'height' );
  665. 	}
  668. 	/**
  669. 	 * Returns the width of a product.
  670. 	 *
  671. 	 * @param                                     $val
  672. 	 * @param \wpbuddy\rich_snippets\Rich_Snippet $rich_snippet
  673. 	 * @param array $meta_info
  674. 	 *
  675. 	 * @return \stdClass
  676. 	 * @since 2.2.0
  677. 	 *
  678. 	 */
  679. 	public static function width( $val, Rich_Snippet $rich_snippet, array $meta_info ) {
  681. 		return self::get_product_quantitive_snippet( $meta_info['current_post_id'], 'width' );
  682. 	}
  685. 	/**
  686. 	 * Get WooCommerce product dimension as a snippet.
  687. 	 *
  688. 	 * @param int $product_id
  689. 	 * @param string $prop width|height|weight
  690. 	 *
  691. 	 * since 2.2.0
  692. 	 *
  693. 	 * @return \stdClass
  694. 	 */
  695. 	private static function get_product_quantitive_snippet( $product_id, $prop ) {
  697. 		$product = wc_get_product( $product_id );
  699. 		$item = new \stdClass();
  701. 		if ( ! is_subclass_of( $product, 'WC_Data', false ) ) {
  702. 			return $item;
  703. 		}
  705. 		$item->{'@context'} = 'http://schema.org';
  706. 		$item->{'@type'}    = 'QuantitativeValue';
  707. 		$item->value        = method_exists( $product, 'get_' . $prop ) ? $product->{'get_' . $prop}() : '';
  708. 		$item->value        = floatval( $item->value );
  709. 		$item->unitCode     = 'weight' === $prop ? get_option( 'woocommerce_weight_unit' ) : get_option( 'woocommerce_dimension_unit' );
  711. 		return $item;
  712. 	}
  715. 	/**
  716. 	 * Returns the eight of a product.
  717. 	 *
  718. 	 * @param                                     $val
  719. 	 * @param \wpbuddy\rich_snippets\Rich_Snippet $rich_snippet
  720. 	 * @param array $meta_info
  721. 	 *
  722. 	 * @return \stdClass
  723. 	 * @since 2.2.0
  724. 	 *
  725. 	 */
  726. 	public static function weight( $val, Rich_Snippet $rich_snippet, array $meta_info ) {
  728. 		return self::get_product_quantitive_snippet( $meta_info['current_post_id'], 'weight' );
  729. 	}
  732. 	/**
  733. 	 * Reads a product attribute from WooCommerce (serialized data).
  734. 	 *
  735. 	 * @param              $val
  736. 	 * @param Rich_Snippet $rich_snippet
  737. 	 * @param array $meta_info
  738. 	 *
  739. 	 * @return string
  740. 	 * @since 2.5.0
  741. 	 *
  742. 	 */
  743. 	public static function attribute( $val, Rich_Snippet $rich_snippet, array $meta_info ) {
  744. 		if ( ! function_exists( '\wc_get_product' ) ) {
  745. 			return '';
  746. 		}
  748. 		if ( ! is_scalar( $val ) ) {
  749. 			return '';
  750. 		}
  752. 		if ( empty( $val ) ) {
  753. 			return '';
  754. 		}
  756. 		$product = \wc_get_product( $meta_info['current_post_id'] );
  758. 		if ( $product instanceof \WC_Product || is_subclass_of( $product, 'WC_Product', false ) ) {
  759. 			return $product->get_attribute( $val );
  760. 		}
  762. 		return '';
  763. 	}
  766. 	/**
  767. 	 * Outputs product reviews from WooCommerce.
  768. 	 *
  769. 	 * @param              $val
  770. 	 * @param Rich_Snippet $rich_snippet
  771. 	 * @param array $meta_info
  772. 	 *
  773. 	 * @return \stdClass[]
  774. 	 * @since 2.7.0
  775. 	 *
  776. 	 */
  777. 	public static function reviews( $val, Rich_Snippet $rich_snippet, array $meta_info ): array {
  779. 		if ( ! function_exists( '\wc_get_product' ) ) {
  780. 			return [];
  781. 		}
  783. 		/**
  784. 		 * @var \WP_Comment[] $comments
  785. 		 */
  787. 		$args = [
  788. 			'post_id'            => $meta_info['current_post_id'],
  789. 			'include_unapproved' => false,
  790. 			'number'             => 5,
  791. 			'type'               => 'review',
  792. 			'meta_query'         => array(
  793. 				'city_clause' => array(
  794. 					'key'     => 'rating',
  795. 					'compare' => 'EXISTS',
  796. 				),
  797. 			),
  798. 		];
  801. 		/**
  802. 		 * Get comments filter for WooCommerce products.
  803. 		 *
  804. 		 * Allows to filter the comment arguments when WooCommerce product comments are loaded.
  805. 		 *
  806. 		 * @hook  wpbuddy/rich_snippets/woocommerce/reviews/args
  807. 		 *
  808. 		 * @param {array} $args The arguments.
  809. 		 * @returns {array} The modified arguments.
  810. 		 *
  811. 		 * @since 2.7.0
  812. 		 */
  813. 		$comments = get_comments( apply_filters( 'wpbuddy/rich_snippets/woocommerce/reviews/args', $args ) );
  815. 		if ( ! is_array( $comments ) || count( $comments ) <= 0 ) {
  816. 			return [];
  817. 		}
  819. 		$reviews = [];
  821. 		foreach ( $comments as $comment ) {
  822. 			$review               = new \stdClass();
  823. 			$review->{'@context'} = 'http://schema.org';
  824. 			$review->{'@type'}    = 'Review';
  826. 			$review->author               = new \stdClass();
  827. 			$review->author->{'@context'} = 'http://schema.org';
  828. 			$review->author->{'@type'}    = 'Person';
  829. 			$review->author->name         = $comment->comment_author;
  831. 			$review->reviewRating               = new \stdClass();
  832. 			$review->reviewRating->{'@context'} = 'http://schema.org';
  833. 			$review->reviewRating->{'@type'}    = 'Rating';
  834. 			$review->reviewRating->bestRating   = 5;
  835. 			$review->reviewRating->worstRating  = 1;
  836. 			$review->reviewRating->ratingValue  = max( 1, absint( get_comment_meta( $comment->comment_ID, 'rating', true ) ) );
  838. 			$review->reviewBody    = strip_tags( $comment->comment_content );
  839. 			$review->datePublished = date_i18n( 'c', strtotime( $comment->comment_date ) );
  841. 			$reviews[] = $review;
  842. 		}
  844. 		return $reviews;
  845. 	}
  848. 	/**
  849. 	 * Adds new loop fields to the dropdown.
  850. 	 *
  851. 	 * @param array $values
  852. 	 *
  853. 	 * @return array
  854. 	 * @since 2.12.0
  855. 	 *
  856. 	 */
  857. 	public static function wc_loop_fields( $values ) {
  858. 		if ( function_exists( 'WC' ) ) {
  859. 			$values['variable_products'] = __( 'Variable products (WooCommerce)', 'rich-snippets-schema' );
  860. 		}
  862. 		return $values;
  863. 	}
  866. 	/**
  867. 	 * Returns the loop items.
  868. 	 *
  869. 	 * @param array $items
  870. 	 * @param Rich_Snippet $snippet
  871. 	 * @param int $post_id
  872. 	 *
  873. 	 * @return array
  874. 	 * @since 2.12.0
  875. 	 *
  876. 	 */
  877. 	public static function loop_items( $items, $snippet, $post_id ) {
  878. 		if ( ! function_exists( 'WC' ) ) {
  879. 			return $items;
  880. 		}
  882. 		if ( 'variable_products' !== $snippet->get_loop_type() ) {
  883. 			return $items;
  884. 		}
  886. 		$product = wc_get_product( $post_id );
  888. 		if ( $product instanceof \WC_Product_Simple ) {
  889. 			return [
  890. 				$product->get_id() => $product
  891. 			];
  892. 		}
  894. 		if ( $product instanceof \WC_Product_Variable || $product instanceof \WC_Product_Grouped ) {
  895. 			$ids = $product->get_children();
  897. 			if ( empty( $ids ) ) {
  898. 				return $items;
  899. 			}
  901. 			$products = get_posts( [
  902. 				'include'   => $ids,
  903. 				'post_type' => [ 'product_variation', 'product' ]
  904. 			] );
  906. 			if ( ! is_array( $products ) ) {
  907. 				return $items;
  908. 			}
  910. 			if ( count( $products ) <= 0 ) {
  911. 				return $items;
  912. 			}
  914. 			$products = array_combine( wp_list_pluck( $products, 'ID' ), $products );
  916. 			return $products;
  917. 		}
  919. 		return $items;
  920. 	}
  921. }