Ticket #6286: 6286.2.patch

src/bp-core/bp-core-actions.php

@@ -55 +55 @@
 add_action( 'bp_loaded', 'bp_include',                  4  );
 add_action( 'bp_loaded', 'bp_setup_cache_groups',       5  );
 add_action( 'bp_loaded', 'bp_setup_widgets',            6  );
+add_action( 'bp_loaded', 'bp_register_member_types',    8  );
 add_action( 'bp_loaded', 'bp_register_theme_packages',  12 );
 add_action( 'bp_loaded', 'bp_register_theme_directory', 14 );
 

src/bp-core/bp-core-catchuri.php

@@ -258 +258 @@
                 // If members component, do more work to find the actual component
                 if ( 'members' == $match->key ) {
 
-                        // Viewing a specific user
-                        if ( !empty( $bp_uri[$uri_offset + 1] ) ) {
+                        $after_member_slug = false;
+                        if ( ! empty( $bp_uri[ $uri_offset + 1 ] ) ) {
+                                $after_member_slug = $bp_uri[ $uri_offset + 1 ];
+                        }
 
+                        // Are we viewing a specific user?
+                        if ( $after_member_slug ) {
                                 // Switch the displayed_user based on compatibility mode
                                 if ( bp_is_username_compatibility_mode() ) {
-                                        $bp->displayed_user->id = (int) bp_core_get_userid( urldecode( $bp_uri[$uri_offset + 1] ) );
+                                        $bp->displayed_user->id = (int) bp_core_get_userid( urldecode( $after_member_slug ) );
                                 } else {
-                                        $bp->displayed_user->id = (int) bp_core_get_userid_from_nicename( urldecode( $bp_uri[$uri_offset + 1] ) );
+                                        $bp->displayed_user->id = (int) bp_core_get_userid_from_nicename( $after_member_slug );
                                 }
+                        }
 
-                                if ( !bp_displayed_user_id() ) {
+                        // Is this a member type directory?
+                        if ( ! bp_displayed_user_id() && $after_member_slug === apply_filters( 'bp_members_member_type_base', _x( 'type', 'member type URL base', 'buddypress' ) ) && ! empty( $bp_uri[ $uri_offset + 2 ] ) ) {
+                                $matched_types = bp_get_member_types( array(
+                                        'has_directory'  => true,
+                                        'directory_slug' => $bp_uri[ $uri_offset + 2 ],
+                                ) );
 
-                                        // Prevent components from loading their templates
-                                        $bp->current_component = '';
+                                if ( ! empty( $matched_types ) ) {
+                                        $bp->current_member_type = reset( $matched_types );
+                                        unset( $bp_uri[ $uri_offset + 1 ] );
+                                }
+                        }
+
+                        // If the slug matches neither a member type nor a specific member, 404.
+                        if ( ! bp_displayed_user_id() && ! bp_get_current_member_type() && $after_member_slug ) {
+
+                                // Prevent components from loading their templates
+                                $bp->current_component = '';
+
+                                bp_do_404();
+                                return;
+                        }
 
+                        // If the displayed user is marked as a spammer, 404 (unless logged-
+                        // in user is a super admin)
+                        if ( bp_displayed_user_id() && bp_is_user_spammer( bp_displayed_user_id() ) ) {
+                                if ( bp_current_user_can( 'bp_moderate' ) ) {
+                                        bp_core_add_message( __( 'This user has been marked as a spammer. Only site admins can view this profile.', 'buddypress' ), 'warning' );
+                                } else {
                                         bp_do_404();
                                         return;
                                 }
+                        }
 
-                                // If the displayed user is marked as a spammer, 404 (unless logged-
-                                // in user is a super admin)
-                                if ( bp_displayed_user_id() && bp_is_user_spammer( bp_displayed_user_id() ) ) {
-                                        if ( bp_current_user_can( 'bp_moderate' ) ) {
-                                                bp_core_add_message( __( 'This user has been marked as a spammer. Only site admins can view this profile.', 'buddypress' ), 'warning' );
-                                        } else {
-                                                bp_do_404();
-                                                return;
-                                        }
-                                }
-
-                                // Bump the offset
+                        // Bump the offset
+                        if ( $after_member_slug && ! bp_get_current_member_type() ) {
                                 if ( isset( $bp_uri[$uri_offset + 2] ) ) {
                                         $bp_uri                = array_merge( array(), array_slice( $bp_uri, $uri_offset + 2 ) );
                                         $bp->current_component = $bp_uri[0];
@@ -298 +318 @@
                                         $bp_uri                = array_merge( array(), array_slice( $bp_uri, $uri_offset + 2 ) );
                                         $bp->current_component = '';
                                 }
-
-                                // Reset the offset
-                                $uri_offset = 0;
                         }
+
+                        // Reset the offset
+                        $uri_offset = 0;
                 }
         }
 

src/bp-core/bp-core-dependency.php

@@ -141 +141 @@
 }
 
 /**
+ * Fire the 'bp_register_widgets' action, where plugins should register widgets.
+ *
+ * @since BuddyPress (2.3.0)
+ */
+function bp_register_member_types() {
+        do_action( 'bp_register_member_types' );
+}
+
+/**
  * Fire the 'bp_setup_cache_groups' action, where cache groups are registered.
  *
  * @since BuddyPress (2.2.0)

src/bp-loader.php

@@ -81 +81 @@
         public $action_variables = array();
 
         /**
+         * @var string Current member directory type.
+         */
+        public $current_member_type = '';
+
+        /**
          * @var array Required components (core, members).
          */
         public $required_components = array();

