Ticket #4728: 4728.02.patch

src/bp-core/bp-core-functions.php

@@ -2542 +2542 @@
 
         return $bp->upload_dir;
 }
+
+/** Visibility ***************************************************************/
+
+/**
+ * Registers a visiblity level with BuddyPress.
+ *
+ * Run this on the 'bp_setup_globals' action.
+ *
+ * @since BuddyPress (2.4.0)
+ *
+ * @param array $args {
+ *     Array of arguments.
+ *     @type string $id       The ID for the visibility level. Required.
+ *     @type string $label    Label for the visibility level. Required.
+ *     @type int    $position Position to order the visibility level. Optional. Default: 99.
+ * }
+ * @return bool
+ */
+function bp_register_visibility_level( $args = array() ) {
+        $r = bp_parse_args( $args, array(
+                'id'       => '',
+                'label'    => '',
+                'position' => 99
+        ), 'register_visibility_level' );
+
+        if ( empty( $r['id'] ) || empty( $r['label'] ) ) {
+                return false;
+        }
+
+        $bp = buddypress();
+
+        $id = sanitize_key( $r['id'] );
+        unset( $r['id'] );
+        if ( ! empty( $bp->core->visibility_levels[ $id ] ) ) {
+                return false;
+        }
+
+        // register the level
+        $bp->core->visibility_levels[ $id ]['id'] = $id;
+
+        // left open so plugins can add parameters if needed (callbacks, etc.)
+        $bp->core->visibility_levels[ $id ] = array_merge( $bp->core->visibility_levels[ $id ], $r );
+
+        return true;
+}
+
+/**
+ * Deregisters a BuddyPress visiblity level.
+ *
+ * Run this on the 'bp_setup_globals' if needed.
+ *
+ * @since BuddyPress (2.4.0)
+ *
+ * @param string $id The ID of the visibility level to deregister.
+ * @return bool
+ */
+function bp_deregister_visibility_level( $id = '' ) {
+        if ( empty( $id ) ) {
+                return false;
+        }
+
+        $bp = buddypress();
+
+        if ( empty( $bp->core->visibility_levels[$id] ) ) {
+                return false;
+        }
+
+        unset( $bp->core->visibility_levels[$id] );
+        return true;
+}
+
+/**
+ * Get available visibility levels for BuddyPress.
+ *
+ * @since BuddyPress (2.4.0)
+ *
+ * @return array
+ */
+function bp_core_get_visibility_levels() {
+
+        /**
+         * Filters the visibility levels.
+         *
+         * @since BuddyPress (2.4.0)
+         *
+         * @param array Array of visibility levels.
+         */
+        return apply_filters( 'bp_core_get_visibility_levels', buddypress()->core->visibility_levels );
+}
+
+/**
+ * Sorts visibility levels by the 'position' subkey.
+ *
+ * Used only once.
+ *
+ * @since BuddyPress (2.4.0)
+ *
+ * @access private
+ */
+function _bp_core_sort_visibility_levels() {
+        $bp = buddypress();
+        $temp = bp_sort_by_key( $bp->core->visibility_levels, 'position', 'num' );
+
+        $bp->core->visibility_levels = array();
+        foreach( $temp as $level ) {
+                $bp->core->visibility_levels[ $level['id'] ] = $level;
+        }
+        unset( $temp );
+}
+add_action( 'bp_setup_globals', '_bp_core_sort_visibility_levels', 999 );
+ No newline at end of file

src/bp-core/bp-core-loader.php

