<!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][12998] trunk: Introduce a new `BP_Component` property for block globals</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/12998">12998</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/12998","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 08:52:00 +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'>Introduce a new `BP_Component` property for block globals
This new property will help us to manage Widget Block occurrences globals and use a single filter on `'widget_block_dynamic_classname'` to make sure Widget Blocks will include Legacy Widget classnames and inherit their styles.
This commit also makes sure WordPress is >= 5.0 before using the `has_block` function.
See <a href="http://buddypress.trac.wordpress.org/ticket/8515">#8515</a>
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/8516">#8516</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpcorebpcoreblocksphp">trunk/src/bp-core/bp-core-blocks.php</a></li>
<li><a href="#trunksrcbpcorebpcoretemplatephp">trunk/src/bp-core/bp-core-template.php</a></li>
<li><a href="#trunksrcbpcoreclassesclassbpcomponentphp">trunk/src/bp-core/classes/class-bp-component.php</a></li>
<li><a href="#trunktestsphpunittestcasescoreclassbpcomponentphp">trunk/tests/phpunit/testcases/core/class-bp-component.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunitassetsclassbptestcomponentphp">trunk/tests/phpunit/assets/class-bptest-component.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpcorebpcoreblocksphp"></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-blocks.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/bp-core-blocks.php 2021-07-14 01:50:38 UTC (rev 12997)
+++ trunk/src/bp-core/bp-core-blocks.php 2021-07-14 08:52:00 UTC (rev 12998)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -162,3 +162,51 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_register_block( $args = array() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return new BP_Block( $args );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/**
+ * Gets a Widget Block list of classnames.
+ *
+ * @since 9.0.0
+ *
+ * @param string $block_name The Block name.
+ * @return array The list of widget classnames for the Block.
+ */
+function bp_blocks_get_widget_block_classnames( $block_name = '' ) {
+ $components = bp_core_get_active_components( array(), 'objects' );
+ $components['core'] = buddypress()->core;
+ $classnames = array();
+
+ foreach ( $components as $component ) {
+ if ( isset( $component->block_globals[ $block_name ] ) ) {
+ $block_props = $component->block_globals[ $block_name ]->props;
+
+ if ( isset( $block_props['widget_classnames'] ) && $block_props['widget_classnames'] ) {
+ $classnames = (array) $block_props['widget_classnames'];
+ break;
+ }
+ }
+ }
+
+ return $classnames;
+}
+
+/**
+ * Make sure the BP Widget Block classnames are included into Widget Blocks.
+ *
+ * @since 9.0.0
+ *
+ * @param string $classname The classname to be used in the block widget's container HTML.
+ * @param string $block_name The name of the block.
+ * @return string The classname to be used in the block widget's container HTML.
+ */
+function bp_widget_block_dynamic_classname( $classname, $block_name ) {
+ $bp_classnames = bp_blocks_get_widget_block_classnames( $block_name );
+
+ if ( $bp_classnames ) {
+ $bp_classnames = array_map( 'sanitize_html_class', $bp_classnames );
+ $classname .= ' ' . implode( ' ', $bp_classnames );
+ }
+
+ return $classname;
+}
+add_filter( 'widget_block_dynamic_classname', 'bp_widget_block_dynamic_classname', 10, 2 );
</ins></span></pre></div>
<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-14 01:50:38 UTC (rev 12997)
+++ trunk/src/bp-core/bp-core-template.php 2021-07-14 08:52:00 UTC (rev 12998)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3872,7 +3872,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'block' => false,
</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 ( $block_name ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $block_name && bp_is_running_wp( '5.0.0', '>=' ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $widget_blocks = get_option( 'widget_block', array() );
</span><span class="cx" style="display: block; padding: 0 10px"> $sidebars = wp_get_sidebars_widgets();
</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 2021-07-14 01:50:38 UTC (rev 12997)
+++ trunk/src/bp-core/classes/class-bp-component.php 2021-07-14 08:52:00 UTC (rev 12998)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -140,6 +140,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public $search_query_arg = 's';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * An array of globalized data for BP Blocks.
+ *
+ * @since 9.0.0
+ *
+ * @var array
+ */
+ public $block_globals = array();
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /** Methods ***************************************************************/
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -205,8 +214,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Set up component global variables.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.5.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 9.0.0 Adds the `$block_globals` argument to the `$args` parameter.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- *
</del><span class="cx" style="display: block; padding: 0 10px"> * @param array $args {
</span><span class="cx" style="display: block; padding: 0 10px"> * All values are optional.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $slug The component slug. Used to construct certain URLs, such as 'friends' in
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -221,6 +230,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * 'Search Groups...'.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type array $global_tables Optional. An array of database table names.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type array $meta_tables Optional. An array of metadata table names.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type array $block_globals Optional. An array of globalized data for BP Blocks.
</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"> public function setup_globals( $args = array() ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -241,6 +251,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'search_string' => '',
</span><span class="cx" style="display: block; padding: 0 10px"> 'global_tables' => '',
</span><span class="cx" style="display: block; padding: 0 10px"> 'meta_tables' => '',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'block_globals' => 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 class="lines" style="display: block; padding: 0 10px; color: #888">@@ -307,6 +318,27 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->register_meta_tables( $r['meta_tables'] );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters the $blocks global value.
+ *
+ * @since 9.0.0
+ *
+ * @param array $blocks a list of global properties for blocks keyed
+ * by their corresponding block name.
+ */
+ $block_globals = apply_filters( 'bp_' . $this->id . '_block_globals', $r['block_globals'] );
+ if ( is_array( $block_globals ) && array_filter( $block_globals ) ) {
+ foreach ( $block_globals as $block_name => $block_props ) {
+ $this->block_globals[ $block_name ] = new stdClass();
+
+ // Initialize an `items` property for Widget Block occurrences.
+ $this->block_globals[ $block_name ]->items = array();
+
+ // Set the global properties for the Block.
+ $this->block_globals[ $block_name ]->props = (array) $block_props;
+ }
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /** BuddyPress *******************************************************
</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="trunktestsphpunitassetsclassbptestcomponentphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/assets/class-bptest-component.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/assets/class-bptest-component.php (rev 0)
+++ trunk/tests/phpunit/assets/class-bptest-component.php 2021-07-14 08:52:00 UTC (rev 12998)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,37 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+// Testing Component Class.
+class BPTest_Component extends BP_Component {
+ /**
+ * Globals to test.
+ *
+ * @var array
+ */
+ public $globals = array();
+
+ // Start the `test` component setup process.
+ public function __construct( $args = array() ) {
+ $r = wp_parse_args(
+ $args,
+ array(
+ 'id' => 'example',
+ 'name' => 'Example Component',
+ 'globals' => array(
+ 'slug' => 'example',
+ ),
+ )
+ );
+
+ $this->globals = $r['globals'];
+
+ parent::start(
+ $r['id'],
+ $r['name']
+ );
+ }
+
+ // Setup Test Globals.
+ public function setup_globals( $args = array() ) {
+ parent::setup_globals( $this->globals );
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/assets/class-bptest-component.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="trunktestsphpunittestcasescoreclassbpcomponentphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/testcases/core/class-bp-component.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/core/class-bp-component.php 2021-07-14 01:50:38 UTC (rev 12997)
+++ trunk/tests/phpunit/testcases/core/class-bp-component.php 2021-07-14 08:52:00 UTC (rev 12998)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1,6 +1,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <?php
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> include_once BP_TESTS_DIR . '/assets/bp-rest-api-controllers.php';
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+include_once BP_TESTS_DIR . '/assets/class-bptest-component.php';
</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"> * @group core
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -68,4 +69,27 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'BP_REST_Attachments_Member_Cover_Endpoint',
</span><span class="cx" style="display: block; padding: 0 10px"> ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * @group bp_blocks
+ */
+ public function test_component_block_globals() {
+ $expected = array(
+ 'dynamic_widget_classname' => 'widget_example_classname',
+ );
+
+ $example = new BPTest_Component(
+ array(
+ 'globals' => array(
+ 'block_globals' => array(
+ 'bp/example-block' => $expected,
+ )
+ ),
+ )
+ );
+
+ do_action( 'bp_setup_globals' );
+
+ $this->assertEquals( $expected, $example->block_globals['bp/example-block']->props );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>