Changeset 13000

Timestamp:

07/14/2021 10:52:40 AM (5 years ago)

Author:

imath

Message:

Merge the BP Blocks plugin's 'bp/primary-nav' Block into Core/Nouveau

• Adapt Grunt sass task.
• Add the Block JavaScript source files into src/js/bp-core/js/blocks.
• Add the Block Scss source file into src/bp-templates/bp-nouveau/sass.
• Generate the development files to ease testing.
• Add filters to register the Block and its globals into the BP Core component.
• Limit the Widget Block to the Widget Block Editor context.

Fixes #8518

Location:

trunk

Files:

• Gruntfile.js (modified) (2 diffs)
• src/bp-core/classes/class-bp-core.php (modified) (1 diff)
• src/bp-core/js/blocks/primary-nav.js (added)
• src/bp-templates/bp-nouveau/css/primary-nav-rtl.css (added)
• src/bp-templates/bp-nouveau/css/primary-nav.css (added)
• src/bp-templates/bp-nouveau/includes/functions.php (modified) (2 diffs)
• src/bp-templates/bp-nouveau/sass/primary-nav.scss (added)
• src/js/bp-core/js/blocks/primary-nav (added)
• src/js/bp-core/js/blocks/primary-nav.js (added)
• src/js/bp-core/js/blocks/primary-nav/edit.js (added)
• src/js/bp-core/js/blocks/primary-nav/transforms.js (added)

trunk/Gruntfile.js

@@ -34 +34 @@
                         '!bp-templates/bp-nouveau/css/buddypress.css',
                         '!bp-templates/bp-nouveau/css/twenty*.css',
+                        '!bp-templates/bp-nouveau/css/primary-nav.css',
                         '!bp-core/admin/css/hello.css',
                         '!bp-members/css/blocks/member.css',
@@ -120 +121 @@
                                 ext: '.css',
                                 flatten: true,
-                                src: ['bp-templates/bp-nouveau/sass/buddypress.scss', 'bp-templates/bp-nouveau/sass/twenty*.scss'],
+                                src: ['bp-templates/bp-nouveau/sass/buddypress.scss', 'bp-templates/bp-nouveau/sass/twenty*.scss', 'bp-templates/bp-nouveau/sass/primary-nav.scss'],
                                 dest: SOURCE_DIR + 'bp-templates/bp-nouveau/css/'
                         },

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

@@ -296 +296 @@
                                 'block_globals' => array(
                                         'bp/login-form' => array(
-                                                'widget_classnames' => array ( 'widget_bp_core_login_widget', 'buddypress' ),
+                                                'widget_classnames' => array( 'widget_bp_core_login_widget', 'buddypress' ),
                                         )
                                 )

trunk/src/bp-templates/bp-nouveau/includes/functions.php

@@ -4 +4 @@
  *
  * @since 3.0.0
- * @version 8.0.0
+ * @version 9.0.0
  */
 
@@ -1490 +1490 @@
         return apply_filters( 'bp_nouveau_get_component_slug', $slug, $component_id );
 }
