Changeset 13741

Timestamp:

02/23/2024 03:16:00 AM (3 years ago)

Author:

imath

Message:

Deprecate bp_use_wp_admin_bar() & BP_USE_WP_ADMIN_BAR

This function and constant were useful when BuddyPress was including an alternative toolbar to the WordPress Admin Bar called the "BuddyBar". The BuddyBar was removed in [12893] but we forgot to deprecate bp_use_wp_admin_bar() & BP_USE_WP_ADMIN_BAR. This commit is finally achieving the step we missed almost 3 years ago.

Props espellcaste, emaralive

Fixes #9104
Closes ​https://github.com/buddypress/buddypress/pull/234

Location:

trunk/src/bp-core

Files:

• bp-core-adminbar.php (modified) (3 diffs)
• bp-core-dependency.php (modified) (1 diff)
• bp-core-functions.php (modified) (1 diff)
• classes/class-bp-component.php (modified) (1 diff)
• deprecated/14.0.php (modified) (1 diff)

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

@@ -24 +24 @@
 
         // Bail if this is an ajax request.
-        if ( !bp_use_wp_admin_bar() || defined( 'DOING_AJAX' ) )
+        if ( wp_doing_ajax() ) {
                 return;
+        }
 
         // Only add menu for logged in user.
@@ -54 +55 @@
                 show_admin_bar( true );
         }
-
-        // Hide the WordPress Toolbar.
-        if ( ! bp_use_wp_admin_bar() ) {
-                // Keep the WP Toolbar from loading.
-                show_admin_bar( false );
-        }
 }
 add_action( 'init', 'bp_core_load_admin_bar', 9 );
@@ -87 +82 @@
 function bp_core_enqueue_admin_bar_css() {
 
-        // Bail if not using WordPress's admin bar or it's not showing on this
-        // page request.
-        if ( ! bp_use_wp_admin_bar() || ! is_admin_bar_showing() ) {
+        // Bail if WordPress's admin bar is not showing on this page request.
+        if ( ! is_admin_bar_showing() ) {
                 return;
         }

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

@@ -191 +191 @@
  */
 function bp_setup_admin_bar() {
-        if ( bp_use_wp_admin_bar() ) {
-
-                /**
-                 * Fires inside the 'bp_setup_admin_bar' function, where plugins should add items to the WP admin bar.
-                 *
-                 * This hook will only fire if bp_use_wp_admin_bar() returns true.
-                 *
-                 * @since 1.5.0
-                 */
-                do_action( 'bp_setup_admin_bar', array() );
-        }
+        /**
+         * Fires inside the 'bp_setup_admin_bar' function, where plugins should add items to the WP admin bar.
+         *
+         * @since 1.5.0
+         */
+        do_action( 'bp_setup_admin_bar', array() );
 }
 

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

@@ -498 +498 @@
          */
         return apply_filters( 'bp_is_username_compatibility_mode', defined( 'BP_ENABLE_USERNAME_COMPATIBILITY_MODE' ) && BP_ENABLE_USERNAME_COMPATIBILITY_MODE );
-}
-
-/**
- * Should we use the WP Toolbar?
- *
- * The WP Toolbar, introduced in WP 3.1, is fully supported in BuddyPress as
- * of BP 1.5. For BP 1.6, the WP Toolbar is the default.
- *
- * @since 1.5.0
- *
- * @return bool Default: true. False when WP Toolbar support is disabled.
- */
-function bp_use_wp_admin_bar() {
-
-        // Default to true.
-        $use_admin_bar = true;
-
-        // Has the WP Toolbar constant been explicitly opted into?
-        if ( defined( 'BP_USE_WP_ADMIN_BAR' ) ) {
-                $use_admin_bar = (bool) BP_USE_WP_ADMIN_BAR;
-        }
-
-        /**
-         * Filters whether or not to use the admin bar.
-         *
-         * @since 1.5.0
-         *
-         * @param bool $use_admin_bar Whether or not to use the admin bar.
-         */
-        return (bool) apply_filters( 'bp_use_wp_admin_bar', $use_admin_bar );
 }
 

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

@@ -808 +808 @@
 
                 // Bail if this is an ajax request.
-                if ( defined( 'DOING_AJAX' ) ) {
-                        return;
-                }
-
-                // Do not proceed if BP_USE_WP_ADMIN_BAR constant is not set or is false.
-                if ( ! bp_use_wp_admin_bar() ) {
+                if ( wp_doing_ajax() ) {
                         return;
                 }

trunk/src/bp-core/deprecated/14.0.php

@@ -32 +32 @@
         _deprecated_function( __FUNCTION__, '14.0.0' );
 }
+
+/**
+ * Should we use the WP Toolbar?
+ *
+ * The WP Toolbar, introduced in WP 3.1, is fully supported in BuddyPress as
+ * of BP 1.5. For BP 1.6, the WP Toolbar is the default.
+ *
+ * @since 1.5.0
+ * @deprecated 14.0.0
+ *
+ * @return bool Default: true. False when WP Toolbar support is disabled.
+ */
+function bp_use_wp_admin_bar() {
+        _deprecated_function( __FUNCTION__, '14.0.0' );
+
+        // Default to true.
+        $use_admin_bar = true;
+
+        if ( defined( 'BP_USE_WP_ADMIN_BAR' ) ) {
+                _doing_it_wrong( 'BP_USE_WP_ADMIN_BAR', esc_html__( 'The BP_USE_WP_ADMIN_BAR constant is deprecated.', 'buddypress' ), 'BuddyPress 14.0.0' );
+        }
+
+        /**
+         * Filters whether or not to use the admin bar.
+         *
+         * @since 1.5.0
+         * @deprecated 14.0.0
+         *
+         * @param bool $use_admin_bar Whether or not to use the admin bar.
+         */
+        return apply_filters_deprecated( 'bp_use_wp_admin_bar', array( $use_admin_bar ), '14.0.0' );
+}