<?php // phpcs:ignore Generic.PHP.RequireStrictTypes.MissingDeclaration
namespace Automattic\WooCommerce\Blocks\Utils;
use Automattic\Block_Scanner;
/**
* 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 `wp` 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( 'wp' ) ) {
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;
}
$scanner = Block_Scanner::create( $post_content );
if ( ! $scanner ) {
return false;
}
while ( $scanner->next_delimiter() ) {
if ( ! $scanner->opens_block( $block_id ) ) {
continue;
}
$attrs = $scanner->allocate_and_return_parsed_attributes();
if ( isset( $attrs[ $attribute ] ) && $value === $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( $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 originally 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.
*
* @since 10.9.0
*
* @param string $block The block to check.
*
* @return bool true if the template has out of sync content.
*/
public static function is_overridden_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;
}
/**
* 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.
*
* @deprecated 10.9.0 Use is_overridden_by_custom_template_content() instead.
*
* @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 {
wc_deprecated_function( __METHOD__, '10.9.0', 'is_overridden_by_custom_template_content' );
return self::is_overridden_by_custom_template_content( $block );
}
/**
* 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 = array();
foreach ( array_keys( $all_countries ) as $country_code ) {
$country_data[ $country_code ] = array(
'allowBilling' => isset( $billing_countries[ $country_code ] ),
'allowShipping' => isset( $shipping_countries[ $country_code ] ),
'states' => $country_states[ $country_code ] ?? array(),
'locale' => $country_locales[ $country_code ] ?? array(),
);
}
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[] = array(
'id' => $zone['id'],
'title' => $zone['zone_name'],
'description' => $zone['formatted_zone_location'],
);
return $acc;
},
array()
);
$formatted_shipping_zones[] = array(
'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 using the parse_blocks function.
*
* @param array $blocks Blocks to search.
* @param string $cart_or_checkout The block type to check.
*
* @return array Block attributes.
*/
public static function find_express_checkout_attributes_in_parsed_blocks( $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_in_parsed_blocks( $block['innerBlocks'], $cart_or_checkout );
if ( $answer ) {
return $answer;
}
}
}
}
/**
* Recursively search the checkout block to find the express checkout block and
* get the button style attributes
*
* @param string|array $post_content The post content.
* @param string $cart_or_checkout The block type to check.
*
* @return array|null Block attributes, if present and valid, otherwise `null`.
*/
public static function find_express_checkout_attributes( $post_content, $cart_or_checkout ) {
if ( is_array( $post_content ) ) {
// If an array is passed, assume it's already been parsed with parse_blocks,
// use the old method, and show a deprecation warning.
wc_deprecated_argument(
'post_content',
'10.3.0',
'Passing parsed blocks as an array in $post_content is deprecated. Please pass the post content as a string.'
);
return self::find_express_checkout_attributes_in_parsed_blocks( $post_content, $cart_or_checkout );
}
$express_block_name = 'woocommerce/' . $cart_or_checkout . '-express-payment-block';
$scanner = Block_Scanner::create( $post_content );
while ( $scanner->next_delimiter() ) {
if ( $scanner->opens_block( $express_block_name ) ) {
return $scanner->allocate_and_return_parsed_attributes();
}
}
return null;
}
/**
* 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;
}
/**
* Get product IDs from a user's persistent cart.
*
* This method retrieves product IDs stored in the user's persistent cart meta.
* It can be used for abandoned cart emails, cart-based product collections,
* and other scenarios where cart products need to be retrieved for a user.
*
* @param int|null $user_id The user ID. If not provided, will attempt to look up by email.
* @param string|null $user_email The user email. Used to lookup user if ID not provided.
* @return array<int> Array of product IDs from the user's cart, or empty array if none found.
*/
public static function get_cart_product_ids_for_user( ?int $user_id, ?string $user_email ) {
if ( empty( $user_id ) && ! empty( $user_email ) ) {
$user = get_user_by( 'email', $user_email );
if ( $user ) {
$user_id = $user->ID;
}
}
if ( empty( $user_id ) ) {
return array();
}
$cart_meta = get_user_meta( $user_id, '_woocommerce_persistent_cart_' . get_current_blog_id(), true );
if ( empty( $cart_meta ) || ! is_array( $cart_meta ) || empty( $cart_meta['cart'] ) ) {
return array();
}
return array_values(
array_unique(
array_filter(
array_map(
function ( $cart_item ) {
return isset( $cart_item['product_id'] ) ? intval( $cart_item['product_id'] ) : 0;
},
$cart_meta['cart']
)
)
)
);
}
}