<!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][12997] trunk/src: Add a new function to check if a Widget/Block is active into a sidebar</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/12997">12997</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/12997","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>2021-07-14 01:50:38 +0000 (Wed, 14 Jul 2021)</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'>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 <a href="http://buddypress.trac.wordpress.org/ticket/8515">#8515</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpcorebpcoretemplatephp">trunk/src/bp-core/bp-core-template.php</a></li>
<li><a href="#trunksrcbpfriendsclassesclassbpcorefriendswidgetphp">trunk/src/bp-friends/classes/class-bp-core-friends-widget.php</a></li>
<li><a href="#trunksrcbpgroupsclassesclassbpgroupswidgetphp">trunk/src/bp-groups/classes/class-bp-groups-widget.php</a></li>
<li><a href="#trunksrcbpmembersclassesclassbpcorememberswidgetphp">trunk/src/bp-members/classes/class-bp-core-members-widget.php</a></li>
<li><a href="#trunksrcbptemplatesbplegacybuddypressfunctionsphp">trunk/src/bp-templates/bp-legacy/buddypress-functions.php</a></li>
<li><a href="#trunksrcbptemplatesbpnouveauincludesfunctionsphp">trunk/src/bp-templates/bp-nouveau/includes/functions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpcorebpcoretemplatephp"></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-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/bp-core-template.php 2021-07-12 23:57:59 UTC (rev 12996)
+++ trunk/src/bp-core/bp-core-template.php 2021-07-14 01:50:38 UTC (rev 12997)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3856,3 +3856,54 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return $salutation;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/**
+ * 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 ) );
+}
</ins></span></pre></div>
<a id="trunksrcbpfriendsclassesclassbpcorefriendswidgetphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-friends/classes/class-bp-core-friends-widget.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-friends/classes/class-bp-core-friends-widget.php 2021-07-12 23:57:59 UTC (rev 12996)
+++ trunk/src/bp-friends/classes/class-bp-core-friends-widget.php 2021-07-14 01:50:38 UTC (rev 12997)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -32,7 +32,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> parent::__construct( false, $name = _x( '(BuddyPress) Friends', 'widget name', 'buddypress' ), $widget_ops );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( is_customize_preview() || is_active_widget( false, false, $this->id_base ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( is_customize_preview() || bp_is_widget_block_active( '', $this->id_base ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> add_action( 'bp_enqueue_scripts', array( $this, 'enqueue_scripts' ) );
</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="trunksrcbpgroupsclassesclassbpgroupswidgetphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-groups/classes/class-bp-groups-widget.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-groups/classes/class-bp-groups-widget.php 2021-07-12 23:57:59 UTC (rev 12996)
+++ trunk/src/bp-groups/classes/class-bp-groups-widget.php 2021-07-14 01:50:38 UTC (rev 12997)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -32,7 +32,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> parent::__construct( false, _x( '(BuddyPress) Groups', 'widget name', 'buddypress' ), $widget_ops );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( is_customize_preview() || is_active_widget( false, false, $this->id_base ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( is_customize_preview() || bp_is_widget_block_active( '', $this->id_base ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> add_action( 'bp_enqueue_scripts', array( $this, 'enqueue_scripts' ) );
</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="trunksrcbpmembersclassesclassbpcorememberswidgetphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-members/classes/class-bp-core-members-widget.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-members/classes/class-bp-core-members-widget.php 2021-07-12 23:57:59 UTC (rev 12996)
+++ trunk/src/bp-members/classes/class-bp-core-members-widget.php 2021-07-14 01:50:38 UTC (rev 12997)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -37,7 +37,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'show_instance_in_rest' => true,
</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">- if ( is_customize_preview() || is_active_widget( false, false, $this->id_base ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( is_customize_preview() || bp_is_widget_block_active( '', $this->id_base ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> add_action( 'bp_enqueue_scripts', array( $this, 'enqueue_scripts' ) );
</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="trunksrcbptemplatesbplegacybuddypressfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-templates/bp-legacy/buddypress-functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-templates/bp-legacy/buddypress-functions.php 2021-07-12 23:57:59 UTC (rev 12996)
+++ trunk/src/bp-templates/bp-legacy/buddypress-functions.php 2021-07-14 01:50:38 UTC (rev 12997)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -124,7 +124,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Only hook the 'sitewide_notices' overlay if the Sitewide
</span><span class="cx" style="display: block; padding: 0 10px"> // Notices widget is not in use (to avoid duplicate content).
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( bp_is_active( 'messages' ) && ! is_active_widget( false, false, 'bp_messages_sitewide_notices_widget', true ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( bp_is_active( 'messages' ) && ! bp_is_widget_block_active( 'bp/sitewide-notices', 'bp_messages_sitewide_notices_widget', true ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> add_action( 'wp_footer', array( $this, 'sitewide_notices' ), 9999 );
</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="trunksrcbptemplatesbpnouveauincludesfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-templates/bp-nouveau/includes/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-templates/bp-nouveau/includes/functions.php 2021-07-12 23:57:59 UTC (rev 12996)
+++ trunk/src/bp-templates/bp-nouveau/includes/functions.php 2021-07-14 01:50:38 UTC (rev 12997)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -375,7 +375,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return bool
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_nouveau_is_object_nav_in_sidebar() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return is_active_widget( false, false, 'bp_nouveau_sidebar_object_nav_widget', true );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return bp_is_widget_block_active( 'bp/primary-nav', 'bp_nouveau_sidebar_object_nav_widget' );
</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>
</div>
</body>
</html>