Changeset 9844

Timestamp:

05/06/2015 11:01:27 PM (11 years ago)

Author:

r-a-y

Message:

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 #6331 where this idea came about.

Props boonebgorges, imath, r-a-y.

Location:

trunk

Files:

• src/bp-core/bp-core-component.php (modified) (2 diffs)
• src/bp-core/bp-core-template.php (modified) (2 diffs)
• tests/phpunit/testcases/core/functions.php (modified) (1 diff)

trunk/src/bp-core/bp-core-component.php

@@ -132 +132 @@
          *
          * @since BuddyPress (1.5.0)
-         *
-         * @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.
+         * @since BuddyPress (1.9.0) Added $params as a parameter.
+         * @since BuddyPress (2.3.0) Added $params['features'] as a configurable value.
+         *
+         * @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.
+         * }
          */
         public function start( $id = '', $name = '', $path = '', $params = array() ) {
@@ -162 +164 @@
                         if ( ! empty( $params['adminbar_myaccount_order'] ) ) {
                                 $this->adminbar_myaccount_order = (int) $params['adminbar_myaccount_order'];
+                        }
+
+                        // Register features
+                        if ( ! empty( $params['features'] ) ) {
+                                $this->features = array_map( 'sanitize_title', (array) $params['features'] );
                         }
 

trunk/src/bp-core/bp-core-template.php

@@ -1846 +1846 @@
 
 /**
- * Check whether a given component has been activated by the admin.
+ * Check whether a given component (or feature of a component) is active.
+ *
+ * @since BuddyPress (1.2.0) See r2539.
+ * @since BuddyPress (2.3.0) Added $feature as a parameter.
  *
  * @param string $component The component name.
- * @return bool True if the component is active, otherwise false.
- */
-function bp_is_active( $component = '' ) {
+ * @param string $feature   The feature name.
+ * @return bool
+ */
+function bp_is_active( $component = '', $feature = '' ) {
         $retval = false;
 
@@ -1862 +1866 @@
         if ( isset( buddypress()->active_components[ $component ] ) || isset( buddypress()->required_components[ $component ] ) ) {
                 $retval = true;
+
+                // 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 );
+                }
         }
 

trunk/tests/phpunit/testcases/core/functions.php

@@ -621 +621 @@
                 $this->assertSame( $expected_upload_dir, $tested_upload_dir );
         }
+
+        /**
+         * @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;
+        }
 }