+
+/**
+ * Registers the 'bp/primary-nav' Widget Block.
+ *
+ * @since 9.0.0
+ *
+ * @param array $blocks The Core Blocks list.
+ * @return array The Core Blocks list.
+ */
+function bp_nouveau_register_primary_nav_widget_block( $blocks = array() ) {
+        $editor_style = bp_locate_template_asset( 'css/primary-nav.css' );
+
+        $blocks['bp/primary-nav'] = array(
+                'name'               => 'bp/primary-nav',
+                'editor_script'      => 'bp-primary-nav-block',
+                'editor_script_url'  => trailingslashit( buddypress()->plugin_url . 'bp-core' ) . 'js/blocks/primary-nav.js',
+                'editor_script_deps' => array(
+                        'wp-blocks',
+                        'wp-element',
+                        'wp-components',
+                        'wp-i18n',
+                        'wp-block-editor',
+                        'bp-block-data',
+                        'bp-block-components',
+                ),
+                'editor_style'       => 'bp-primary-nav-block',
+                'editor_style_url'   => $editor_style['uri'],
+                'attributes'         => array(
+                        'displayTitle' => array(
+                                'type'    => 'boolean',
+                                'default' => true,
+                        ),
+                ),
+                'render_callback'    => 'bp_nouveau_render_primary_nav_block',
+        );
+
+        return $blocks;
+}
+add_filter( 'bp_core_register_blocks', 'bp_nouveau_register_primary_nav_widget_block', 20, 1 );
+
+/**
+ * Registers the 'bp/primary-nav' Widget Block classnames.
+ *
+ * @since 9.0.0
+ *
+ * @param array $block_globals The list of global properties for Core blocks.
+ * @return array               The list of global properties for Core blocks.
+ */
+function bp_nouveau_register_core_block_globals( $block_globals = array() ) {
+        $block_globals['bp/primary-nav'] = array(
+                'widget_classnames' => array( 'widget_nav_menu', 'buddypress_object_nav', 'buddypress' ),
+        );
+
+        return $block_globals;
+}
+add_filter( 'bp_core_block_globals', 'bp_nouveau_register_core_block_globals', 10, 1 );
+
+/**
+ * Unregister the 'bp/primary-nav' Block from the post context.
+ *
+ * @since 9.0.0
+ */
+function bp_nouveau_unregister_blocks_for_post_context() {
+        unregister_block_type( 'bp/primary-nav' );
+}
+add_action( 'load-post.php', 'bp_nouveau_unregister_blocks_for_post_context' );
+add_action( 'load-post-new.php', 'bp_nouveau_unregister_blocks_for_post_context' );
+
+/**
+ * Callback function to render the BP Primary Nav Block.
+ *
+ * @since 9.0.0
+ *
+ * @param array $attributes The block attributes.
+ * @return string           HTML output.
+ */
+function bp_nouveau_render_primary_nav_block( $attributes = array() ) {
+        $widget_content = '';
+        $widget_title   = '';
+        $block_args     = bp_parse_args(
+                $attributes,
+                array(
+                        'displayTitle' => true,
+                ),
+                'widget_object_nav'
+        );
+
+        // Previewing the Block inside the editor.
+        if ( defined( 'REST_REQUEST' ) && REST_REQUEST ) {
+                $widget_title = bp_get_loggedin_user_fullname();
+
+                ob_start();
+
+                // Temporary override the displayed user by the logged in one.
+                add_filter( 'bp_displayed_user_id', 'bp_loggedin_user_id' );
+
+                bp_get_template_part( 'members/single/parts/item-nav' );
+                $widget_content = ob_get_clean();
+
+                // Remove the temporary override.
+                remove_filter( 'bp_displayed_user_id', 'bp_loggedin_user_id' );
+        } else {
+                ob_start();
+
+                if ( bp_is_user() ) {
+                        $widget_title = bp_get_displayed_user_fullname();
+                        bp_get_template_part( 'members/single/parts/item-nav' );
+                } elseif ( bp_is_group() ) {
+                        $widget_title = bp_get_current_group_name();
+                        bp_get_template_part( 'groups/single/parts/item-nav' );
+                } elseif ( bp_is_directory() ) {
+                        $widget_title = bp_get_directory_title( bp_current_component() );
+                        bp_get_template_part( 'common/nav/directory-nav' );
+                }
+
+                $widget_content = ob_get_clean();
+        }
+
+        if ( ! $widget_content ) {
+                return '';
+        }
+
+        // Set the Block's title.
+        if ( true === $block_args['displayTitle'] ) {
+                $widget_content = sprintf(
+                        '<h2 class="widget-title">%1$s</h2>
+                        %2$s',
+                        esc_html( $widget_title ),
+                        $widget_content
+                );
+        }
+
+        // Only add a block wrapper if not loaded into a Widgets sidebar.
+        if ( ! did_action( 'dynamic_sidebar_before' ) ) {
+                $classnames         = 'widget_nav_menu buddypress_object_nav buddypress widget';
+                $wrapper_attributes = get_block_wrapper_attributes( array( 'class' => $classnames ) );
+
+                return sprintf(
+                        '<div %1$s>%2$s</div>',
+                        $wrapper_attributes,
+                        $widget_content
+                );
+        }
+
+        return $widget_content;
+}