Changeset 9575

Timestamp:

03/02/2015 06:53:12 PM (6 years ago)

Author:

boonebgorges

Message:

Introduce bp_remove_member_type().

Props Offereins, Mamaduka.
Fixes #6188.

Location:

trunk

Files:

• src/bp-members/bp-members-functions.php (modified) (1 diff)
• tests/phpunit/testcases/members/types.php (modified) (1 diff)

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

@@ -2602 +2602 @@
 
 /**
+ * Remove type for a member.
+ *
+ * @since BuddyPress (2.3.0)
+ *
+ * @param int    $user_id     ID of the user.
+ * @param string $member_type Member Type.
+ *
+ * @return bool|WP_Error
+ */
+function bp_remove_member_type( $user_id, $member_type ) {
+    // Bail if no valid member type was passed.
+    if ( empty( $member_type ) || ! bp_get_member_type_object( $member_type ) ) {
+        return false;
+    }
+
+    $deleted = wp_remove_object_terms( $user_id, $member_type, 'bp_member_type' );
+
+    // Bust the cache if the type has been removed.
+    if ( ! is_wp_error( $deleted ) ) {
+        wp_cache_delete( $user_id, 'bp_member_member_type' );
+
+        /**
+         * Fires just after a user's member type has been removed.
+         *
+         * @since BuddyPress (2.3.0)
+         *
+         * @param int    $user_id     ID of the user whose member type has been updated.
+         * @param string $member_type Member type.
+         */
+        do_action( 'bp_remove_member_type', $user_id, $member_type );
+    }
+
+    return $deleted;
+}
+
+/**
  * Get type for a member.
  *

trunk/tests/phpunit/testcases/members/types.php

@@ -236 +236 @@
         $this->assertSame( 'foo', bp_get_member_type( $new_user_id, true ) );
     }
+
+    /**
+     * @group BP6188
+     */
+    public function test_bp_remove_member_type_should_return_false_when_member_type_is_empty() {
+        $this->assertFalse( bp_remove_member_type( 5, '' ) );
+    }
+
+    /**
+     * @group BP6188
+     */
+    public function test_bp_remove_member_type_should_return_false_when_member_type_is_invalid() {
+        $this->assertFalse( bp_remove_member_type( 5, 'foo' ) );
+    }
+
+    /**
+     * @group BP6188
+     */
+    public function test_bp_remove_member_type_should_return_false_when_member_is_not_of_provided_type() {
+        $u1 = $this->factory->user->create();
+        bp_register_member_type( 'foo' );
+        bp_register_member_type( 'bar' );
+        bp_set_member_type( $u1, 'bar' );
+
+        $this->assertFalse( bp_remove_member_type( $u1, 'foo' ) );
+        $types = bp_get_member_type( $u1, false );
+        $this->assertEquals( array( 'bar' ), $types );
+    }
+
+    /**
+     * @group BP6188
+     */
+    public function test_bp_remove_member_type_should_return_true_for_successful_deletion() {
+        $u1 = $this->factory->user->create();
+        bp_register_member_type( 'foo' );
+        bp_register_member_type( 'bar' );
+        bp_set_member_type( $u1, 'foo' );
+        bp_set_member_type( $u1, 'bar', true );
+
+        $this->assertTrue( bp_remove_member_type( $u1, 'foo' ) );
+        $types = bp_get_member_type( $u1, false );
+        $this->assertEquals( array( 'bar' ), $types );
+    }
 }