diff --git a/plugins/woocommerce-blocks/src/Assets.php b/plugins/woocommerce-blocks/src/Assets.php index 50c1854dca6..e123da43f92 100644 --- a/plugins/woocommerce-blocks/src/Assets.php +++ b/plugins/woocommerce-blocks/src/Assets.php @@ -10,6 +10,7 @@ namespace Automattic\WooCommerce\Blocks; defined( 'ABSPATH' ) || exit; use Automattic\WooCommerce\Blocks\Package; +use Automattic\WooCommerce\Blocks\Assets\Api as AssetApi; /** * Assets class. @@ -38,19 +39,20 @@ class Assets { * as part of ongoing refactoring. */ public static function register_assets() { - self::register_style( 'wc-block-vendors-style', plugins_url( self::get_block_asset_build_path( 'vendors-style', 'css' ), __DIR__ ), [] ); - self::register_style( 'wc-block-editor', plugins_url( self::get_block_asset_build_path( 'editor', 'css' ), __DIR__ ), array( 'wp-edit-blocks' ) ); + $asset_api = Package::container()->get( AssetApi::class ); + self::register_style( 'wc-block-vendors-style', plugins_url( $asset_api->get_block_asset_build_path( 'vendors-style', 'css' ), __DIR__ ), [] ); + self::register_style( 'wc-block-editor', plugins_url( $asset_api->get_block_asset_build_path( 'editor', 'css' ), __DIR__ ), array( 'wp-edit-blocks' ) ); wp_style_add_data( 'wc-block-editor', 'rtl', 'replace' ); - self::register_style( 'wc-block-style', plugins_url( self::get_block_asset_build_path( 'style', 'css' ), __DIR__ ), array( 'wc-block-vendors-style' ) ); + self::register_style( 'wc-block-style', plugins_url( $asset_api->get_block_asset_build_path( 'style', 'css' ), __DIR__ ), array( 'wc-block-vendors-style' ) ); wp_style_add_data( 'wc-block-style', 'rtl', 'replace' ); // Shared libraries and components across all blocks. - self::register_script( 'wc-blocks-middleware', plugins_url( 'build/wc-blocks-middleware.js', __DIR__ ), [], false ); - self::register_script( 'wc-blocks-data-store', plugins_url( 'build/wc-blocks-data.js', __DIR__ ), [ 'wc-blocks-middleware' ], false ); - self::register_script( 'wc-blocks', plugins_url( self::get_block_asset_build_path( 'blocks' ), __DIR__ ), [], false ); - self::register_script( 'wc-vendors', plugins_url( self::get_block_asset_build_path( 'vendors' ), __DIR__ ), [], false ); - self::register_script( 'wc-blocks-registry', plugins_url( 'build/wc-blocks-registry.js', __DIR__ ), [], false ); - self::register_script( 'wc-shared-context', plugins_url( 'build/wc-shared-context.js', __DIR__ ), [], false ); + $asset_api->register_script( 'wc-blocks-middleware', 'build/wc-blocks-middleware.js', [], false ); + $asset_api->register_script( 'wc-blocks-data-store', 'build/wc-blocks-data.js', [ 'wc-blocks-middleware' ], false ); + $asset_api->register_script( 'wc-blocks', $asset_api->get_block_asset_build_path( 'blocks' ), [], false ); + $asset_api->register_script( 'wc-vendors', $asset_api->get_block_asset_build_path( 'vendors' ), [], false ); + $asset_api->register_script( 'wc-blocks-registry', 'build/wc-blocks-registry.js', [], false ); + $asset_api->register_script( 'wc-shared-context', 'build/wc-shared-context.js', [], false ); // Inline data. wp_add_inline_script( @@ -62,33 +64,33 @@ class Assets { // Individual blocks. $block_dependencies = array( 'wc-vendors', 'wc-blocks' ); - self::register_script( 'wc-handpicked-products', plugins_url( self::get_block_asset_build_path( 'handpicked-products' ), __DIR__ ), $block_dependencies ); - self::register_script( 'wc-product-best-sellers', plugins_url( self::get_block_asset_build_path( 'product-best-sellers' ), __DIR__ ), $block_dependencies ); - self::register_script( 'wc-product-category', plugins_url( self::get_block_asset_build_path( 'product-category' ), __DIR__ ), $block_dependencies ); - self::register_script( 'wc-product-new', plugins_url( self::get_block_asset_build_path( 'product-new' ), __DIR__ ), $block_dependencies ); - self::register_script( 'wc-product-on-sale', plugins_url( self::get_block_asset_build_path( 'product-on-sale' ), __DIR__ ), $block_dependencies ); - self::register_script( 'wc-product-top-rated', plugins_url( self::get_block_asset_build_path( 'product-top-rated' ), __DIR__ ), $block_dependencies ); - self::register_script( 'wc-products-by-attribute', plugins_url( self::get_block_asset_build_path( 'products-by-attribute' ), __DIR__ ), $block_dependencies ); - self::register_script( 'wc-featured-product', plugins_url( self::get_block_asset_build_path( 'featured-product' ), __DIR__ ), $block_dependencies ); - self::register_script( 'wc-featured-category', plugins_url( self::get_block_asset_build_path( 'featured-category' ), __DIR__ ), $block_dependencies ); - self::register_script( 'wc-product-categories', plugins_url( self::get_block_asset_build_path( 'product-categories' ), __DIR__ ), $block_dependencies ); - self::register_script( 'wc-product-tag', plugins_url( self::get_block_asset_build_path( 'product-tag' ), __DIR__ ), $block_dependencies ); - self::register_script( 'wc-all-reviews', plugins_url( self::get_block_asset_build_path( 'all-reviews' ), __DIR__ ), $block_dependencies ); - self::register_script( 'wc-reviews-by-product', plugins_url( self::get_block_asset_build_path( 'reviews-by-product' ), __DIR__ ), $block_dependencies ); - self::register_script( 'wc-reviews-by-category', plugins_url( self::get_block_asset_build_path( 'reviews-by-category' ), __DIR__ ), $block_dependencies ); - self::register_script( 'wc-product-search', plugins_url( self::get_block_asset_build_path( 'product-search' ), __DIR__ ), $block_dependencies ); - self::register_script( 'wc-all-products', plugins_url( self::get_block_asset_build_path( 'all-products' ), __DIR__ ), $block_dependencies ); - self::register_script( 'wc-price-filter', plugins_url( self::get_block_asset_build_path( 'price-filter' ), __DIR__ ), $block_dependencies ); - self::register_script( 'wc-attribute-filter', plugins_url( self::get_block_asset_build_path( 'attribute-filter' ), __DIR__ ), $block_dependencies ); - self::register_script( 'wc-active-filters', plugins_url( self::get_block_asset_build_path( 'active-filters' ), __DIR__ ), $block_dependencies ); + $asset_api->register_script( 'wc-handpicked-products', $asset_api->get_block_asset_build_path( 'handpicked-products' ), $block_dependencies ); + $asset_api->register_script( 'wc-product-best-sellers', $asset_api->get_block_asset_build_path( 'product-best-sellers' ), $block_dependencies ); + $asset_api->register_script( 'wc-product-category', $asset_api->get_block_asset_build_path( 'product-category' ), $block_dependencies ); + $asset_api->register_script( 'wc-product-new', $asset_api->get_block_asset_build_path( 'product-new' ), $block_dependencies ); + $asset_api->register_script( 'wc-product-on-sale', $asset_api->get_block_asset_build_path( 'product-on-sale' ), $block_dependencies ); + $asset_api->register_script( 'wc-product-top-rated', $asset_api->get_block_asset_build_path( 'product-top-rated' ), $block_dependencies ); + $asset_api->register_script( 'wc-products-by-attribute', $asset_api->get_block_asset_build_path( 'products-by-attribute' ), $block_dependencies ); + $asset_api->register_script( 'wc-featured-product', $asset_api->get_block_asset_build_path( 'featured-product' ), $block_dependencies ); + $asset_api->register_script( 'wc-featured-category', $asset_api->get_block_asset_build_path( 'featured-category' ), $block_dependencies ); + $asset_api->register_script( 'wc-product-categories', $asset_api->get_block_asset_build_path( 'product-categories' ), $block_dependencies ); + $asset_api->register_script( 'wc-product-tag', $asset_api->get_block_asset_build_path( 'product-tag' ), $block_dependencies ); + $asset_api->register_script( 'wc-all-reviews', $asset_api->get_block_asset_build_path( 'all-reviews' ), $block_dependencies ); + $asset_api->register_script( 'wc-reviews-by-product', $asset_api->get_block_asset_build_path( 'reviews-by-product' ), $block_dependencies ); + $asset_api->register_script( 'wc-reviews-by-category', $asset_api->get_block_asset_build_path( 'reviews-by-category' ), $block_dependencies ); + $asset_api->register_script( 'wc-product-search', $asset_api->get_block_asset_build_path( 'product-search' ), $block_dependencies ); + $asset_api->register_script( 'wc-all-products', $asset_api->get_block_asset_build_path( 'all-products' ), $block_dependencies ); + $asset_api->register_script( 'wc-price-filter', $asset_api->get_block_asset_build_path( 'price-filter' ), $block_dependencies ); + $asset_api->register_script( 'wc-attribute-filter', $asset_api->get_block_asset_build_path( 'attribute-filter' ), $block_dependencies ); + $asset_api->register_script( 'wc-active-filters', $asset_api->get_block_asset_build_path( 'active-filters' ), $block_dependencies ); if ( Package::is_experimental_build() ) { - self::register_script( 'wc-single-product-block', plugins_url( self::get_block_asset_build_path( 'single-product' ), __DIR__ ), $block_dependencies ); + $asset_api->register_script( 'wc-single-product-block', $asset_api->get_block_asset_build_path( 'single-product' ), $block_dependencies ); } if ( Package::is_feature_plugin_build() ) { - self::register_script( 'wc-checkout-block', plugins_url( self::get_block_asset_build_path( 'checkout' ), __DIR__ ), $block_dependencies ); - self::register_script( 'wc-cart-block', plugins_url( self::get_block_asset_build_path( 'cart' ), __DIR__ ), $block_dependencies ); + $asset_api->register_script( 'wc-checkout-block', $asset_api->get_block_asset_build_path( 'checkout' ), $block_dependencies ); + $asset_api->register_script( 'wc-cart-block', $asset_api->get_block_asset_build_path( 'cart' ), $block_dependencies ); } } @@ -231,48 +233,19 @@ class Assets { } /** - * Registers a script according to `wp_register_script`, additionally loading the translations for the file. - * - * @since 2.0.0 - * - * @param string $handle Name of the script. Should be unique. - * @param string $src Full URL of the script, or path of the script relative to the WordPress root directory. - * @param array $dependencies Optional. An array of registered script handles this script depends on. Default empty array. - * @param bool $has_i18n Optional. Whether to add a script translation call to this file. Default 'true'. - */ - protected static function register_script( $handle, $src, $dependencies = [], $has_i18n = true ) { - $relative_src = str_replace( plugins_url( '/', __DIR__ ), '', $src ); - $asset_path = dirname( __DIR__ ) . '/' . str_replace( '.js', '.asset.php', $relative_src ); - - if ( file_exists( $asset_path ) ) { - $asset = require $asset_path; - $dependencies = isset( $asset['dependencies'] ) ? array_merge( $asset['dependencies'], $dependencies ) : $dependencies; - $version = ! empty( $asset['version'] ) ? $asset['version'] : self::get_file_version( $relative_src ); - } else { - $version = self::get_file_version( $relative_src ); - } - - wp_register_script( $handle, $src, apply_filters( 'woocommerce_blocks_register_script_dependencies', $dependencies, $handle ), $version, true ); - - if ( $has_i18n && function_exists( 'wp_set_script_translations' ) ) { - wp_set_script_translations( $handle, 'woo-gutenberg-products-block', dirname( __DIR__ ) . '/languages' ); - } - } - - /** - * Queues a block script. + * Queues a block script in the frontend. * * @since 2.3.0 * @since 2.6.0 Changed $name to $script_name and added $handle argument. + * @since 2.9.0 Made it so scripts are not loaded in admin pages. * * @param string $script_name Name of the script used to identify the file inside build folder. * @param string $handle Optional. Provided if the handle should be different than the script name. `wc-` prefix automatically added. * @param array $dependencies Optional. An array of registered script handles this script depends on. Default empty array. */ public static function register_block_script( $script_name, $handle = '', $dependencies = [] ) { - $handle = '' !== $handle ? $handle : $script_name; - self::register_script( 'wc-' . $handle, plugins_url( self::get_block_asset_build_path( $script_name ), __DIR__ ), $dependencies ); - wp_enqueue_script( 'wc-' . $handle ); + $asset_api = Package::container()->get( AssetApi::class ); + $asset_api->register_block_script( $script_name, $handle, $dependencies ); } /** @@ -291,21 +264,4 @@ class Assets { $ver = self::get_file_version( $filename ); wp_register_style( $handle, $src, $deps, $ver, $media ); } - - /** - * Returns the appropriate asset path for loading either legacy builds or - * current builds. - * - * @param string $filename Filename for asset path (without extension). - * @param string $type File type (.css or .js). - * - * @return string The generated path. - */ - protected static function get_block_asset_build_path( $filename, $type = 'js' ) { - global $wp_version; - $suffix = version_compare( $wp_version, '5.2', '>' ) - ? '' - : '-legacy'; - return "build/$filename$suffix.$type"; - } } diff --git a/plugins/woocommerce-blocks/src/Assets/Api.php b/plugins/woocommerce-blocks/src/Assets/Api.php index c08bb457611..dccea5ba4aa 100644 --- a/plugins/woocommerce-blocks/src/Assets/Api.php +++ b/plugins/woocommerce-blocks/src/Assets/Api.php @@ -40,7 +40,7 @@ class Api { * @return string The cache buster value to use for the given file. */ protected function get_file_version( $file ) { - if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) { + if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG && file_exists( $this->package->get_path() . $file ) ) { return filemtime( $this->package->get_path( trim( $file, '/' ) ) ); } return $this->package->get_version(); @@ -88,7 +88,7 @@ class Api { $version = $this->get_file_version( $relative_src ); } - wp_register_script( $handle, $src, $dependencies, $version, true ); + wp_register_script( $handle, $src, apply_filters( 'woocommerce_blocks_register_script_dependencies', $dependencies, $handle ), $version, true ); if ( $has_i18n && function_exists( 'wp_set_script_translations' ) ) { wp_set_script_translations( $handle, 'woo-gutenberg-products-block', $this->package->get_path( 'languages' ) ); @@ -96,18 +96,23 @@ class Api { } /** - * Queues a block script. + * Queues a block script in the frontend. * * @since 2.5.0 * @since 2.6.0 Changed $name to $script_name and added $handle argument. + * @since 2.9.0 Made it so scripts are not loaded in admin pages. * - * @param string $script_name Name of the script used to identify the file inside build folder . - * @param string $handle Provided if the handle should be different than the script name . `wc-` prefix automatically added . + * @param string $script_name Name of the script used to identify the file inside build folder. + * @param string $handle Optional. Provided if the handle should be different than the script name. `wc-` prefix automatically added. + * @param array $dependencies Optional. An array of registered script handles this script depends on. Default empty array. */ - public function register_block_script( $script_name, $handle = '' ) { - $src = 'build/' . $script_name . '.js'; - $handle = '' !== $handle ? 'wc-' . $handle : 'wc-' . $script_name; - $this->register_script( $handle, $src ); + public function register_block_script( $script_name, $handle = '', $dependencies = [] ) { + if ( is_admin() ) { + return; + } + $relative_src = $this->get_block_asset_build_path( $script_name ); + $handle = '' !== $handle ? 'wc-' . $handle : 'wc-' . $script_name; + $this->register_script( $handle, $relative_src, $dependencies ); wp_enqueue_script( $handle ); } @@ -129,4 +134,21 @@ class Api { $ver = $this->get_file_version( $filename ); wp_register_style( $handle, $src, $deps, $ver, $media ); } + + /** + * Returns the appropriate asset path for loading either legacy builds or + * current builds. + * + * @param string $filename Filename for asset path (without extension). + * @param string $type File type (.css or .js). + * + * @return string The generated path. + */ + public function get_block_asset_build_path( $filename, $type = 'js' ) { + global $wp_version; + $suffix = version_compare( $wp_version, '5.3', '>=' ) + ? '' + : '-legacy'; + return "build/$filename$suffix.$type"; + } } diff --git a/plugins/woocommerce-blocks/src/Library.php b/plugins/woocommerce-blocks/src/Library.php index 1ecd3d07c62..42cbfdf1574 100644 --- a/plugins/woocommerce-blocks/src/Library.php +++ b/plugins/woocommerce-blocks/src/Library.php @@ -69,7 +69,7 @@ class Library { ]; // Note: as a part of refactoring dynamic block registration, this will be moved // to block level config. - if ( version_compare( $wp_version, '5.2', '>' ) ) { + if ( version_compare( $wp_version, '5.3', '>=' ) ) { $blocks[] = 'AllProducts'; $blocks[] = 'PriceFilter'; $blocks[] = 'AttributeFilter';