class-wc-structured-data.php — WooCommerce 3.0.3

woocommerce / includes / class-wc-structured-data.php

woocommerce / includes Last commit date

class-wc-structured-data.php

440 lines

1	<?php
2
3	if ( ! defined( 'ABSPATH' ) ) {
4	exit; // Exit if accessed directly.
5	}
6
7	/**
8	* Structured data's handler and generator using JSON-LD format.
9	*
10	* @class WC_Structured_Data
11	* @since 3.0.0
12	* @version 3.0.0
13	* @package WooCommerce/Classes
14	* @author Clément Cazaud <opportus@gmail.com>
15	*/
16	class WC_Structured_Data {
17
18	/**
19	* @var array $_data
20	*/
21	private $_data = array();
22
23	/**
24	* Constructor.
25	*/
26	public function __construct() {
27	// Generate structured data.
28	add_action( 'woocommerce_before_main_content', array( $this, 'generate_website_data' ), 30 );
29	add_action( 'woocommerce_breadcrumb', array( $this, 'generate_breadcrumblist_data' ), 10 );
30	add_action( 'woocommerce_shop_loop', array( $this, 'generate_product_data' ), 10 );
31	add_action( 'woocommerce_single_product_summary', array( $this, 'generate_product_data' ), 60 );
32	add_action( 'woocommerce_review_meta', array( $this, 'generate_review_data' ), 20 );
33	add_action( 'woocommerce_email_order_details', array( $this, 'generate_order_data' ), 20, 3 );
34
35	// Output structured data.
36	add_action( 'woocommerce_email_order_details', array( $this, 'output_email_structured_data' ), 30, 3 );
37	add_action( 'wp_footer', array( $this, 'output_structured_data' ), 10 );
38	}
39
40	/**
41	* Sets data.
42	*
43	* @param array $data Structured data.
44	* @param bool $reset Unset data (default: false).
45	* @return bool
46	*/
47	public function set_data( $data, $reset = false ) {
48	if ( ! isset( $data['@type'] ) \|\| ! preg_match( '\|^[a-zA-Z]{1,20}$\|', $data['@type'] ) ) {
49	return false;
50	}
51
52	if ( $reset && isset( $this->_data ) ) {
53	unset( $this->_data );
54	}
55
56	$this->_data[] = $data;
57
58	return true;
59	}
60
61	/**
62	* Gets data.
63	*
64	* @return array
65	*/
66	public function get_data() {
67	return $this->_data;
68	}
69
70	/**
71	* Structures and returns data.
72	*
73	* List of types available by default for specific request:
74	*
75	* 'product',
76	* 'review',
77	* 'breadcrumblist',
78	* 'website',
79	* 'order',
80	*
81	* @param array $types Structured data types.
82	* @return array
83	*/
84	public function get_structured_data( $types ) {
85	$data = array();
86
87	// Put together the values of same type of structured data.
88	foreach ( $this->get_data() as $value ) {
89	$data[ strtolower( $value['@type'] ) ][] = $value;
90	}
91
92	// Wrap the multiple values of each type inside a graph... Then add context to each type.
93	foreach ( $data as $type => $value ) {
94	$data[ $type ] = count( $value ) > 1 ? array( '@graph' => $value ) : $value[0];
95	$data[ $type ] = apply_filters( 'woocommerce_structured_data_context', array( '@context' => 'http://schema.org/' ), $data, $type, $value ) + $data[ $type ];
96	}
97
98	// If requested types, pick them up... Finally change the associative array to an indexed one.
99	$data = $types ? array_values( array_intersect_key( $data, array_flip( $types ) ) ) : array_values( $data );
100
101	if ( ! empty( $data ) ) {
102	$data = count( $data ) > 1 ? array( '@graph' => $data ) : $data[0];
103	}
104
105	return $data;
106	}
107
108	/**
109	* Get data types for pages.
110	*
111	* @return array
112	*/
113	protected function get_data_type_for_page() {
114	$types = array();
115	$types[] = is_shop() \|\| is_product_category() \|\| is_product() ? 'product' : '';
116	$types[] = is_shop() && is_front_page() ? 'website' : '';
117	$types[] = is_product() ? 'review' : '';
118	$types[] = ! is_shop() ? 'breadcrumblist' : '';
119	$types[] = 'order';
120
121	return array_filter( apply_filters( 'woocommerce_structured_data_type_for_page', $types ) );
122	}
123
124	/**
125	* Makes sure email structured data only outputs on non-plain text versions.
126	*
127	* @param WP_Order $order Order data.
128	* @param bool $sent_to_admin Send to admin (default: false).
129	* @param bool $plain_text Plain text email (default: false).
130	*/
131	public function output_email_structured_data( $order, $sent_to_admin = false, $plain_text = false ) {
132	if ( $plain_text ) {
133	return;
134	}
135	echo '<div style="display: none; font-size: 0; max-height: 0; line-height: 0; padding: 0; mso-hide: all;">';
136	$this->output_structured_data();
137	echo '</div>';
138	}
139
140	/**
141	* Sanitizes, encodes and outputs structured data.
142	*
143	* Hooked into `wp_footer` action hook.
144	* Hooked into `woocommerce_email_order_details` action hook.
145	*/
146	public function output_structured_data() {
147	$types = $this->get_data_type_for_page();
148
149	if ( $data = wc_clean( $this->get_structured_data( $types ) ) ) {
150	echo '<script type="application/ld+json">' . wp_json_encode( $data ) . '</script>';
151	}
152	}
153
154	/*
155	\|--------------------------------------------------------------------------
156	\| Generators
157	\|--------------------------------------------------------------------------
158	\|
159	\| Methods for generating specific structured data types:
160	\|
161	\| - Product
162	\| - Review
163	\| - BreadcrumbList
164	\| - WebSite
165	\| - Order
166	\|
167	\| The generated data is stored into `$this->_data`.
168	\| See the methods above for handling `$this->_data`.
169	\|
170	*/
171
172	/**
173	* Generates Product structured data.
174	*
175	* Hooked into `woocommerce_single_product_summary` action hook.
176	* Hooked into `woocommerce_shop_loop` action hook.
177	*
178	* @param WC_Product $product Product data (default: null).
179	*/
180	public function generate_product_data( $product = null ) {
181	if ( ! is_object( $product ) ) {
182	global $product;
183	}
184
185	if ( ! is_a( $product, 'WC_Product' ) ) {
186	return;
187	}
188
189	$shop_name = get_bloginfo( 'name' );
190	$shop_url = home_url();
191	$currency = get_woocommerce_currency();
192	$markup = array();
193	$markup['@type'] = 'Product';
194	$markup['@id'] = get_permalink( $product->get_id() );
195	$markup['url'] = $markup['@id'];
196	$markup['name'] = $product->get_name();
197
198	if ( apply_filters( 'woocommerce_structured_data_product_limit', is_product_taxonomy() \|\| is_shop() ) ) {
199	$this->set_data( apply_filters( 'woocommerce_structured_data_product_limited', $markup, $product ) );
200	return;
201	}
202
203	$markup_offer = array(
204	'@type' => 'Offer',
205	'priceCurrency' => $currency,
206	'availability' => 'http://schema.org/' . $stock = ( $product->is_in_stock() ? 'InStock' : 'OutOfStock' ),
207	'sku' => $product->get_sku(),
208	'image' => wp_get_attachment_url( $product->get_image_id() ),
209	'description' => $product->get_description(),
210	'seller' => array(
211	'@type' => 'Organization',
212	'name' => $shop_name,
213	'url' => $shop_url,
214	),
215	);
216
217	if ( $product->is_type( 'variable' ) ) {
218	$prices = $product->get_variation_prices();
219
220	$markup_offer['priceSpecification'] = array(
221	'price' => wc_format_decimal( $product->get_price(), wc_get_price_decimals() ),
222	'minPrice' => wc_format_decimal( current( $prices['price'] ), wc_get_price_decimals() ),
223	'maxPrice' => wc_format_decimal( end( $prices['price'] ), wc_get_price_decimals() ),
224	'priceCurrency' => $currency,
225	);
226	} else {
227	$markup_offer['price'] = wc_format_decimal( $product->get_price(), wc_get_price_decimals() );
228	}
229
230	$markup['offers'] = array( apply_filters( 'woocommerce_structured_data_product_offer', $markup_offer, $product ) );
231
232	if ( $product->get_rating_count() ) {
233	$markup['aggregateRating'] = array(
234	'@type' => 'AggregateRating',
235	'ratingValue' => $product->get_average_rating(),
236	'ratingCount' => $product->get_rating_count(),
237	'reviewCount' => $product->get_review_count(),
238	);
239	}
240
241	$this->set_data( apply_filters( 'woocommerce_structured_data_product', $markup, $product ) );
242	}
243
244	/**
245	* Generates Review structured data.
246	*
247	* Hooked into `woocommerce_review_meta` action hook.
248	*
249	* @param WP_Comment $comment Comment data.
250	*/
251	public function generate_review_data( $comment ) {
252	$markup = array();
253	$markup['@type'] = 'Review';
254	$markup['@id'] = get_comment_link( $comment->comment_ID );
255	$markup['datePublished'] = get_comment_date( 'c', $comment->comment_ID );
256	$markup['description'] = get_comment_text( $comment->comment_ID );
257	$markup['itemReviewed'] = array(
258	'@type' => 'Product',
259	'name' => get_the_title( $comment->post_ID ),
260	);
261	if ( $rating = get_comment_meta( $comment->comment_ID, 'rating', true ) ) {
262	$markup['reviewRating'] = array(
263	'@type' => 'rating',
264	'ratingValue' => $rating,
265	);
266
267	// Skip replies unless they have a rating.
268	} elseif ( $comment->comment_parent ) {
269	return;
270	}
271
272	$markup['author'] = array(
273	'@type' => 'Person',
274	'name' => get_comment_author( $comment->comment_ID ),
275	);
276
277	$this->set_data( apply_filters( 'woocommerce_structured_data_review', $markup, $comment ) );
278	}
279
280	/**
281	* Generates BreadcrumbList structured data.
282	*
283	* Hooked into `woocommerce_breadcrumb` action hook.
284	*
285	* @param WC_Breadcrumb $breadcrumbs Breadcrumb data.
286	*/
287	public function generate_breadcrumblist_data( $breadcrumbs ) {
288	$crumbs = $breadcrumbs->get_breadcrumb();
289
290	$markup = array();
291	$markup['@type'] = 'BreadcrumbList';
292	$markup['itemListElement'] = array();
293
294	foreach ( $crumbs as $key => $crumb ) {
295	$markup['itemListElement'][ $key ] = array(
296	'@type' => 'ListItem',
297	'position' => $key + 1,
298	'item' => array(
299	'name' => $crumb[0],
300	),
301	);
302
303	if ( ! empty( $crumb[1] ) && sizeof( $crumbs ) !== $key + 1 ) {
304	$markup['itemListElement'][ $key ]['item'] += array( '@id' => $crumb[1] );
305	}
306	}
307
308	$this->set_data( apply_filters( 'woocommerce_structured_data_breadcrumblist', $markup, $breadcrumbs ) );
309	}
310
311	/**
312	* Generates WebSite structured data.
313	*
314	* Hooked into `woocommerce_before_main_content` action hook.
315	*/
316	public function generate_website_data() {
317	$markup = array();
318	$markup['@type'] = 'WebSite';
319	$markup['name'] = get_bloginfo( 'name' );
320	$markup['url'] = home_url();
321	$markup['potentialAction'] = array(
322	'@type' => 'SearchAction',
323	'target' => home_url( '?s={search_term_string}&post_type=product' ),
324	'query-input' => 'required name=search_term_string',
325	);
326
327	$this->set_data( apply_filters( 'woocommerce_structured_data_website', $markup ) );
328	}
329
330	/**
331	* Generates Order structured data.
332	*
333	* Hooked into `woocommerce_email_order_details` action hook.
334	*
335	* @param WP_Order $order Order data.
336	* @param bool $sent_to_admin Send to admin (default: false).
337	* @param bool $plain_text Plain text email (default: false).
338	*/
339	public function generate_order_data( $order, $sent_to_admin = false, $plain_text = false ) {
340	if ( $plain_text \|\| ! is_a( $order, 'WC_Order' ) ) {
341	return;
342	}
343
344	$shop_name = get_bloginfo( 'name' );
345	$shop_url = home_url();
346	$order_url = $sent_to_admin ? admin_url( 'post.php?post=' . absint( $order->get_id() ) . '&action=edit' ) : $order->get_view_order_url();
347	$order_statuses = array(
348	'pending' => 'http://schema.org/OrderPaymentDue',
349	'processing' => 'http://schema.org/OrderProcessing',
350	'on-hold' => 'http://schema.org/OrderProblem',
351	'completed' => 'http://schema.org/OrderDelivered',
352	'cancelled' => 'http://schema.org/OrderCancelled',
353	'refunded' => 'http://schema.org/OrderReturned',
354	'failed' => 'http://schema.org/OrderProblem',
355	);
356
357	$markup_offers = array();
358	foreach ( $order->get_items() as $item ) {
359	if ( ! apply_filters( 'woocommerce_order_item_visible', true, $item ) ) {
360	continue;
361	}
362
363	$product = apply_filters( 'woocommerce_order_item_product', $order->get_product_from_item( $item ), $item );
364	$product_exists = is_object( $product );
365	$is_visible = $product_exists && $product->is_visible();
366
367	$markup_offers[] = array(
368	'@type' => 'Offer',
369	'price' => $order->get_line_subtotal( $item ),
370	'priceCurrency' => $order->get_currency(),
371	'priceSpecification' => array(
372	'price' => $order->get_line_subtotal( $item ),
373	'priceCurrency' => $order->get_currency(),
374	'eligibleQuantity' => array(
375	'@type' => 'QuantitativeValue',
376	'value' => apply_filters( 'woocommerce_email_order_item_quantity', $item['qty'], $item ),
377	),
378	),
379	'itemOffered' => array(
380	'@type' => 'Product',
381	'name' => apply_filters( 'woocommerce_order_item_name', $item['name'], $item, $is_visible ),
382	'sku' => $product_exists ? $product->get_sku() : '',
383	'image' => $product_exists ? wp_get_attachment_image_url( $product->get_image_id() ) : '',
384	'url' => $is_visible ? get_permalink( $product->get_id() ) : get_home_url(),
385	),
386	'seller' => array(
387	'@type' => 'Organization',
388	'name' => $shop_name,
389	'url' => $shop_url,
390	),
391	);
392	}
393
394	$markup = array();
395	$markup['@type'] = 'Order';
396	$markup['url'] = $order_url;
397	$markup['orderStatus'] = isset( $order_status[ $order->get_status() ] ) ? $order_status[ $order->get_status() ] : '';
398	$markup['orderNumber'] = $order->get_order_number();
399	$markup['orderDate'] = $order->get_date_created()->format( 'c' );
400	$markup['acceptedOffer'] = $markup_offers;
401	$markup['discount'] = $order->get_total_discount();
402	$markup['discountCurrency'] = $order->get_currency();
403	$markup['price'] = $order->get_total();
404	$markup['priceCurrency'] = $order->get_currency();
405	$markup['priceSpecification'] = array(
406	'price' => $order->get_total(),
407	'priceCurrency' => $order->get_currency(),
408	'valueAddedTaxIncluded' => true,
409	);
410	$markup['billingAddress'] = array(
411	'@type' => 'PostalAddress',
412	'name' => $order->get_formatted_billing_full_name(),
413	'streetAddress' => $order->get_billing_address_1(),
414	'postalCode' => $order->get_billing_postcode(),
415	'addressLocality' => $order->get_billing_city(),
416	'addressRegion' => $order->get_billing_state(),
417	'addressCountry' => $order->get_billing_country(),
418	'email' => $order->get_billing_email(),
419	'telephone' => $order->get_billing_phone(),
420	);
421	$markup['customer'] = array(
422	'@type' => 'Person',
423	'name' => $order->get_formatted_billing_full_name(),
424	);
425	$markup['merchant'] = array(
426	'@type' => 'Organization',
427	'name' => $shop_name,
428	'url' => $shop_url,
429	);
430	$markup['potentialAction'] = array(
431	'@type' => 'ViewAction',
432	'name' => 'View Order',
433	'url' => $order_url,
434	'target' => $order_url,
435	);
436
437	$this->set_data( apply_filters( 'woocommerce_structured_data_order', $markup, $sent_to_admin, $order ), true );
438	}
439	}
440