<!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][9844] trunk: Core: Introduce ability for components to register new features.</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 { 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/9844">9844</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/9844","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>r-a-y</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-05-06 23:01:27 +0000 (Wed, 06 May 2015)</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'>Core: Introduce ability for components to register new features.
This commit allows plugin developers to register a feature in the
`'BP_Component'` class. To BuddyPress, a feature is merely an internal
marker. It is up to the developer to implement the feature.
Developers can check if a feature is registered with this snippet:
`bp_is_active( $component, $feature_name )`
See <a href="http://buddypress.trac.wordpress.org/ticket/6331">#6331</a> where this idea came about.
Props boonebgorges, imath, r-a-y.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpcorebpcorecomponentphp">trunk/src/bp-core/bp-core-component.php</a></li>
<li><a href="#trunksrcbpcorebpcoretemplatephp">trunk/src/bp-core/bp-core-template.php</a></li>
<li><a href="#trunktestsphpunittestcasescorefunctionsphp">trunk/tests/phpunit/testcases/core/functions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpcorebpcorecomponentphp"></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-component.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/bp-core-component.php 2015-05-06 22:23:53 UTC (rev 9843)
+++ trunk/src/bp-core/bp-core-component.php 2015-05-06 23:01:27 UTC (rev 9844)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -131,19 +131,21 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Component loader.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since BuddyPress (1.5.0)
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since BuddyPress (1.9.0) Added $params as a parameter.
+ * @since BuddyPress (2.3.0) Added $params['features'] as a configurable value.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @uses BP_Component::setup_actions() Set up the hooks and actions.
- *
- * @param string $id Unique ID (for internal identification). Letters,
- * numbers, and underscores only.
- * @param string $name Unique name. This should be a translatable name,
- * eg __( 'Groups', 'buddypress' ).
- * @param string $path The file path for the component's files. Used by
- * {@link BP_Component::includes()}.
- * @param array $params Additional parameters used by the component.
- * The config array supports the following values:
- * - 'adminbar_myaccount_order' Sets the position for our
- * component menu under the WP Toolbar's "My Account" menu.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $id Unique ID. Letters, numbers, and underscores only.
+ * @param string $name Unique name. This should be a translatable name, eg.
+ * __( 'Groups', 'buddypress' ).
+ * @param string $path The file path for the component's files. Used by {@link BP_Component::includes()}.
+ * @param array $params {
+ * Additional parameters used by the component.
+ * @type int $adminbar_myaccount_order Set the position for our menu under the WP Toolbar's "My Account menu"
+ * @type array $features An array of feature names. This is used to load additional files from your
+ * component directory and for feature active checks. eg. array( 'awesome' )
+ * would look for a file called "bp-{$this->id}-awesome.php" and you could use
+ * bp_is_active( $this->id, 'awesome' ) to determine if the feature is active.
+ * }
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function start( $id = '', $name = '', $path = '', $params = array() ) {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -163,6 +165,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->adminbar_myaccount_order = (int) $params['adminbar_myaccount_order'];
</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">+ // Register features
+ if ( ! empty( $params['features'] ) ) {
+ $this->features = array_map( 'sanitize_title', (array) $params['features'] );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Set defaults if not passed
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> // new component menus are added before the settings menu if not set
</span></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 2015-05-06 22:23:53 UTC (rev 9843)
+++ trunk/src/bp-core/bp-core-template.php 2015-05-06 23:01:27 UTC (rev 9844)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1845,12 +1845,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /** Components ****************************************************************/
</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">- * Check whether a given component has been activated by the admin.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Check whether a given component (or feature of a component) is active.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since BuddyPress (1.2.0) See r2539.
+ * @since BuddyPress (2.3.0) Added $feature as a parameter.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $component The component name.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return bool True if the component is active, otherwise false.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $feature The feature name.
+ * @return bool
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function bp_is_active( $component = '' ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function bp_is_active( $component = '', $feature = '' ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $retval = false;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Default to the current component if none is passed
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1861,6 +1865,22 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Is component in either the active or required components arrays
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( buddypress()->active_components[ $component ] ) || isset( buddypress()->required_components[ $component ] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $retval = true;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Is feature active?
+ if ( ! empty( $feature ) ) {
+ if ( empty( buddypress()->$component->features ) || false === in_array( $feature, buddypress()->$component->features, true ) ) {
+ $retval = false;
+ }
+
+ /**
+ * Filters whether or not a given feature for a component is active.
+ *
+ * @since BuddyPress (2.3.0)
+ *
+ * @param bool $retval
+ */
+ $retval = apply_filters( "bp_is_{$component}_{$feature}_active", $retval );
+ }
</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="trunktestsphpunittestcasescorefunctionsphp"></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/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/core/functions.php 2015-05-06 22:23:53 UTC (rev 9843)
+++ trunk/tests/phpunit/testcases/core/functions.php 2015-05-06 23:01:27 UTC (rev 9844)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -620,4 +620,69 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( $expected_upload_dir, $tested_upload_dir );
</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_is_active
+ */
+ public function test_bp_is_active_component() {
+ $bp = buddypress();
+ $reset_active_components = $bp->active_components;
+
+ $this->assertTrue( bp_is_active( 'members' ) );
+
+ $this->assertFalse( bp_is_active( 'foo' ) );
+
+ // Create and activate the foo component
+ $bp->foo = new BP_Component;
+ $bp->foo->id = 'foo';
+ $bp->foo->slug = 'foo';
+ $bp->foo->name = 'Foo';
+ $bp->active_components[ $bp->foo->id ] = 1;
+
+ $this->assertTrue( bp_is_active( 'foo' ) );
+
+ add_filter( 'bp_is_active', '__return_false' );
+
+ $this->assertFalse( bp_is_active( 'foo' ) );
+
+ remove_filter( 'bp_is_active', '__return_false' );
+
+ // Reset buddypress() vars
+ $bp->active_components = $reset_active_components;
+ }
+
+ /**
+ * @group bp_is_active
+ */
+ public function test_bp_is_active_feature() {
+ $bp = buddypress();
+ $reset_active_components = $bp->active_components;
+
+ // Create and activate the foo component
+ $bp->foo = new BP_Component;
+ $bp->foo->id = 'foo';
+ $bp->foo->slug = 'foo';
+ $bp->foo->name = 'Foo';
+ $bp->active_components[ $bp->foo->id ] = 1;
+
+ // foo did not register 'bar' as a feature
+ $this->assertFalse( bp_is_active( 'foo', 'bar' ) );
+
+ // fake registering the 'bar' feature
+ $bp->foo->features = array( 'bar' );
+ $this->assertTrue( bp_is_active( 'foo', 'bar' ) );
+
+ // test the feature filter
+ add_filter( 'bp_is_foo_bar_active', '__return_false' );
+ $this->assertFalse( bp_is_active( 'foo', 'bar' ) );
+ remove_filter( 'bp_is_foo_bar_active', '__return_false' );
+
+ // test the main component filter
+ add_filter( 'bp_is_active', '__return_false' );
+ $this->assertFalse( bp_is_active( 'foo', 'bar' ) );
+ remove_filter( 'bp_is_active', '__return_false' );
+
+ // Reset buddypress() vars
+ $bp->active_components = $reset_active_components;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>