Changeset 13741 for trunk/src/bp-core/deprecated/14.0.php

Timestamp:

02/23/2024 03:16:00 AM (16 months 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

File:

• trunk/src/bp-core/deprecated/14.0.php (modified) (1 diff)

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' );
+}