Skip to content
This repository has been archived by the owner on Feb 23, 2024. It is now read-only.

Refactor block types to include script registration and integration classes #3829

Merged
merged 11 commits into from
Feb 17, 2021
Merged

Refactor block types to include script registration and integration classes #3829

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
4bd33dc
Move bulk of payment registry/interface to more generic classes
mikejolley Feb 10, 2021
3db2aa5
Implement registries for block types
mikejolley Feb 10, 2021
9276b4c
Split editor and frontend integration contexts
mikejolley Feb 11, 2021
06170c6
Make abstract dynamic blocks extend the abstract block class
mikejolley Feb 11, 2021
18018c8
Remove block type scripts from assets
mikejolley Feb 11, 2021
0c070e8
deprecate register_block_script
mikejolley Feb 11, 2021
108d346
Updates remaining blocks with new AbstactBlock which takes care of sc…
mikejolley Feb 11, 2021
3ff4c44
Add suffix to integration registry
mikejolley Feb 11, 2021
17c1ec2
rename translator comment
mikejolley Feb 15, 2021
087cb82
clarify method comment
mikejolley Feb 15, 2021
23ee1cc
Wrong variable after rebase
mikejolley Feb 17, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 0 additions & 10 deletions docs/contributors/block-assets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,13 +44,3 @@ protected function enqueue_data( array $attributes = [] ) {
$data_registry->add( 'some-asset-data', 'data-value' );
}
```

### AbstractBlock::enqueue_scripts

If extending `AbstractBlock` this method can be overridden. It should register scripts used by the block. This is more commonly used for frontend scripts.

```php
protected function enqueue_scripts( array $attributes = [] ) {
Automattic\WooCommerce\Blocks\Assets::register_block_script( $this->block_name . '-frontend', $this->block_name . '-block-frontend' );
}
```
47 changes: 10 additions & 37 deletions src/Assets.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,20 +48,25 @@ public static function register_assets() {

self::register_style( 'wc-block-vendors-style', plugins_url( $asset_api->get_block_asset_build_path( 'vendors-style', 'css' ), __DIR__ ), $block_style_dependencies );
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( $asset_api->get_block_asset_build_path( 'style', 'css' ), __DIR__ ), array( 'wc-block-vendors-style' ) );

wp_style_add_data( 'wc-block-editor', 'rtl', 'replace' );
wp_style_add_data( 'wc-block-style', 'rtl', 'replace' );

// Shared libraries and components across all blocks.
// Shared libraries and components across multiple blocks.
$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 );
$asset_api->register_script( 'wc-shared-hocs', 'build/wc-shared-hocs.js', [], false );
$asset_api->register_script( 'wc-price-format', 'build/price-format.js', [], false );

if ( Package::feature()->is_feature_plugin_build() ) {
$asset_api->register_script( 'wc-blocks-checkout', 'build/blocks-checkout.js', [], false );
}

// Inline data.
wp_add_inline_script(
'wc-blocks-middleware',
"
Expand All @@ -70,40 +75,6 @@ public static function register_assets() {
",
'before'
);

// Individual blocks.
$block_dependencies = array( 'wc-vendors', 'wc-blocks' );

$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::feature()->is_experimental_build() ) {
$asset_api->register_script( 'wc-single-product-block', $asset_api->get_block_asset_build_path( 'single-product' ), $block_dependencies );
}
$asset_api->register_script( 'wc-price-format', 'build/price-format.js', [], false );

if ( Package::feature()->is_feature_plugin_build() ) {
$asset_api->register_script( 'wc-blocks-checkout', 'build/blocks-checkout.js', [], false );
$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 );
}
}

/**
Expand Down Expand Up @@ -272,12 +243,14 @@ protected static function get_file_version( $file ) {
* @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.
* @deprecated 4.5.0 Block types register the scripts themselves.
*
* @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 = [] ) {
_deprecated_function( 'register_block_script', '4.5.0' );
$asset_api = Package::container()->get( AssetApi::class );
$asset_api->register_block_script( $script_name, $handle, $dependencies );
}
Expand Down
2 changes: 2 additions & 0 deletions src/Assets/Api.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,12 +116,14 @@ function() use ( $handle ) {
* @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.
* @deprecated 4.5.0 Block types register the scripts themselves.
*
* @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 = '', $dependencies = [] ) {
_deprecated_function( 'register_block_script', '4.5.0' );
if ( is_admin() ) {
return;
}
Expand Down
Loading