src/bp-members/bp-members-functions.php

@@ -2469 +2469 @@
 
         $r = bp_parse_args( $args, array(
                 'labels' => array(),
+                'has_directory' => true,
         ), 'register_member_type' );
 
         $member_type = sanitize_key( $member_type );
@@ -2483 +2484 @@
                 'singular_name' => $default_name,
         ), $r['labels'] );
 
+        // Directory slug.
+        if ( $r['has_directory'] ) {
+                // A string value is intepreted as the directory slug. Otherwise fall back on member type.
+                if ( is_string( $r['has_directory'] ) ) {
+                        $directory_slug = $r['has_directory'];
+                } else {
+                        $directory_slug = $member_type;
+                }
+
+                // Sanitize for use in URLs.
+                $r['directory_slug'] = sanitize_title( $directory_slug );
+                $r['has_directory']  = true;
+        } else {
+                $r['directory_slug'] = '';
+                $r['has_directory']  = false;
+        }
+
         $bp->members->types[ $member_type ] = $type = (object) $r;
 
         /**
@@ -2714 +2732 @@
 }
 add_action( 'wpmu_delete_user', 'bp_remove_member_type_on_user_delete' );
 add_action( 'delete_user', 'bp_remove_member_type_on_user_delete' );
+
+/**
+ * Get the "current" member type, if one is provided, in member directories.
+ *
+ * @since BuddyPress (2.3.0)
+ *
+ * @return string
+ */
+function bp_get_current_member_type() {
+        return apply_filters( 'bp_get_current_member_type', buddypress()->current_member_type );
+}

src/bp-members/bp-members-template.php

@@ -515 +515 @@
                 $user_id = bp_displayed_user_id();
         }
 
+        $member_type = buddypress()->current_member_type;
+        if ( ! $member_type && ! empty( $_GET['member_type'] ) ) {
+                if ( is_array( $_GET['member_type'] ) ) {
+                        $member_type = $_GET['member_type'];
+                } else {
+                        // Can be a comma-separated list.
+                        $member_type = explode( ',', $_GET['member_type'] );
+                }
+        }
+
         // type: active ( default ) | random | newest | popular | online | alphabetical
         $r = bp_parse_args( $args, array(
                 'type'            => 'active',
@@ -528 +538 @@
                 'exclude'         => false,    // Pass a user_id or a list (comma-separated or array) of user_ids to exclude these users
 
                 'user_id'         => $user_id, // Pass a user_id to only show friends of this user
-                'member_type'     => '',
+                'member_type'     => $member_type,
                 'search_terms'    => null,     // Pass search_terms to filter users by their profile data
 
                 'meta_key'        => false,        // Only return users with this usermeta
@@ -1796 +1806 @@
                  */
                 return apply_filters( 'bp_get_loggedin_user_username', $username );
         }
+/**
+ * Echo the current member type message.
+ *
+ * @since BuddyPress (2.3.0)
+ */
+function bp_current_member_type_message() {
+        echo bp_get_current_member_type_message();
+}
+        /**
+         * Generate the current member type message.
+         *
+         * @since BuddyPress (2.3.0)
+         *
+         * @return string
+         */
+        function bp_get_current_member_type_message() {
+                $type_object = bp_get_member_type_object( bp_get_current_member_type() );
+
+                $message = sprintf( __( 'Viewing members of the type: %s', 'buddypress' ), '<strong>' . $type_object->labels['singular_name'] . '</strong>' );
+
+                return apply_filters( 'bp_get_current_member_type_message', $message );
+        }
 
 /** Signup Form ***************************************************************/
 

src/bp-templates/bp-legacy/buddypress/members/members-loop.php

@@ -13 +13 @@
 
 <?php do_action( 'bp_before_members_loop' ); ?>
 
+<?php if ( bp_get_current_member_type() ) : ?>
+        <p class="current-member-type"><?php bp_current_member_type_message() ?></p>
+<?php endif; ?>
+
 <?php if ( bp_has_members( bp_ajax_querystring( 'members' ) ) ) : ?>
 
         <div id="pag-top" class="pagination">

src/bp-templates/bp-legacy/css/buddypress.css

@@ -496 +496 @@
         font-size: 90%;
         padding: 1px 3px;
 }
