JezK

Edit File: class-wc-frontend-scripts.php

<?php /** * Handle frontend scripts * * @package WooCommerce\Classes * @version 3.9.0 * @since 2.3.0 */ // phpcs:disable WooCommerce.Commenting.CommentHooks.MissingHookComment use Automattic\Jetpack\Constants; use Automattic\WooCommerce\Admin\Features\Features; use Automattic\WooCommerce\Enums\DefaultCustomerAddress; use Automattic\WooCommerce\Internal\AddressProvider\AddressProviderController; if ( ! defined( 'ABSPATH' ) ) { exit; } /** * Frontend scripts class. * * These scripts are enqueued in the frontend of the store. The registered script handles in this class * can be used to enqueue the scripts in the frontend by third party plugins and the handles will follow * WooCommerce's L-1 support policy. Scripts registered outside of this class do not guarantee support * and can be removed in future versions of WooCommerce. */ class WC_Frontend_Scripts { /** * Contains an array of script handles registered by WC. * * @var array */ private static $registered_scripts = array(); /** * Contains an array of script handles registered by WC. * * @var array */ private static $styles = array(); /** * Contains an array of script handles localized by WC. * * @var array */ private static $wp_localize_scripts = array(); /** * Hook in methods. */ public static function init() { add_action( 'wp_enqueue_scripts', array( __CLASS__, 'load_scripts' ) ); add_action( 'wp_print_scripts', array( __CLASS__, 'localize_printed_scripts' ), 5 ); add_action( 'wp_print_footer_scripts', array( __CLASS__, 'localize_printed_scripts' ), 5 ); add_action( 'enqueue_block_assets', array( __CLASS__, 'enqueue_block_assets' ) ); } /** * Get styles for the frontend. * * @return array */ public static function get_styles() { $version = Constants::get_constant( 'WC_VERSION' ); /** * Filter list of WooCommerce styles to enqueue. * * @since 2.1.0 * @param array List of default WooCommerce styles. * @return array List of styles to enqueue. */ $styles = apply_filters( 'woocommerce_enqueue_styles', array( 'woocommerce-layout' => array( 'src' => self::get_asset_url( 'assets/css/woocommerce-layout.css' ), 'deps' => '', 'version' => $version, 'media' => 'all', 'has_rtl' => true, ), 'woocommerce-smallscreen' => array( 'src' => self::get_asset_url( 'assets/css/woocommerce-smallscreen.css' ), 'deps' => 'woocommerce-layout', 'version' => $version, 'media' => 'only screen and (max-width: ' . apply_filters( 'woocommerce_style_smallscreen_breakpoint', '768px' ) . ')', 'has_rtl' => true, ), 'woocommerce-general' => array( 'src' => self::get_asset_url( 'assets/css/woocommerce.css' ), 'deps' => '', 'version' => $version, 'media' => 'all', 'has_rtl' => true, ), ) ); return is_array( $styles ) ? array_filter( $styles ) : array(); } /** * Enqueue styles for block assets (both editor and frontend). * This ensures compatibility with WordPress 6.9+ requirements. */ public static function enqueue_block_assets() { if ( ! wp_is_block_theme() ) { return; } $version = Constants::get_constant( 'WC_VERSION' ); wp_enqueue_style( 'woocommerce-blocktheme', self::get_asset_url( 'assets/css/woocommerce-blocktheme.css' ), array(), $version, 'all' ); wp_style_add_data( 'woocommerce-blocktheme', 'rtl', 'replace' ); } /** * Return asset URL. * * @param string $path Assets path. * @return string */ private static function get_asset_url( $path ) { return apply_filters( 'woocommerce_get_asset_url', plugins_url( $path, WC_PLUGIN_FILE ), $path ); } /** * Register a script for use. * * @uses wp_register_script() * @param string $handle Name of the script. Should be unique. * @param string $path Full URL of the script, or path of the script relative to the WordPress root directory. * @param string[] $deps An array of registered script handles this script depends on. * @param string $version String specifying script version number, if it has one, which is added to the URL as a query string for cache busting purposes. If version is set to false, a version number is automatically added equal to current installed WordPress version. If set to null, no version is added. * @param boolean|array $in_footer Whether to enqueue the script before </body>, or an array of loading strategy arguments as accepted by wp_register_script(). Default 'defer' strategy. */ private static function register_script( $handle, $path, $deps = array( 'jquery' ), $version = WC_VERSION, $in_footer = array( 'strategy' => 'defer' ) ) { self::$registered_scripts[] = $handle; wp_register_script( $handle, $path, $deps, $version, $in_footer ); } /** * Register and enqueue a script for use. * * @uses wp_enqueue_script() * @param string $handle Name of the script. Should be unique. * @param string $path Full URL of the script, or path of the script relative to the WordPress root directory. * @param string[] $deps An array of registered script handles this script depends on. * @param string $version String specifying script version number, if it has one, which is added to the URL as a query string for cache busting purposes. If version is set to false, a version number is automatically added equal to current installed WordPress version. If set to null, no version is added. * @param boolean|array $in_footer Whether to enqueue the script before </body>, or an array of loading strategy arguments as accepted by wp_enqueue_script(). Default 'defer' strategy. */ private static function enqueue_script( $handle, $path = '', $deps = array( 'jquery' ), $version = WC_VERSION, $in_footer = array( 'strategy' => 'defer' ) ) { if ( ! in_array( $handle, self::$registered_scripts, true ) && $path ) { self::register_script( $handle, $path, $deps, $version, $in_footer ); } wp_enqueue_script( $handle ); } /** * Register a style for use. * * @uses wp_register_style() * @param string $handle Name of the stylesheet. Should be unique. * @param string $path Full URL of the stylesheet, or path of the stylesheet relative to the WordPress root directory. * @param string[] $deps An array of registered stylesheet handles this stylesheet depends on. * @param string $version String specifying stylesheet version number, if it has one, which is added to the URL as a query string for cache busting purposes. If version is set to false, a version number is automatically added equal to current installed WordPress version. If set to null, no version is added. * @param string $media The media for which this stylesheet has been defined. Accepts media types like 'all', 'print' and 'screen', or media queries like '(orientation: portrait)' and '(max-width: 640px)'. * @param boolean $has_rtl If has RTL version to load too. */ private static function register_style( $handle, $path, $deps = array(), $version = WC_VERSION, $media = 'all', $has_rtl = false ) { self::$styles[] = $handle; wp_register_style( $handle, $path, $deps, $version, $media ); if ( $has_rtl ) { wp_style_add_data( $handle, 'rtl', 'replace' ); } } /** * Register and enqueue a styles for use. * * @uses wp_enqueue_style() * @param string $handle Name of the stylesheet. Should be unique. * @param string $path Full URL of the stylesheet, or path of the stylesheet relative to the WordPress root directory. * @param string[] $deps An array of registered stylesheet handles this stylesheet depends on. * @param string $version String specifying stylesheet version number, if it has one, which is added to the URL as a query string for cache busting purposes. If version is set to false, a version number is automatically added equal to current installed WordPress version. If set to null, no version is added. * @param string $media The media for which this stylesheet has been defined. Accepts media types like 'all', 'print' and 'screen', or media queries like '(orientation: portrait)' and '(max-width: 640px)'. * @param boolean $has_rtl If has RTL version to load too. */ private static function enqueue_style( $handle, $path = '', $deps = array(), $version = WC_VERSION, $media = 'all', $has_rtl = false ) { if ( ! in_array( $handle, self::$styles, true ) && $path ) { self::register_style( $handle, $path, $deps, $version, $media, $has_rtl ); } wp_enqueue_style( $handle ); } /** * Get scripts for the frontend. * * @return array */ private static function get_scripts(): array { $suffix = Constants::is_true( 'SCRIPT_DEBUG' ) ? '' : '.min'; $version = Constants::get_constant( 'WC_VERSION' ); $scripts = array( 'selectWoo' => array( 'src' => self::get_asset_url( 'assets/js/selectWoo/selectWoo.full' . $suffix . '.js' ), 'deps' => array( 'jquery' ), 'version' => '1.0.9-wc.' . $version, ), 'wc-account-i18n' => array( 'src' => self::get_asset_url( 'assets/js/frontend/account-i18n' . $suffix . '.js' ), 'deps' => array( 'jquery' ), 'version' => $version, ), 'wc-add-payment-method' => array( 'src' => self::get_asset_url( 'assets/js/frontend/add-payment-method' . $suffix . '.js' ), 'deps' => array( 'jquery', 'woocommerce', 'wc-custom-place-order-button' ), 'version' => $version, ), 'wc-add-to-cart' => array( 'src' => self::get_asset_url( 'assets/js/frontend/add-to-cart' . $suffix . '.js' ), 'deps' => array( 'jquery', 'wc-jquery-blockui' ), 'version' => $version, ), 'wc-add-to-cart-variation' => array( 'src' => self::get_asset_url( 'assets/js/frontend/add-to-cart-variation' . $suffix . '.js' ), 'deps' => array( 'jquery', 'wp-util', 'wc-jquery-blockui' ), 'version' => $version, ), 'wc-address-i18n' => array( 'src' => self::get_asset_url( 'assets/js/frontend/address-i18n' . $suffix . '.js' ), 'deps' => array( 'jquery', 'wc-country-select' ), 'version' => $version, ), 'wc-back-in-stock-form' => array( 'src' => self::get_asset_url( 'assets/js/frontend/back-in-stock-form' . $suffix . '.js' ), 'deps' => array( 'jquery' ), 'version' => $version, ), 'wc-cart' => array( 'src' => self::get_asset_url( 'assets/js/frontend/cart' . $suffix . '.js' ), 'deps' => array( 'jquery', 'woocommerce', 'wc-country-select', 'wc-address-i18n' ), 'version' => $version, ), 'wc-cart-fragments' => array( 'src' => self::get_asset_url( 'assets/js/frontend/cart-fragments' . $suffix . '.js' ), 'deps' => array( 'jquery', 'wc-js-cookie' ), 'version' => $version, ), 'wc-checkout' => array( 'src' => self::get_asset_url( 'assets/js/frontend/checkout' . $suffix . '.js' ), 'deps' => array( 'jquery', 'woocommerce', 'wc-country-select', 'wc-address-i18n', 'wc-custom-place-order-button', ), 'version' => $version, ), 'wc-country-select' => array( 'src' => self::get_asset_url( 'assets/js/frontend/country-select' . $suffix . '.js' ), 'deps' => array( 'jquery' ), 'version' => $version, ), 'wc-credit-card-form' => array( 'src' => self::get_asset_url( 'assets/js/frontend/credit-card-form' . $suffix . '.js' ), 'deps' => array( 'jquery', 'wc-jquery-payment' ), 'version' => $version, ), 'wc-custom-place-order-button' => array( 'src' => self::get_asset_url( 'assets/js/frontend/utils/custom-place-order-button' . $suffix . '.js' ), 'deps' => array( 'jquery' ), 'version' => $version, ), 'wc-dompurify' => array( 'src' => self::get_asset_url( 'assets/js/dompurify/purify' . $suffix . '.js' ), 'deps' => array(), 'version' => $version, ), 'wc-flexslider' => array( 'src' => self::get_asset_url( 'assets/js/flexslider/jquery.flexslider' . $suffix . '.js' ), 'deps' => array( 'jquery' ), 'version' => '2.7.2-wc.' . $version, 'legacy_handle' => 'flexslider', ), 'wc-geolocation' => array( 'src' => self::get_asset_url( 'assets/js/frontend/geolocation' . $suffix . '.js' ), 'deps' => array( 'jquery' ), 'version' => $version, ), 'wc-jquery-blockui' => array( 'src' => self::get_asset_url( 'assets/js/jquery-blockui/jquery.blockUI' . $suffix . '.js' ), 'deps' => array( 'jquery' ), 'version' => '2.7.0-wc.' . $version, 'legacy_handle' => 'jquery-blockui', ), 'wc-jquery-cookie' => array( 'src' => self::get_asset_url( 'assets/js/jquery-cookie/jquery.cookie' . $suffix . '.js' ), 'deps' => array( 'jquery' ), 'version' => '1.4.1-wc.' . $version, 'legacy_handle' => 'jquery-cookie', ), 'wc-jquery-payment' => array( 'src' => self::get_asset_url( 'assets/js/jquery-payment/jquery.payment' . $suffix . '.js' ), 'deps' => array( 'jquery' ), 'version' => '3.0.0-wc.' . $version, 'legacy_handle' => 'jquery-payment', ), 'wc-jquery-tiptip' => array( 'src' => self::get_asset_url( 'assets/js/jquery-tiptip/jquery.tipTip' . $suffix . '.js' ), 'deps' => array( 'jquery', 'wc-dompurify' ), 'version' => $version, 'legacy_handle' => 'jquery-tiptip', ), 'wc-js-cookie' => array( 'src' => self::get_asset_url( 'assets/js/js-cookie/js.cookie' . $suffix . '.js' ), 'deps' => array(), 'version' => '2.1.4-wc.' . $version, 'legacy_handle' => 'js-cookie', ), 'wc-lost-password' => array( 'src' => self::get_asset_url( 'assets/js/frontend/lost-password' . $suffix . '.js' ), 'deps' => array( 'jquery', 'woocommerce' ), 'version' => $version, ), 'wc-password-strength-meter' => array( 'src' => self::get_asset_url( 'assets/js/frontend/password-strength-meter' . $suffix . '.js' ), 'deps' => array( 'jquery', 'password-strength-meter' ), 'version' => $version, ), 'wc-photoswipe' => array( 'src' => self::get_asset_url( 'assets/js/photoswipe/photoswipe' . $suffix . '.js' ), 'deps' => array(), 'version' => '4.1.1-wc.' . $version, 'legacy_handle' => 'photoswipe', ), 'wc-photoswipe-ui-default' => array( 'src' => self::get_asset_url( 'assets/js/photoswipe/photoswipe-ui-default' . $suffix . '.js' ), 'deps' => array( 'wc-photoswipe' ), 'version' => '4.1.1-wc.' . $version, 'legacy_handle' => 'photoswipe-ui-default', ), 'wc-prettyPhoto' => array( // deprecated. 'src' => self::get_asset_url( 'assets/js/prettyPhoto/jquery.prettyPhoto' . $suffix . '.js' ), 'deps' => array( 'jquery' ), 'version' => '3.1.6-wc.' . $version, 'legacy_handle' => 'prettyPhoto', ), 'wc-prettyPhoto-init' => array( // deprecated. 'src' => self::get_asset_url( 'assets/js/prettyPhoto/jquery.prettyPhoto.init' . $suffix . '.js' ), 'deps' => array( 'jquery', 'wc-prettyPhoto' ), 'version' => $version, 'legacy_handle' => 'prettyPhoto-init', ), 'wc-select2' => array( 'src' => self::get_asset_url( 'assets/js/select2/select2.full' . $suffix . '.js' ), 'deps' => array( 'jquery' ), 'version' => '4.0.3-wc.' . $version, 'legacy_handle' => 'select2', ), 'wc-single-product' => array( 'src' => self::get_asset_url( 'assets/js/frontend/single-product' . $suffix . '.js' ), 'deps' => array( 'jquery' ), 'version' => $version, ), 'wc-zoom' => array( 'src' => self::get_asset_url( 'assets/js/zoom/jquery.zoom' . $suffix . '.js' ), 'deps' => array( 'jquery' ), 'version' => '1.7.21-wc.' . $version, 'legacy_handle' => 'zoom', ), 'woocommerce' => array( 'src' => self::get_asset_url( 'assets/js/frontend/woocommerce' . $suffix . '.js' ), 'deps' => array( 'jquery', 'wc-jquery-blockui', 'wc-js-cookie' ), 'version' => $version, ), ); if ( wc_string_to_bool( get_option( 'woocommerce_address_autocomplete_enabled', 'no' ) ) === true ) { $scripts['wc-address-autocomplete-common'] = array( 'src' => self::get_asset_url( 'assets/js/frontend/utils/address-autocomplete-common' . $suffix . '.js' ), 'deps' => array(), 'version' => $version, ); $scripts['wc-address-autocomplete'] = array( 'src' => self::get_asset_url( 'assets/js/frontend/address-autocomplete' . $suffix . '.js' ), 'deps' => array( 'wc-address-autocomplete-common', 'wc-dompurify' ), 'version' => $version, ); } return $scripts; } /** * Register all WC scripts. */ private static function register_scripts() { $register_scripts = self::get_scripts(); foreach ( $register_scripts as $name => $props ) { self::register_script( $name, $props['src'], $props['deps'], $props['version'] ); if ( isset( $props['legacy_handle'] ) ) { self::register_script( $props['legacy_handle'], false, array( $name ), $props['version'], true ); } } } /** * Register all WC styles. */ private static function register_styles() { $version = Constants::get_constant( 'WC_VERSION' ); $register_styles = array( 'photoswipe' => array( 'src' => self::get_asset_url( 'assets/css/photoswipe/photoswipe.min.css' ), 'deps' => array(), 'version' => $version, 'has_rtl' => false, ), 'photoswipe-default-skin' => array( 'src' => self::get_asset_url( 'assets/css/photoswipe/default-skin/default-skin.min.css' ), 'deps' => array( 'photoswipe' ), 'version' => $version, 'has_rtl' => false, ), 'select2' => array( 'src' => self::get_asset_url( 'assets/css/select2.css' ), 'deps' => array(), 'version' => $version, 'has_rtl' => false, ), 'woocommerce_prettyPhoto_css' => array( // deprecated. 'src' => self::get_asset_url( 'assets/css/prettyPhoto.css' ), 'deps' => array(), 'version' => $version, 'has_rtl' => true, ), ); if ( wc_string_to_bool( get_option( 'woocommerce_address_autocomplete_enabled', 'no' ) ) === true ) { $register_styles['wc-address-autocomplete'] = array( 'src' => self::get_asset_url( 'assets/css/address-autocomplete.css' ), 'deps' => array(), 'version' => $version, 'has_rtl' => false, ); } foreach ( $register_styles as $name => $props ) { self::register_style( $name, $props['src'], $props['deps'], $props['version'], 'all', $props['has_rtl'] ); } } /** * Register/queue frontend scripts. */ public static function load_scripts() { global $post; if ( ! did_action( 'before_woocommerce_init' ) ) { return; } self::register_scripts(); self::register_styles(); if ( 'yes' === get_option( 'woocommerce_enable_ajax_add_to_cart' ) ) { self::enqueue_script( 'wc-add-to-cart' ); } if ( is_cart() ) { self::enqueue_script( 'wc-cart' ); } if ( is_cart() || is_checkout() || is_account_page() ) { self::enqueue_script( 'selectWoo' ); self::enqueue_style( 'select2' ); // Password strength meter. Load in checkout, account login and edit account page. if ( ( 'no' === get_option( 'woocommerce_registration_generate_password' ) && ! is_user_logged_in() ) || is_edit_account_page() || is_lost_password_page() ) { self::enqueue_script( 'wc-password-strength-meter' ); } } if ( is_account_page() ) { self::enqueue_script( 'wc-account-i18n' ); } if ( is_checkout() ) { self::enqueue_script( 'wc-checkout' ); } if ( wc_string_to_bool( get_option( 'woocommerce_address_autocomplete_enabled', 'no' ) ) === true ) { $address_provider_service = wc_get_container()->get( AddressProviderController::class ); if ( $address_provider_service && method_exists( $address_provider_service, 'get_providers' ) ) { $registered_providers = $address_provider_service->get_providers(); if ( is_array( $registered_providers ) && count( $registered_providers ) > 0 ) { // Always enqueue the common module if providers are registered. self::enqueue_script( 'wc-address-autocomplete-common' ); self::enqueue_script( 'wc-address-autocomplete' ); self::enqueue_style( 'wc-address-autocomplete' ); } } } if ( is_add_payment_method_page() ) { self::enqueue_script( 'wc-add-payment-method' ); } if ( is_lost_password_page() ) { self::enqueue_script( 'wc-lost-password' ); } // Load gallery scripts on product pages only if supported. if ( ( is_product() && ! wp_is_block_theme() ) || ( ! empty( $post->post_content ) && strstr( $post->post_content, '[product_page' ) ) ) { if ( current_theme_supports( 'wc-product-gallery-zoom' ) ) { self::enqueue_script( 'wc-zoom' ); } if ( current_theme_supports( 'wc-product-gallery-slider' ) ) { self::enqueue_script( 'wc-flexslider' ); } if ( current_theme_supports( 'wc-product-gallery-lightbox' ) ) { self::enqueue_script( 'wc-photoswipe-ui-default' ); self::enqueue_style( 'photoswipe-default-skin' ); add_action( 'wp_footer', 'woocommerce_photoswipe' ); } self::enqueue_script( 'wc-single-product' ); } // Only enqueue the geolocation script if the Default Current Address is set to "Geolocate // (with Page Caching Support) and outside of the cart, checkout, account and customizer preview. if ( DefaultCustomerAddress::GEOLOCATION_AJAX === get_option( 'woocommerce_default_customer_address' ) && ! ( is_cart() || is_account_page() || is_checkout() || is_customize_preview() ) ) { $ua = strtolower( wc_get_user_agent() ); // Exclude common bots from geolocation by user agent. if ( ! strstr( $ua, 'bot' ) && ! strstr( $ua, 'spider' ) && ! strstr( $ua, 'crawl' ) ) { self::enqueue_script( 'wc-geolocation' ); } } // Global frontend scripts. self::enqueue_script( 'woocommerce' ); // CSS Styles. $enqueue_styles = self::get_styles(); if ( $enqueue_styles ) { foreach ( $enqueue_styles as $handle => $args ) { if ( ! isset( $args['has_rtl'] ) ) { $args['has_rtl'] = false; } self::enqueue_style( $handle, $args['src'], $args['deps'], $args['version'], $args['media'], $args['has_rtl'] ); } } // Placeholder style. wp_register_style( 'woocommerce-inline', false ); // phpcs:ignore wp_enqueue_style( 'woocommerce-inline' ); if ( true === wc_string_to_bool( get_option( 'woocommerce_checkout_highlight_required_fields', 'yes' ) ) ) { wp_add_inline_style( 'woocommerce-inline', '.woocommerce form .form-row .required { visibility: visible; }' ); } else { wp_add_inline_style( 'woocommerce-inline', '.woocommerce form .form-row .required { visibility: hidden; }' ); } } /** * Localize a WC script once. * * @since 2.3.0 this needs less wp_script_is() calls due to https://core.trac.wordpress.org/ticket/28404 being added in WP 4.0. * @param string $handle Script handle the data will be attached to. */ private static function localize_script( $handle ) { if ( ! in_array( $handle, self::$wp_localize_scripts, true ) && wp_script_is( $handle ) ) { $data = self::get_script_data( $handle ); if ( ! $data ) { return; } $name = str_replace( '-', '_', $handle ) . '_params'; self::$wp_localize_scripts[] = $handle; wp_localize_script( $handle, $name, apply_filters( $name, $data ) ); } } /** * Return data for script handles. * * @param string $handle Script handle the data will be attached to. * @return array|bool */ private static function get_script_data( $handle ) { global $wp; switch ( $handle ) { case 'woocommerce': $params = array( 'ajax_url' => WC()->ajax_url(), 'wc_ajax_url' => WC_AJAX::get_endpoint( '%%endpoint%%' ), 'i18n_password_show' => esc_attr__( 'Show password', 'woocommerce' ), 'i18n_password_hide' => esc_attr__( 'Hide password', 'woocommerce' ), ); break; case 'wc-geolocation': $params = array( 'wc_ajax_url' => WC_AJAX::get_endpoint( '%%endpoint%%' ), 'home_url' => remove_query_arg( 'lang', home_url() ), // FIX for WPML compatibility. ); break; case 'wc-single-product': $params = array( 'i18n_required_rating_text' => esc_attr__( 'Please select a rating', 'woocommerce' ), 'i18n_rating_options' => array( esc_attr__( '1 of 5 stars', 'woocommerce' ), esc_attr__( '2 of 5 stars', 'woocommerce' ), esc_attr__( '3 of 5 stars', 'woocommerce' ), esc_attr__( '4 of 5 stars', 'woocommerce' ), esc_attr__( '5 of 5 stars', 'woocommerce' ), ), 'i18n_product_gallery_trigger_text' => esc_attr__( 'View full-screen image gallery', 'woocommerce' ), 'review_rating_required' => wc_review_ratings_required() ? 'yes' : 'no', 'flexslider' => apply_filters( 'woocommerce_single_product_carousel_options', array( 'rtl' => is_rtl(), 'animation' => 'slide', 'smoothHeight' => true, 'directionNav' => false, 'controlNav' => 'thumbnails', 'slideshow' => false, 'animationSpeed' => 500, 'animationLoop' => false, // Breaks photoswipe pagination if true. 'allowOneSlide' => false, ) ), 'zoom_enabled' => apply_filters( 'woocommerce_single_product_zoom_enabled', get_theme_support( 'wc-product-gallery-zoom' ) ), 'zoom_options' => apply_filters( 'woocommerce_single_product_zoom_options', array() ), 'photoswipe_enabled' => apply_filters( 'woocommerce_single_product_photoswipe_enabled', get_theme_support( 'wc-product-gallery-lightbox' ) ), 'photoswipe_options' => apply_filters( 'woocommerce_single_product_photoswipe_options', array( 'shareEl' => false, 'closeOnScroll' => false, 'history' => false, 'hideAnimationDuration' => 0, 'showAnimationDuration' => 0, ) ), 'flexslider_enabled' => apply_filters( 'woocommerce_single_product_flexslider_enabled', get_theme_support( 'wc-product-gallery-slider' ) ), ); break; case 'wc-checkout': $params = array( 'ajax_url' => WC()->ajax_url(), 'wc_ajax_url' => WC_AJAX::get_endpoint( '%%endpoint%%' ), 'update_order_review_nonce' => wp_create_nonce( 'update-order-review' ), 'apply_coupon_nonce' => wp_create_nonce( 'apply-coupon' ), 'remove_coupon_nonce' => wp_create_nonce( 'remove-coupon' ), 'option_guest_checkout' => get_option( 'woocommerce_enable_guest_checkout' ), 'checkout_url' => WC_AJAX::get_endpoint( 'checkout' ), 'is_checkout' => is_checkout() && empty( $wp->query_vars['order-pay'] ) && ! isset( $wp->query_vars['order-received'] ) ? 1 : 0, 'debug_mode' => Constants::is_true( 'WP_DEBUG' ), /* translators: %s: Order history URL on My Account section */ 'i18n_checkout_error' => sprintf( esc_attr__( 'There was an error processing your order. Please check for any charges in your payment method and review your <a href="%s">order history</a> before placing the order again.', 'woocommerce' ), esc_url( wc_get_account_endpoint_url( 'orders' ) ) ), 'gateways_with_custom_place_order_button' => self::get_gateways_with_custom_place_order_button(), ); break; case 'wc-address-autocomplete-common': $providers = array(); try { $providers = wc_get_container()->get( AddressProviderController::class )->get_providers(); } catch ( Throwable $e ) { wc_get_logger()->error( 'Could not get address providers for wc-address-autocomplete script: ' . $e->getMessage(), array( 'source' => 'address-autocomplete' ) ); } $params = array( 'address_providers' => wp_json_encode( array_map( function ( $provider ) { // Escape provider data before sending to frontend. return array( 'id' => $provider->id, 'name' => $provider->name, 'branding_html' => wp_kses( trim( (string) ( $provider->branding_html ?? '' ) ), 'post' ), ); }, $providers ), JSON_HEX_TAG | JSON_UNESCAPED_SLASHES ), ); break; case 'wc-address-i18n': $params = array( 'locale' => wp_json_encode( WC()->countries->get_country_locale(), JSON_HEX_TAG | JSON_UNESCAPED_SLASHES ), 'locale_fields' => wp_json_encode( WC()->countries->get_country_locale_field_selectors(), JSON_HEX_TAG | JSON_UNESCAPED_SLASHES ), 'i18n_required_text' => esc_attr__( 'required', 'woocommerce' ), 'i18n_optional_text' => esc_html__( 'optional', 'woocommerce' ), ); break; case 'wc-cart': $params = array( 'ajax_url' => WC()->ajax_url(), 'wc_ajax_url' => WC_AJAX::get_endpoint( '%%endpoint%%' ), 'update_shipping_method_nonce' => wp_create_nonce( 'update-shipping-method' ), 'apply_coupon_nonce' => wp_create_nonce( 'apply-coupon' ), 'remove_coupon_nonce' => wp_create_nonce( 'remove-coupon' ), ); break; case 'wc-cart-fragments': $params = array( 'ajax_url' => WC()->ajax_url(), 'wc_ajax_url' => WC_AJAX::get_endpoint( '%%endpoint%%' ), 'cart_hash_key' => apply_filters( 'woocommerce_cart_hash_key', 'wc_cart_hash_' . md5( get_current_blog_id() . '_' . get_site_url( get_current_blog_id(), '/' ) . get_template() ) ), 'fragment_name' => apply_filters( 'woocommerce_cart_fragment_name', 'wc_fragments_' . md5( get_current_blog_id() . '_' . get_site_url( get_current_blog_id(), '/' ) . get_template() ) ), 'request_timeout' => 5000, ); break; case 'wc-add-to-cart': $params = array( 'ajax_url' => WC()->ajax_url(), 'wc_ajax_url' => WC_AJAX::get_endpoint( '%%endpoint%%' ), 'i18n_view_cart' => esc_attr__( 'View cart', 'woocommerce' ), 'cart_url' => apply_filters( 'woocommerce_add_to_cart_redirect', wc_get_cart_url(), null ), 'is_cart' => is_cart(), 'cart_redirect_after_add' => get_option( 'woocommerce_cart_redirect_after_add' ), ); break; case 'wc-add-payment-method': $params = array( 'gateways_with_custom_place_order_button' => self::get_gateways_with_custom_place_order_button(), ); break; case 'wc-add-to-cart-variation': // We also need the wp.template for this script :). wc_get_template( 'single-product/add-to-cart/variation.php' ); $params = array( 'wc_ajax_url' => WC_AJAX::get_endpoint( '%%endpoint%%' ), 'i18n_no_matching_variations_text' => esc_attr__( 'Sorry, no products matched your selection. Please choose a different combination.', 'woocommerce' ), 'i18n_make_a_selection_text' => esc_attr__( 'Please select some product options before adding this product to your cart.', 'woocommerce' ), 'i18n_unavailable_text' => esc_attr__( 'Sorry, this product is unavailable. Please choose a different combination.', 'woocommerce' ), 'i18n_reset_alert_text' => esc_attr__( 'Your selection has been reset. Please select some product options before adding this product to your cart.', 'woocommerce' ), ); break; case 'wc-country-select': $params = array( 'countries' => wp_json_encode( array_merge( WC()->countries->get_allowed_country_states(), WC()->countries->get_shipping_country_states() ), JSON_HEX_TAG | JSON_UNESCAPED_SLASHES ), 'i18n_select_state_text' => esc_attr__( 'Select an option&hellip;', 'woocommerce' ), 'i18n_no_matches' => _x( 'No matches found', 'enhanced select', 'woocommerce' ), 'i18n_ajax_error' => _x( 'Loading failed', 'enhanced select', 'woocommerce' ), 'i18n_input_too_short_1' => _x( 'Please enter 1 or more characters', 'enhanced select', 'woocommerce' ), 'i18n_input_too_short_n' => _x( 'Please enter %qty% or more characters', 'enhanced select', 'woocommerce' ), 'i18n_input_too_long_1' => _x( 'Please delete 1 character', 'enhanced select', 'woocommerce' ), 'i18n_input_too_long_n' => _x( 'Please delete %qty% characters', 'enhanced select', 'woocommerce' ), 'i18n_selection_too_long_1' => _x( 'You can only select 1 item', 'enhanced select', 'woocommerce' ), 'i18n_selection_too_long_n' => _x( 'You can only select %qty% items', 'enhanced select', 'woocommerce' ), 'i18n_load_more' => _x( 'Loading more results&hellip;', 'enhanced select', 'woocommerce' ), 'i18n_searching' => _x( 'Searching&hellip;', 'enhanced select', 'woocommerce' ), ); break; case 'wc-password-strength-meter': $params = array( 'min_password_strength' => apply_filters( 'woocommerce_min_password_strength', 3 ), 'stop_checkout' => apply_filters( 'woocommerce_enforce_password_strength_meter_on_checkout', false ), 'i18n_password_error' => esc_attr__( 'Please enter a stronger password.', 'woocommerce' ), 'i18n_password_hint' => esc_attr( wp_get_password_hint() ), ); break; default: $params = false; } $params = apply_filters_deprecated( $handle . '_params', array( $params ), '3.0.0', 'woocommerce_get_script_data' ); return apply_filters( 'woocommerce_get_script_data', $params, $handle ); } /** * Get a list of payment gateway IDs that have custom place order buttons. * * @return array List of gateway IDs with custom place order buttons. */ private static function get_gateways_with_custom_place_order_button() { $gateways_with_custom_button = array(); if ( ! WC()->payment_gateways() ) { return $gateways_with_custom_button; } $available_gateways = WC()->payment_gateways()->get_available_payment_gateways(); foreach ( $available_gateways as $gateway ) { // phpcs:ignore Squiz.PHP.CommentedOutCode.Found -- Type hint for PHPStan. /* @var WC_Payment_Gateway $gateway */ if ( true === $gateway->has_custom_place_order_button ) { $gateways_with_custom_button[] = $gateway->id; } } return $gateways_with_custom_button; } /** * Localize scripts only when enqueued. */ public static function localize_printed_scripts() { foreach ( self::$registered_scripts as $handle ) { self::localize_script( $handle ); } } } WC_Frontend_Scripts::init();