1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
|
<?php // phpcs:ignore Generic.PHP.RequireStrictTypes.MissingDeclaration
namespace Automattic\WooCommerce\Blocks\Utils;
/**
* Class containing utility methods for dealing with the Cart and Checkout blocks.
*/
class CartCheckoutUtils {
/**
* Caches if we're on the cart page.
*
* @var bool
*/
private static $is_cart_page = null;
/**
* Caches if we're on the checkout page.
*
* @var bool
*/
private static $is_checkout_page = null;
/**
* Returns true if the current page is a specific page type (cart or checkout).
*
* This is determined by looking at the global $post object and comparing it to the post ID defined in settings,
* or checking the page contents for a block or shortcode.
*
* This function cannot be used accurately before the `pre_get_posts` action has been run.
*
* @param string $page_type The page type to check for.
* @return bool|null
*/
private static function is_page_type( string $page_type ): ?bool {
if ( ! did_action( 'pre_get_posts' ) ) {
return null;
}
$page_id = wc_get_page_id( $page_type );
if ( $page_id && is_page( $page_id ) ) {
return true;
}
// If the is_page check returned false, check the page contents for a cart block or shortcode.
global $post;
if ( null === $post ) {
return null;
}
if ( $post instanceof \WP_Post ) {
return wc_post_content_has_shortcode( 'cart' === $page_type ? 'woocommerce_cart' : 'woocommerce_checkout' ) || self::has_block_variation( 'woocommerce/classic-shortcode', 'shortcode', $page_type, $post->post_content );
}
return false;
}
/**
* Returns true on the cart page.
*
* @return bool
*/
public static function is_cart_page(): bool {
if ( null === self::$is_cart_page ) {
self::$is_cart_page = self::is_page_type( 'cart' );
}
return true === self::$is_cart_page;
}
/**
* Returns true on the checkout page.
*
* @return bool
*/
public static function is_checkout_page(): bool {
if ( null === self::$is_checkout_page ) {
self::$is_checkout_page = self::is_page_type( 'checkout' );
}
return true === self::$is_checkout_page;
}
/**
* Returns true if shipping methods exist in the store. Excludes local pickup and only counts enabled shipping methods.
*
* @return bool true if shipping methods exist.
*/
public static function shipping_methods_exist() {
// Local pickup is included with legacy shipping methods since they do not support shipping zones.
$local_pickup_count = count(
array_filter(
WC()->shipping()->get_shipping_methods(),
function ( $method ) {
return isset( $method->enabled ) && 'yes' === $method->enabled && ! $method->supports( 'shipping-zones' ) && $method->supports( 'local-pickup' );
}
)
);
$shipping_methods_count = wc_get_shipping_method_count( true, true ) - $local_pickup_count;
return $shipping_methods_count > 0;
}
/**
* Check if the post content contains a block with a specific attribute value.
*
* @param string $block_id The block ID to check for.
* @param string $attribute The attribute to check.
* @param string $value The value to check for.
* @param string $post_content The post content to check.
* @return boolean
*/
public static function has_block_variation( $block_id, $attribute, $value, $post_content ) {
if ( ! $post_content ) {
return false;
}
if ( has_block( $block_id, $post_content ) ) {
$blocks = (array) parse_blocks( $post_content );
foreach ( $blocks as $block ) {
$block_name = $block['blockName'] ?? '';
if ( $block_name !== $block_id ) {
continue;
}
if ( isset( $block['attrs'][ $attribute ] ) && $value === $block['attrs'][ $attribute ] ) {
return true;
}
// `Cart` is default for `woocommerce/classic-shortcode` so it will be empty in the block attributes.
if ( 'woocommerce/classic-shortcode' === $block_id && 'shortcode' === $attribute && 'cart' === $value && ! isset( $block['attrs']['shortcode'] ) ) {
return true;
}
}
}
return false;
}
/**
* Checks if the default cart page is using the Cart block.
*
* @return bool true if the WC cart page is using the Cart block.
*/
public static function is_cart_block_default() {
if ( wp_is_block_theme() ) {
// Ignore the pages and check the templates.
$templates_from_db = BlockTemplateUtils::get_block_templates_from_db( array( 'cart' ), 'wp_template' );
foreach ( $templates_from_db as $template ) {
if ( has_block( 'woocommerce/cart', $template->content ) ) {
return true;
}
}
}
$cart_page_id = wc_get_page_id( 'cart' );
return $cart_page_id && has_block( 'woocommerce/cart', $cart_page_id );
}
/**
* Checks if the default checkout page is using the Checkout block.
*
* @return bool true if the WC checkout page is using the Checkout block.
*/
public static function is_checkout_block_default() {
if ( wp_is_block_theme() ) {
// Ignore the pages and check the templates.
$templates_from_db = BlockTemplateUtils::get_block_templates_from_db( array( 'checkout' ), 'wp_template' );
foreach ( $templates_from_db as $template ) {
if ( has_block( 'woocommerce/checkout', $template->content ) ) {
return true;
}
}
}
$checkout_page_id = wc_get_page_id( 'checkout' );
return $checkout_page_id && has_block( 'woocommerce/checkout', $checkout_page_id );
}
/**
* Migrate checkout block field visibility attributes to settings when using the checkout block.
*
* This migration routine is called if the options (woocommerce_checkout_phone_field, woocommerce_checkout_company_field,
* woocommerce_checkout_address_2_field) are not set. They are not set by default; they were orignally set by the
* customizer interface of the legacy shortcode based checkout.
*
* Once migration is initiated, the settings will be updated and will not trigger this routine again.
*
* Note: The block only stores non-default attributes. Not all attributes will be present.
*
* e.g. `{"showCompanyField":true,"requireCompanyField":true,"showApartmentField":false,"className":"wc-block-checkout"}`
*
* If the attributes are missing, we assume default values are needed.
*/
protected static function migrate_checkout_block_field_visibility_attributes() {
// Before migrating attributes, migrate the "default" options checkout block uses into the settings.
update_option( 'woocommerce_checkout_phone_field', 'optional' );
update_option( 'woocommerce_checkout_company_field', 'hidden' );
update_option( 'woocommerce_checkout_address_2_field', 'optional' );
// Parse the block from the checkout page.
$checkout_blocks = \WC_Blocks_Utils::get_blocks_from_page( 'woocommerce/checkout', 'checkout' );
if ( empty( $checkout_blocks ) || ! isset( $checkout_blocks[0]['attrs'] ) ) {
return;
}
// Combine actual attributes with default values.
$block_attributes = wp_parse_args(
$checkout_blocks[0]['attrs'],
array(
'showPhoneField' => true,
'requirePhoneField' => false,
'showCompanyField' => false,
'requireCompanyField' => false,
'showApartmentField' => true,
'requireApartmentField' => false,
)
);
if ( $block_attributes['showPhoneField'] ) {
update_option( 'woocommerce_checkout_phone_field', $block_attributes['requirePhoneField'] ? 'required' : 'optional' );
} else {
update_option( 'woocommerce_checkout_phone_field', 'hidden' );
}
if ( $block_attributes['showCompanyField'] ) {
update_option( 'woocommerce_checkout_company_field', $block_attributes['requireCompanyField'] ? 'required' : 'optional' );
} else {
update_option( 'woocommerce_checkout_company_field', 'hidden' );
}
if ( $block_attributes['showApartmentField'] ) {
update_option( 'woocommerce_checkout_address_2_field', $block_attributes['requireApartmentField'] ? 'required' : 'optional' );
} else {
update_option( 'woocommerce_checkout_address_2_field', 'hidden' );
}
}
/**
* Get the default visibility for the address_2 field.
*
* @return string
*/
public static function get_company_field_visibility() {
$option_value = get_option( 'woocommerce_checkout_company_field' );
if ( $option_value ) {
return $option_value;
}
if ( self::is_checkout_block_default() ) {
self::migrate_checkout_block_field_visibility_attributes();
return get_option( 'woocommerce_checkout_company_field', 'hidden' );
}
return 'optional';
}
/**
* Get the default visibility for the address_2 field.
*
* @return string
*/
public static function get_address_2_field_visibility() {
$option_value = get_option( 'woocommerce_checkout_address_2_field' );
if ( $option_value ) {
return $option_value;
}
if ( self::is_checkout_block_default() ) {
self::migrate_checkout_block_field_visibility_attributes();
return get_option( 'woocommerce_checkout_address_2_field', 'optional' );
}
return 'optional';
}
/**
* Get the default visibility for the address_2 field.
*
* @return string
*/
public static function get_phone_field_visibility() {
$option_value = get_option( 'woocommerce_checkout_phone_field' );
if ( $option_value ) {
return $option_value;
}
if ( self::is_checkout_block_default() ) {
self::migrate_checkout_block_field_visibility_attributes();
return get_option( 'woocommerce_checkout_phone_field', 'optional' );
}
return 'required';
}
/**
* Checks if the template overriding the page loads the page content or not.
* Templates by default load the page content, but if that block is deleted the content can get out of sync with the one presented in the page editor.
*
* @param string $block The block to check.
*
* @return bool true if the template has out of sync content.
*/
public static function is_overriden_by_custom_template_content( string $block ): bool {
$block = str_replace( 'woocommerce/', '', $block );
if ( wp_is_block_theme() ) {
$templates_from_db = BlockTemplateUtils::get_block_templates_from_db( array( 'page-' . $block ) );
foreach ( $templates_from_db as $template ) {
if ( ! has_block( 'woocommerce/page-content-wrapper', $template->content ) ) {
// Return true if the template does not load the page content via the woocommerce/page-content-wrapper block.
return true;
}
}
}
return false;
}
/**
* Gets country codes, names, states, and locale information.
*
* @return array
*/
public static function get_country_data() {
$billing_countries = WC()->countries->get_allowed_countries();
$shipping_countries = WC()->countries->get_shipping_countries();
$country_states = wc()->countries->get_states();
$all_countries = self::deep_sort_with_accents( array_unique( array_merge( $billing_countries, $shipping_countries ) ) );
$country_locales = array_map(
function ( $locale ) {
foreach ( $locale as $field => $field_data ) {
if ( isset( $field_data['priority'] ) ) {
$locale[ $field ]['index'] = $field_data['priority'];
unset( $locale[ $field ]['priority'] );
}
if ( isset( $field_data['class'] ) ) {
unset( $locale[ $field ]['class'] );
}
}
return $locale;
},
WC()->countries->get_country_locale()
);
$country_data = [];
foreach ( array_keys( $all_countries ) as $country_code ) {
$country_data[ $country_code ] = [
'allowBilling' => isset( $billing_countries[ $country_code ] ),
'allowShipping' => isset( $shipping_countries[ $country_code ] ),
'states' => $country_states[ $country_code ] ?? [],
'locale' => $country_locales[ $country_code ] ?? [],
];
}
return $country_data;
}
/**
* Removes accents from an array of values, sorts by the values, then returns the original array values sorted.
*
* @param array $sort_array Array of values to sort.
* @return array Sorted array.
*/
protected static function deep_sort_with_accents( $sort_array ) {
if ( ! is_array( $sort_array ) || empty( $sort_array ) ) {
return $sort_array;
}
$array_without_accents = array_map(
function ( $value ) {
return is_array( $value )
? self::deep_sort_with_accents( $value )
: remove_accents( wc_strtolower( html_entity_decode( $value ) ) );
},
$sort_array
);
asort( $array_without_accents );
return array_replace( $array_without_accents, $sort_array );
}
/**
* Retrieves formatted shipping zones from WooCommerce.
*
* @return array An array of formatted shipping zones.
*/
public static function get_shipping_zones() {
$shipping_zones = \WC_Shipping_Zones::get_zones();
$formatted_shipping_zones = array_reduce(
$shipping_zones,
function ( $acc, $zone ) {
$acc[] = [
'id' => $zone['id'],
'title' => $zone['zone_name'],
'description' => $zone['formatted_zone_location'],
];
return $acc;
},
[]
);
$formatted_shipping_zones[] = [
'id' => 0,
'title' => __( 'International', 'woocommerce' ),
'description' => __( 'Locations outside all other zones', 'woocommerce' ),
];
return $formatted_shipping_zones;
}
/**
* Recursively search the checkout block to find the express checkout block and
* get the button style attributes
*
* @param array $blocks Blocks to search.
* @param string $cart_or_checkout The block type to check.
*/
public static function find_express_checkout_attributes( $blocks, $cart_or_checkout ) {
$express_block_name = 'woocommerce/' . $cart_or_checkout . '-express-payment-block';
foreach ( $blocks as $block ) {
if ( ! empty( $block['blockName'] ) && $express_block_name === $block['blockName'] && ! empty( $block['attrs'] ) ) {
return $block['attrs'];
}
if ( ! empty( $block['innerBlocks'] ) ) {
$answer = self::find_express_checkout_attributes( $block['innerBlocks'], $cart_or_checkout );
if ( $answer ) {
return $answer;
}
}
}
}
/**
* Given an array of blocks, find the express payment block and update its attributes.
*
* @param array $blocks Blocks to search.
* @param string $cart_or_checkout The block type to check.
* @param array $updated_attrs The new attributes to set.
*/
public static function update_blocks_with_new_attrs( &$blocks, $cart_or_checkout, $updated_attrs ) {
$express_block_name = 'woocommerce/' . $cart_or_checkout . '-express-payment-block';
foreach ( $blocks as $key => &$block ) {
if ( ! empty( $block['blockName'] ) && $express_block_name === $block['blockName'] ) {
$blocks[ $key ]['attrs'] = $updated_attrs;
}
if ( ! empty( $block['innerBlocks'] ) ) {
self::update_blocks_with_new_attrs( $block['innerBlocks'], $cart_or_checkout, $updated_attrs );
}
}
}
/**
* Check if the cart page is defined.
*
* @return bool True if the cart page is defined, false otherwise.
*/
public static function has_cart_page() {
return wc_get_page_permalink( 'cart', -1 ) !== -1;
}
}
|