-
+#buddypress .current-member-type {
+        font-style: italic;
+}
 #buddypress .dir-form {
         clear: both;
 }

tests/phpunit/includes/testcase.php

@@ -44 +44 @@
 
         function clean_up_global_scope() {
                 buddypress()->bp_nav                = buddypress()->bp_options_nav = buddypress()->action_variables = buddypress()->canonical_stack = buddypress()->unfiltered_uri = $GLOBALS['bp_unfiltered_uri'] = array();
-                buddypress()->current_component     = buddypress()->current_item = buddypress()->current_action = '';
+                buddypress()->current_component     = buddypress()->current_item = buddypress()->current_action = buddypress()->current_member_type = '';
                 buddypress()->unfiltered_uri_offset = 0;
                 buddypress()->is_single_item        = false;
                 buddypress()->current_user          = new stdClass();

tests/phpunit/testcases/members/template.php

@@ -132 +132 @@
         }
 
         /**
+         * @group bp_has_members
+         * @ticket BP6286
+         */
+        public function test_bp_has_members_should_infer_member_type_from_get_param() {
+                bp_register_member_type( 'foo' );
+                bp_register_member_type( 'bar' );
+                $users = $this->factory->user->create_many( 3 );
+                bp_set_member_type( $users[0], 'foo' );
+                bp_set_member_type( $users[1], 'bar' );
+
+                global $members_template;
+                $old_members_template = $members_template;
+
+                $old_get = $_GET;
+                $_GET['member_type'] = 'bar';
+
+                bp_has_members();
+
+                $members = is_array( $members_template->members ) ? array_values( $members_template->members ) : array();
+                $member_ids = wp_list_pluck( $members, 'ID' );
+                $this->assertEquals( array( $users[1] ), $member_ids );
+
+                $GLOBALS['members_template'] = $old_members_template;
+        }
+
+        /**
+         * @group bp_has_members
+         * @ticket BP6286
+         */
+        public function test_bp_has_members_should_infer_member_type_from_get_param_comma_sep() {
+                bp_register_member_type( 'foo' );
+                bp_register_member_type( 'bar' );
+                bp_register_member_type( 'baz' );
+                $users = $this->factory->user->create_many( 4 );
+                bp_set_member_type( $users[0], 'foo' );
+                bp_set_member_type( $users[1], 'bar' );
+                bp_set_member_type( $users[2], 'baz' );
+
+                global $members_template;
+                $old_members_template = $members_template;
+
+                $old_get = $_GET;
+                $_GET['member_type'] = 'foo,bar';
+
+                bp_has_members();
+
+                $members = is_array( $members_template->members ) ? array_values( $members_template->members ) : array();
+                $member_ids = wp_list_pluck( $members, 'ID' );
+                $this->assertEqualSets( array( $users[0], $users[1] ), $member_ids );
+
+                $GLOBALS['members_template'] = $old_members_template;
+        }
+
+        /**
          * @group bp_get_member_last_active
          */
         public function test_bp_get_member_last_active_default_params() {

tests/phpunit/testcases/members/types.php

@@ -73 +73 @@
                 $this->assertSame( 'Bar', $object->labels['singular_name'] );
         }
 
