Changeset 13464 for trunk/src/bp-core/bp-core-blocks.php

Timestamp:

04/25/2023 10:17:33 PM (18 months ago)

Author:

imath

Message:

Update all BP Blocks & Modern JS PHP registration code

• Use the metadata argument of the bp_register_block() function to load all BP Blocks JSON files.
• Get BP Blocks dependencies using the @wordpress/scripts index.asset.php generated files.
• Although the BP Blocks category has been replaced by the BP Blocks collection, leave the no more used bp_block_category() function in place in case some third party plugins are using it for their custom blocks.
• PHPUnit tests: make sure to unregister all BP Blocks when using the BP_UnitTestCase->go_to() method.

See #8842
Fixes #8457
Closes ​https://github.com/buddypress/buddypress/pull/92

File:

• trunk/src/bp-core/bp-core-blocks.php (modified) (2 diffs)

trunk/src/bp-core/bp-core-blocks.php

@@ -36 +36 @@
  * @since 9.0.0 Adds a dependency to `wp-server-side-render` if WP >= 5.3.
  *              Uses a dependency to `wp-editor` otherwise.
+ * @since 12.0.0 Uses the `@wordpress/scripts` `index.asset.php` generated file to get dependencies.
  */
 function bp_register_block_components() {
+    $asset      = array(
+        'dependencies' => array(),
+        'version'      => bp_get_version(),
+    );
+    $asset_file = trailingslashit( dirname( __FILE__ ) ) . 'blocks/block-components/index.asset.php';
+
+    if ( file_exists( $asset_file ) ) {
+        $asset = require $asset_file;
+    }
+
     wp_register_script(
         'bp-block-components',
-        plugins_url( 'js/block-components.js', __FILE__ ),
-        array(
-            'wp-element',
-            'wp-components',
-            'wp-i18n',
-            'wp-api-fetch',
-            'wp-url',
-        ),
-        bp_get_version(),
+        plugins_url( 'blocks/block-components/index.js', __FILE__ ),
+        $asset['dependencies'],
+        $asset['version'],
         false
     );
-
-    // Adds BP Block Components to the `bp` global.
-    wp_add_inline_script(
-        'bp-block-components',
-        'window.bp = window.bp || {};
-        bp.blockComponents = bpBlock.blockComponents;
-        delete bpBlock;',
-        'after'
-    );
 }
 add_action( 'bp_blocks_init', 'bp_register_block_components', 1 );
@@ -67 +63 @@
  *
  * @since 9.0.0
+ * @since 12.0.0 Adds the BuddyPress Blocks collection & uses the `@wordpress/scripts`
+ *               `index.asset.php` generated file to get dependencies.
  */
 function bp_register_block_assets() {
+    $default_asset   = array(
+        'dependencies' => array(),
+        'version'      => bp_get_version(),
+    );
+    $asset_data_file = trailingslashit( dirname( __FILE__ ) ) . 'blocks/block-data/index.asset.php';
+
+    if ( file_exists( $asset_data_file ) ) {
+        $asset_data = require $asset_data_file;
+    } else {
+        $asset_data = $default_asset;
+    }
+
     wp_register_script(
         'bp-block-data',
-        plugins_url( 'js/block-data.js', __FILE__ ),
-        array(
-            'wp-data',
-            'wp-api-fetch',
-            'lodash',
-        ),
-        bp_get_version(),
+        plugins_url( 'blocks/block-data/index.js', __FILE__ ),
+        $asset_data['dependencies'],
+        $asset_data['version'],
         false
     );
 
-    // Adds BP Block Assets to the `bp` global.
-    wp_add_inline_script(
-        'bp-block-data',
-        sprintf(
-            'window.bp = window.bp || {};
-            bp.blockData = bpBlock.blockData;
-            bp.blockData.embedScriptURL = \'%s\';
-            delete bpBlock;',
-            esc_url_raw( includes_url( 'js/wp-embed.min.js' ) )
-        ),
-        'after'
+    $asset_collection_file = trailingslashit( dirname( __FILE__ ) ) . 'blocks/block-collection/index.asset.php';
+
+    if ( file_exists( $asset_collection_file ) ) {
+        $asset_collection = require $asset_collection_file;
+    } else {
+        $asset_collection = $default_asset;
+    }
+
+    wp_register_script(
+        'bp-blocks-collection',
+        plugins_url( 'blocks/block-collection/index.js', __FILE__ ),
+        $asset_collection['dependencies'],
+        $asset_collection['version'],
+        false
     );
 }
 add_action( 'bp_blocks_init', 'bp_register_block_assets', 2 );
+
+/**
+ * Enqueue additional BP Assets for the Block Editor.
+ *
+ * @since 12.0.0
+ */
+function bp_enqueue_block_editor_assets() {
+    wp_enqueue_script( 'bp-blocks-collection' );
+
+    /**
+     * Fires when it's time to enqueue BP Block assets.
+     *
+     * @since 12.0.0
+     */
+    do_action( 'bp_enqueue_block_editor_assets' );
+}
+add_action( 'enqueue_block_editor_assets', 'bp_enqueue_block_editor_assets', 9 );
 
 /**