Changeset 12578

Timestamp:

03/25/2020 07:31:07 AM (6 years ago)

Author:

imath

Message:

Introduce the BP Blocks API into BP Core

• The BP_Block class is wrapping the WP_Block_Type one to manage JavaScript and CSS assets registration and script translations.
• To register a new BP Block, we are introducing a new function using this BP_Block class : bp_register_block().
• Registering BP Blocks needs to happen hooking the bp_blocks_init action.
• The BP_Component class now includes a new method BuddyPress components can use to register their blocks. It also makes sure this method is only usable if the BP REST API is available.
• The dynamic filter bp_{component_id}_register_blocks let developers add or disable BP component blocks.
• A dynamic action bp_{component_id}_blocks_init is fired once all corresponding BP component blocks has been registered.
• The bp_blocks_editor_settings filter is gathering specific BuddyPress editor settings into a bp object.

See #8048

Location:

trunk/src

Files:

• bp-core/bp-core-actions.php (modified) (1 diff)
• bp-core/bp-core-blocks.php (added)
• bp-core/bp-core-dependency.php (modified) (1 diff)
• bp-core/classes/class-bp-block.php (added)
• bp-core/classes/class-bp-component.php (modified) (2 diffs)
• class-buddypress.php (modified) (2 diffs)

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

@@ -76 +76 @@
 add_action( 'bp_init', 'bp_setup_nav',               6  );
 add_action( 'bp_init', 'bp_setup_title',             8  );
+add_action( 'bp_init', 'bp_blocks_init',             10 );
 add_action( 'bp_init', 'bp_core_load_admin_bar_css', 12 );
 add_action( 'bp_init', 'bp_add_rewrite_tags',        20 );

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

@@ -269 +269 @@
 
 /**
+ * BP Blocks Init hook.
+ *
+ * @since 6.0.0
+ */
+function bp_blocks_init() {
+    /**
+     * Hook here to register your BuddyPress blocks.
+     *
+     * @since 6.0.0
+     */
+    do_action( 'bp_blocks_init' );
+}
+
+/**
  * Fire the 'bp_customize_register' action when the Customizer has loaded,
  * allowing scripts and styles to be initialized.

trunk/src/bp-core/classes/class-bp-component.php

@@ -467 +467 @@
         }
 
+        // Register BP Blocks.
+        if ( bp_rest_api_is_available() ) {
+            add_action( 'bp_blocks_init', array( $this, 'blocks_init' ), 10 );
+        }
+
         /**
          * Fires at the end of the setup_actions method inside BP_Component.
@@ -907 +912 @@
         do_action( 'bp_' . $this->id . '_rest_api_init' );
     }
+
+    /**
+     * Register the BP Blocks.
+     *
+     * @since 6.0.0
+     *
+     * @param array $blocks The list of BP Blocks to register.
+     */
+    public function blocks_init( $blocks = array() ) {
+        if ( is_array( $blocks ) && $blocks ) {
+            /**
+             * Filter here to disable all or some BP Blocks for a component.
+             *
+             * This is a dynamic hook that is based on the component string ID.
+             *
+             * @since 6.0.0
+             *
+             * @param array $blocks The list of BP Blocks for the component.
+             */
+            $blocks = (array) apply_filters( 'bp_' . $this->id . '_register_blocks', $blocks );
+
+            foreach ( $blocks as $block ) {
+                bp_register_block( $block );
+            }
+        }
+
+        /**
+         * Fires in the blocks_init method inside BP_Component.
+         *
+         * This is a dynamic hook that is based on the component string ID.
+         *
+         * @since 6.0.0
+         */
+        do_action( 'bp_' . $this->id . '_blocks_init' );
+    }
 }
 endif; // BP_Component.

trunk/src/class-buddypress.php

@@ -489 +489 @@
         require( $this->plugin_dir . 'bp-core/bp-core-customizer-email.php' );
         require( $this->plugin_dir . 'bp-core/bp-core-rest-api.php'         );
+        require( $this->plugin_dir . 'bp-core/bp-core-blocks.php'           );
 
         // Maybe load deprecated functionality (this double negative is proof positive!).
@@ -555 +556 @@
             'BP_Attachment'                              => 'core',
             'BP_Button'                                  => 'core',
+            'BP_Block'                                   => 'core',
             'BP_Component'                               => 'core',
             'BP_Customizer_Control_Range'                => 'core',