+        /**
+         * @ticket BP6286
+         */
+        public function test_bp_register_member_type_has_directory_should_default_to_true() {
+                $object = bp_register_member_type( 'foo', array(
+                        'has_directory' => true,
+                ) );
+
+                $this->assertTrue( $object->has_directory );
+                $this->assertSame( 'foo', $object->directory_slug );
+        }
+
+        /**
+         * @ticket BP6286
+         */
+        public function test_bp_register_member_type_has_directory_true() {
+                $object = bp_register_member_type( 'foo', array(
+                        'has_directory' => true,
+                ) );
+
+                $this->assertTrue( $object->has_directory );
+                $this->assertSame( 'foo', $object->directory_slug );
+        }
+
+        /**
+         * @ticket BP6286
+         */
+        public function test_bp_register_member_type_should_store_has_directory_false() {
+                $object = bp_register_member_type( 'foo', array(
+                        'has_directory' => false,
+                ) );
+
+                $this->assertFalse( $object->has_directory );
+                $this->assertSame( '', $object->directory_slug );
+        }
+
+        /**
+         * @ticket BP6286
+         */
+        public function test_bp_register_member_type_should_store_has_directory_string() {
+                $object = bp_register_member_type( 'foo', array(
+                        'has_directory' => 'foos',
+                ) );
+
+                $this->assertTrue( $object->has_directory );
+                $this->assertSame( 'foos', $object->directory_slug );
+        }
+
         public function test_bp_get_member_type_object_should_return_null_for_non_existent_member_type() {
                 $this->assertSame( null, bp_get_member_type_object( 'foo' ) );
         }

tests/phpunit/testcases/routing/members.php

@@ -9 +9 @@
         public function setUp() {
                 parent::setUp();
 
+                buddypress()->members->types = array();
                 $this->old_current_user = get_current_user_id();
                 $this->set_current_user( $this->factory->user->create( array( 'user_login' => 'paulgibbs', 'role' => 'subscriber' ) ) );
         }
 
         public function tearDown() {
-                parent::tearDown();
                 $this->set_current_user( $this->old_current_user );
+                parent::tearDown();
         }
 
         function test_members_directory() {
@@ -27 +28 @@
                 $this->go_to( bp_core_get_user_domain( bp_loggedin_user_id() ) );
                 $this->assertTrue( bp_is_my_profile() );
         }
+
+        /**
+         * @ticket BP6286
+         * @group member_types
+         */
+        public function test_member_directory_with_member_type() {
+                bp_register_member_type( 'foo' );
+                $this->go_to( bp_get_members_directory_permalink() . 'type/foo/' );
+                $this->assertTrue( bp_is_members_component() );
+        }
+
+        /**
+         * @ticket BP6286
+         * @group member_types
+         */
+        public function test_member_directory_with_member_type_should_obey_filtered_type_slug() {
+                bp_register_member_type( 'foo' );
+
+                add_filter( 'bp_members_member_type_base', array( $this, 'filter_member_type_base' ) );
+                $this->go_to( bp_get_members_directory_permalink() . 'buddypress-member-type/foo/' );
+                remove_filter( 'bp_members_member_type_base', array( $this, 'filter_member_type_base' ) );
+                $this->assertTrue( bp_is_members_component() );
+        }
+
+        public function filter_member_type_base( $base ) {
+                return 'buddypress-member-type';
+        }
+
+        /**
+         * @ticket BP6286
+         * @group member_types
+         */
+        public function test_member_directory_with_member_type_that_has_custom_directory_slug() {
+                bp_register_member_type( 'foo', array( 'has_directory' => 'foos' ) );
+                $this->go_to( bp_get_members_directory_permalink() . 'type/foos/' );
+                $this->assertTrue( bp_is_members_component() );
+        }
+
+        /**
+         * @ticket BP6286
+         * @group member_types
+         */
+        public function test_member_directory_with_member_type_should_be_overridden_by_member_with_same_nicename() {
+                $u = $this->factory->user->create( array( 'user_nicename' => 'foo' ) );
+                bp_register_member_type( 'foo' );
+                $this->go_to( bp_get_members_directory_permalink() . 'type/foo/' );
+        }
+
+        /**
+         * @ticket BP6286
+         * @group member_types
+         */
+        public function test_member_directory_should_404_for_member_types_that_have_no_directory() {
+                bp_register_member_type( 'foo', array( 'has_directory' => false ) );
+                $this->go_to( bp_get_members_directory_permalink() . 'type/foo/' );
+                $this->assertTrue( is_404() );
+        }
 }