Changeset 12997

Timestamp:

07/14/2021 01:50:38 AM (4 years ago)

Author:

imath

Message:

Add a new function to check if a Widget/Block is active into a sidebar

Some of our Legacy Widgets are being displayed only if active they have been included into a Sidebar Widget. We are using the is_active_widget() WordPress function to check whether it is the case or not. This function doesn't fit in the Widget Blocks case as all Blocks are being inserted into the specific WP_Widget_Block widget.

As WordPress 5.8 doesn't provide any equivalent (so far?), we are introducing a new function to do this check: bp_is_widget_block_active(). It takes 2 optional arguments.

• $block_name: the name of the block you need to check (eg: 'bp/members').
• $widget_id_base: the Base ID of the widget (eg: 'bp_messages_sitewide_notices_widget').

You can use it to check a block, a widget or both.

Fixes #8515

Location:

trunk/src

Files:

• bp-core/bp-core-template.php (modified) (1 diff)
• bp-friends/classes/class-bp-core-friends-widget.php (modified) (1 diff)
• bp-groups/classes/class-bp-groups-widget.php (modified) (1 diff)
• bp-members/classes/class-bp-core-members-widget.php (modified) (1 diff)
• bp-templates/bp-legacy/buddypress-functions.php (modified) (1 diff)
• bp-templates/bp-nouveau/includes/functions.php (modified) (1 diff)

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

@@ -3857 +3857 @@
         return $salutation;
     }
+
+/**
+ * Checks if a Widget/Block is active.
+ *
+ * @since 9.0.0
+ *
+ * @param string $block_name     The Block name to check (eg: 'bp/sitewide-notices'). Optional.
+ * @param string $widget_id_base The Widget ID base to check (eg: 'bp_messages_sitewide_notices_widget' ). Optional.
+ * @return boolean True if the Widget/Block is active. False otherwise.
+ */
+function bp_is_widget_block_active( $block_name = '', $widget_id_base = '' ) {
+    $is_active = array(
+        'widget' => false,
+        'block'  => false,
+    );
+
+    if ( $block_name ) {
+        $widget_blocks = get_option( 'widget_block', array() );
+        $sidebars      = wp_get_sidebars_widgets();
+
+        if ( ! $widget_blocks || ! $sidebars ) {
+            return false;
+        }
+
+        // Neutralize inactive sidebar.
+        unset( $sidebars['wp_inactive_widgets'] );
+
+        $widgets_content = '';
+        foreach ( $widget_blocks as $key => $widget_block ) {
+            $widget_block_reference = 'block-' . $key;
+
+            if ( ! isset( $widget_block['content'] ) || ! $widget_block['content'] ) {
+                continue;
+            }
+
+            foreach ( $sidebars as $sidebar ) {
+                if ( is_array( $sidebar ) && in_array( $widget_block_reference, $sidebar, true ) ) {
+                    $widgets_content .= $widget_block['content'] . "\n";
+                }
+            }
+        }
+
+        $is_active['block'] = has_block( $block_name, $widgets_content );
+    }
+
+    if ( $widget_id_base ) {
+        $is_active['widget'] = is_active_widget( false, false, $widget_id_base, true );
+    }
+
+    return 0 !== count( array_filter( $is_active ) );
+}

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

@@ -33 +33 @@
         parent::__construct( false, $name = _x( '(BuddyPress) Friends', 'widget name', 'buddypress' ), $widget_ops );
 
-        if ( is_customize_preview() || is_active_widget( false, false, $this->id_base ) ) {
+        if ( is_customize_preview() || bp_is_widget_block_active( '', $this->id_base ) ) {
             add_action( 'bp_enqueue_scripts', array( $this, 'enqueue_scripts' ) );
         }

trunk/src/bp-groups/classes/class-bp-groups-widget.php

@@ -33 +33 @@
         parent::__construct( false, _x( '(BuddyPress) Groups', 'widget name', 'buddypress' ), $widget_ops );
 
-        if ( is_customize_preview() || is_active_widget( false, false, $this->id_base ) ) {
+        if ( is_customize_preview() || bp_is_widget_block_active( '', $this->id_base ) ) {
             add_action( 'bp_enqueue_scripts', array( $this, 'enqueue_scripts' ) );
         }

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

@@ -38 +38 @@
         ) );
 
-        if ( is_customize_preview() || is_active_widget( false, false, $this->id_base ) ) {
+        if ( is_customize_preview() || bp_is_widget_block_active( '', $this->id_base ) ) {
             add_action( 'bp_enqueue_scripts', array( $this, 'enqueue_scripts' ) );
         }

trunk/src/bp-templates/bp-legacy/buddypress-functions.php

@@ -125 +125 @@
         // Only hook the 'sitewide_notices' overlay if the Sitewide
         // Notices widget is not in use (to avoid duplicate content).
-        if ( bp_is_active( 'messages' ) && ! is_active_widget( false, false, 'bp_messages_sitewide_notices_widget', true ) ) {
+        if ( bp_is_active( 'messages' ) && ! bp_is_widget_block_active( 'bp/sitewide-notices', 'bp_messages_sitewide_notices_widget', true ) ) {
             add_action( 'wp_footer', array( $this, 'sitewide_notices' ), 9999 );
         }

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

@@ -376 +376 @@
  */
 function bp_nouveau_is_object_nav_in_sidebar() {
-    return is_active_widget( false, false, 'bp_nouveau_sidebar_object_nav_widget', true );
+    return bp_is_widget_block_active( 'bp/primary-nav', 'bp_nouveau_sidebar_object_nav_widget' );
 }