@@ -15 +15 @@
 class BP_Core extends BP_Component {
 
         /**
+         * Visibility levels.
+         *
+         * @since BuddyPress (2.4.0)
+         *
+         * @var array
+         */
+        public $visibility_levels = array();
+
+        /**
          * Start the members component creation process.
          *
          * @since BuddyPress (1.5.0)

src/bp-friends/bp-friends-loader.php

@@ -95 +95 @@
                 );
 
                 parent::setup_globals( $args );
+
+                // Register visibility level
+                bp_register_visibility_level( array(
+                        'id'    => 'friends',
+                        'label' => _x( 'My Friends', 'Visibility level setting', 'buddypress' )
+                ) );
         }
 
         /**

src/bp-members/bp-members-loader.php

@@ -146 +146 @@
                         $bp->profile->slug = 'profile';
                         $bp->profile->id   = 'profile';
                 }
+
+                /** Visibility ********************************************************/
+
+                bp_register_visibility_level( array(
+                        'id'       => 'public',
+                        'label'    => _x( 'Everyone', 'Visibility level setting', 'buddypress' ),
+                        'position' => 10
+                ) );
+                bp_register_visibility_level( array(
+                        'id'       => 'adminsonly',
+                        'label'    => _x( 'Only Me', 'Visibility level setting', 'buddypress' ),
+                        'position' => 20
+                ) );
+                bp_register_visibility_level( array(
+                        'id'       => 'loggedin',
+                        'label'    => _x( 'All Members', 'Visibility level setting', 'buddypress' ),
+                        'position' => 30
+                ) );
         }
 
         /**

src/bp-xprofile/bp-xprofile-functions.php

@@ -997 +997 @@
          *
          * @param array $visibility_levels Array of visibility levels.
          */
-        return apply_filters( 'bp_xprofile_get_visibility_levels', buddypress()->profile->visibility_levels );
+        return apply_filters( 'bp_xprofile_get_visibility_levels', bp_core_get_visibility_levels() );
 }
 
 /**

src/bp-xprofile/bp-xprofile-loader.php

@@ -116 +116 @@
                 // but it must be whitelisted
                 $this->field_types[] = 'option';
 
-                // Register the visibility levels. See bp_xprofile_get_visibility_levels() to filter
-                $this->visibility_levels = array(
-                        'public' => array(
-                                'id'      => 'public',
-                                'label' => _x( 'Everyone', 'Visibility level setting', 'buddypress' )
-                        ),
-                        'adminsonly' => array(
-                                'id'      => 'adminsonly',
-                                'label' => _x( 'Only Me', 'Visibility level setting', 'buddypress' )
-                        ),
-                        'loggedin' => array(
-                                'id'      => 'loggedin',
-                                'label' => _x( 'All Members', 'Visibility level setting', 'buddypress' )
-                        )
-                );
-
-                if ( bp_is_active( 'friends' ) ) {
-                        $this->visibility_levels['friends'] = array(
-                                'id'    => 'friends',
-                                'label' => _x( 'My Friends', 'Visibility level setting', 'buddypress' )
-                        );
-                }
+                /**
+                 * Visibility levels.
+                 *
+                 * @since BuddyPress (2.4.0) Core now handles visibility levels. For backpat, we byref core's visibility
+                 *                           levels.  See bp_core_get_visibility_levels().
+                 */
+                $this->visibility_levels = & buddypress()->core->visibility_levels;
 
                 // Tables
                 $global_tables = array(

tests/phpunit/testcases/core/functions.php

@@ -685 +685 @@
                 // Reset buddypress() vars
                 $bp->active_components = $reset_active_components;
         }
+
+        /**
+         * @group bp_register_visibility_level
+         * @group bp_deregister_visibility_level
+         */
+        public function test_bp_register_visibility_level_and_bp_deregister_visibility_level() {
+                // register a visibility level
+                bp_register_visibility_level( array(
+                        'id'       => 'nohomers',
+                        'label'    => 'No Homers',
+                ) );
+                $this->assertTrue( isset( buddypress()->core->visibility_levels['nohomers'] ) );
+
+                // deregister the level
+                bp_deregister_visibility_level( 'nohomers' );
+                $this->assertFalse( isset( buddypress()->core->visibility_levels['nohomers'] ) );
+        }
 }