Changeset 12994 for trunk/src/bp-core/classes/class-bp-block.php

Timestamp:

07/12/2021 07:48:13 PM (5 years ago)

Author:

imath

Message:

Make sure all BP components init their BP Blocks

Even if some components don't have native BP Blocks, it makes it easier for developers to add their custom blocks or override existing BP Blocks or disable BP Blocks. Working on the BP Blocks feature as a plugin made us realize this.

This commit also improves the BP_Block constructor inline documentation, adds a new method to the Core component to register REST controllers and moves the BP_REST_Components_Endpoint one from the Members component to the Core component.

Fixes #8511

File:

• trunk/src/bp-core/classes/class-bp-block.php (modified) (1 diff)

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

@@ -48 +48 @@
      * @since 6.0.0
      *
-     * @param array $args The registration arguments for the BP Block.
+     * @param array $args {
+     *     The registration arguments for the BP Block. Part of the arguments are the ones
+     *     used by `WP_Block_Type`. Below are BP specific arguments.
+     *
+     *     @type string $name               The name of the block (eg: `bp/member`).
+     *     @type string $editor_script_url  URL to the JavaScript main file of the BP Block
+     *                                      to load into the Block Editor.
+     *     @type array  $editor_script_deps The list of JavaScript dependency handles for the
+     *                                      BP Block main file.
+     *     @type string $script_url         URL to the JavaScript file to load into the Block
+     *                                      Editor and on front-end.
+     *     @type array  $script_deps        The list of JavaScript dependency handles for the
+     *                                      JavaScript file to load into the Block Editor and
+     *                                      on front-end.
+     *     @type string $editor_style_url   URL to the CSS main file of the BP Block to load
+     *                                      into the Block Editor.
+     *     @type array  $editor_style_deps  The list of CSS dependency handles for the
+     *                                      CSS main file.
+     *     @type string $style_url          URL to the CSS file to load into the Block Editor
+     *                                      and on front-end.
+     *     @type array  $style_deps         The list of CSS dependency handles for the CSS file
+     *                                      to load into the Block Editor and on front-end.
+     * }
      */
     public function __construct( $args ) {