<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[BuddyPress][13741] trunk/src/bp-core: Deprecate `bp_use_wp_admin_bar()` & `BP_USE_WP_ADMIN_BAR`</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://buddypress.trac.wordpress.org/changeset/13741">13741</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/13741","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>imath</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-02-23 03:16:00 +0000 (Fri, 23 Feb 2024)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="http://buddypress.trac.wordpress.org/changeset/12893">[12893]</a> 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 <a href="http://buddypress.trac.wordpress.org/ticket/9104">#9104</a>
Closes https://github.com/buddypress/buddypress/pull/234</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpcorebpcoreadminbarphp">trunk/src/bp-core/bp-core-adminbar.php</a></li>
<li><a href="#trunksrcbpcorebpcoredependencyphp">trunk/src/bp-core/bp-core-dependency.php</a></li>
<li><a href="#trunksrcbpcorebpcorefunctionsphp">trunk/src/bp-core/bp-core-functions.php</a></li>
<li><a href="#trunksrcbpcoreclassesclassbpcomponentphp">trunk/src/bp-core/classes/class-bp-component.php</a></li>
<li><a href="#trunksrcbpcoredeprecated140php">trunk/src/bp-core/deprecated/14.0.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpcorebpcoreadminbarphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-core/bp-core-adminbar.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/bp-core-adminbar.php 2024-02-23 00:18:33 UTC (rev 13740)
+++ trunk/src/bp-core/bp-core-adminbar.php 2024-02-23 03:16:00 UTC (rev 13741)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -23,8 +23,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> global $wp_admin_bar;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Bail if this is an ajax request.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( !bp_use_wp_admin_bar() || defined( 'DOING_AJAX' ) )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( wp_doing_ajax() ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Only add menu for logged in user.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_user_logged_in() ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -53,12 +54,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! is_user_logged_in() && (int) bp_get_option( 'hide-loggedout-adminbar' ) != 1 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> show_admin_bar( true );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
- // Hide the WordPress Toolbar.
- if ( ! bp_use_wp_admin_bar() ) {
- // Keep the WP Toolbar from loading.
- show_admin_bar( false );
- }
</del><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'init', 'bp_core_load_admin_bar', 9 );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -86,9 +81,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_core_enqueue_admin_bar_css() {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // 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() ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Bail if WordPress's admin bar is not showing on this page request.
+ if ( ! is_admin_bar_showing() ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunksrcbpcorebpcoredependencyphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-core/bp-core-dependency.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/bp-core-dependency.php 2024-02-23 00:18:33 UTC (rev 13740)
+++ trunk/src/bp-core/bp-core-dependency.php 2024-02-23 03:16:00 UTC (rev 13741)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -190,17 +190,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_setup_admin_bar() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 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() );
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * 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() );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span></span></pre></div>
<a id="trunksrcbpcorebpcorefunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-core/bp-core-functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/bp-core-functions.php 2024-02-23 00:18:33 UTC (rev 13740)
+++ trunk/src/bp-core/bp-core-functions.php 2024-02-23 03:16:00 UTC (rev 13741)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -499,37 +499,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'bp_is_username_compatibility_mode', defined( 'BP_ENABLE_USERNAME_COMPATIBILITY_MODE' ) && BP_ENABLE_USERNAME_COMPATIBILITY_MODE );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-/**
- * 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() {
</del><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // 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 );
-}
-
-
</del><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Return the parent forum ID for the Legacy Forums abstraction layer.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span></span></pre></div>
<a id="trunksrcbpcoreclassesclassbpcomponentphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-core/classes/class-bp-component.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/classes/class-bp-component.php 2024-02-23 00:18:33 UTC (rev 13740)
+++ trunk/src/bp-core/classes/class-bp-component.php 2024-02-23 03:16:00 UTC (rev 13741)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -807,15 +807,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> global $wp_admin_bar;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Bail if this is an ajax request.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( defined( 'DOING_AJAX' ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( wp_doing_ajax() ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Do not proceed if BP_USE_WP_ADMIN_BAR constant is not set or is false.
- if ( ! bp_use_wp_admin_bar() ) {
- return;
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters the admin navigation passed into setup_admin_bar.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span></span></pre></div>
<a id="trunksrcbpcoredeprecated140php"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-core/deprecated/14.0.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/deprecated/14.0.php 2024-02-23 00:18:33 UTC (rev 13740)
+++ trunk/src/bp-core/deprecated/14.0.php 2024-02-23 03:16:00 UTC (rev 13741)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -31,3 +31,35 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_block_init_category_filter() {
</span><span class="cx" style="display: block; padding: 0 10px"> _deprecated_function( __FUNCTION__, '14.0.0' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/**
+ * 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' );
+}
</ins></span></pre>
</div>
</div>
</body>
</html>