Changeset 13153 for trunk/src/bp-core/bp-core-widgets.php

Timestamp:

11/19/2021 05:03:56 AM (3 years ago)

Author:

imath

Message:

Only load BP Legacy Widgets when the Widgets Block editor is disabled

To improve the Widgets Block editor's users experience, we are making a new step towards deprecating BP Legacy Widgets by not loading them by default. As a result, into this editor, only BP Widget Blocks will be loaded and listed into the Block inserter of the Widgets screen.

If users want to keep the Legacy Widgets into the Widgets Block editor, they can do so returning true to this filter 'bp_core_retain_legacy_widgets'.

If users are using the Classic Widgets Editor plugin or if advanced users are directly filtering 'use_widgets_block_editor' to return false: Legacy Widgets will still be available into the Classic Widgets Editor.

Fixes #8594

File:

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

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

@@ -12 +12 @@
 
 /**
+ * Should BuddyPress load Legacy Widgets?
+ *
+ * @since 10.0.0
+ *
+ * @return bool False if BuddyPress shouldn't load Legacy Widgets. True otherwise.
+ */
+function bp_core_retain_legacy_widgets() {
+    $theme_supports = current_theme_supports( 'widgets-block-editor' );
+    $wp_supports    = bp_is_running_wp( '5.8.0' );
+
+    /** This filter is documented in wp-includes/widgets.php */
+    $block_widgets_enabled = $theme_supports && apply_filters( 'use_widgets_block_editor', $wp_supports );
+
+    $retain_legacy_widgets = true;
+    if ( $block_widgets_enabled ) {
+        $retain_legacy_widgets = false;
+    }
+
+    /**
+     * Filter here to force Legacy Widgets to be retained or not.
+     *
+     * @since 10.0.0
+     *
+     * @param bool $retain_legacy_widgets False if BuddyPress shouldn't load Legacy Widgets. True otherwise.
+     */
+    return apply_filters( 'bp_core_retain_legacy_widgets', $retain_legacy_widgets );
+}
+
+/**
+ * Registers the Login widget.
+ *
+ * @since 10.0.0
+ */
+function bp_core_register_login_widget() {
+    register_widget( 'BP_Core_Login_Widget' );
+}
+
+/**
  * Register bp-core widgets.
  *
@@ -17 +55 @@
  */
 function bp_core_register_widgets() {
-    add_action( 'widgets_init', function() { register_widget( 'BP_Core_Login_Widget' ); } );
+    add_action( 'widgets_init', 'bp_core_register_login_widget' );
 }
 add_action( 'bp_register_widgets', 'bp_core_register_widgets' );
+
+/**
+ * Checks whether BuddyPress should unhook Legacy Widget registrations.
+ *
+ * @since 10.0.0
+ */
+function bp_core_maybe_unhook_legacy_widgets() {
+    if ( bp_core_retain_legacy_widgets() ) {
+        return;
+    }
+
+    $callbacks = array(
+        'bp_core_register_login_widget',
+        'bp_members_register_members_widget',
+        'bp_members_register_whos_online_widget',
+        'bp_members_register_recently_active_widget',
+    );
+
+    if ( bp_is_active( 'friends' ) ) {
+        $callbacks[] = 'bp_friends_register_friends_widget';
+    }
+
+    if ( bp_is_active( 'groups' ) ) {
+        $callbacks[] = 'bp_groups_register_groups_widget';
+    }
+
+    if ( bp_is_active( 'messages' ) ) {
+        $callbacks[] = 'bp_messages_register_sitewide_notices_widget';
+    }
+
+    if ( bp_is_active( 'blogs' ) && bp_is_active( 'activity' ) && bp_is_root_blog() ) {
+        $callbacks[] = 'bp_blogs_register_recent_posts_widget';
+    }
+
+    foreach ( $callbacks as $callback ) {
+        remove_action( 'widgets_init', $callback );
+    }
+}
+add_action( 'widgets_init', 'bp_core_maybe_unhook_legacy_widgets', 0 );