Changeset 9173

Timestamp:

11/25/2014 02:51:55 PM (11 years ago)

Author:

boonebgorges

Message:

Generate friend initiation hook dynamically.

This makes it easier to document per WP standards.

Props tw2113.
See #5942.

Location:

trunk

Files:

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

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

@@ -60 +60 @@
     // Send notifications
     if ( empty( $force_accept ) ) {
-        $action = 'friends_friendship_requested';
+        $action = 'requested';
 
     // Update friend totals
     } else {
-        $action = 'friends_friendship_accepted';
+        $action = 'accepted';
         friends_update_friend_totals( $friendship->initiator_user_id, $friendship->friend_user_id, 'add' );
     }
 
-    // Call the above titled action and pass friendship data into it
-    do_action( $action, $friendship->id, $friendship->initiator_user_id, $friendship->friend_user_id, $friendship );
+    /**
+     * Fires at the end of initiating a new friendship connection.
+     *
+     * This is a variable hook, depending on context.
+     * The two potential hooks are: friends_friendship_requested, friends_friendship_accepted.
+     *
+     * @since BuddyPress (1.0.0)
+     *
+     * @param int    $id ID of the pending friendship connection.
+     * @param int    $initiator_user_id ID of the friendship initiator.
+     * @param int    $friend_user_id ID of the friend user.
+     * @param object $friendship BuddyPress Friendship Object.
+     */
+    do_action( 'friends_friendship_' . $action, $friendship->id, $friendship->initiator_user_id, $friendship->friend_user_id, $friendship );
 
     return true;

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

@@ -6 +6 @@
  */
 class BP_Tests_Friends_Functions extends BP_UnitTestCase {
+
+    protected $filter_fired;
+
+    public function setUp() {
+        parent::setUp();
+        $this->filter_fired = '';
+    }
+
+    public function tearDown() {
+        parent::tearDown();
+    }
 
     /**
@@ -228 +239 @@
         $this->assertSame( $expected, $found );
     }
+
+    /**
+     * @group friends_add_friend
+     */
+    public function test_friends_add_friend_friends_friendship_requested() {
+        $u1 = $this->factory->user->create();
+        $u2 = $this->factory->user->create();
+
+        add_filter( 'friends_friendship_requested', array( $this, 'friends_friendship_filter_callback' ) );
+        $n = friends_add_friend( $u1, $u2, false );
+        remove_filter( 'friends_friendship_requested', array( $this, 'friends_friendship_filter_callback' ) );
+
+        $this->assertSame( 'friends_friendship_requested', $this->filter_fired );
+    }
+
+    /**
+     * @group friends_add_friend
+     */
+    public function test_friends_add_friend_friends_friendship_accepted() {
+        $u1 = $this->factory->user->create();
+        $u2 = $this->factory->user->create();
+
+        add_filter( 'friends_friendship_accepted', array( $this, 'friends_friendship_filter_callback' ) );
+        $n = friends_add_friend( $u1, $u2, true );
+        remove_filter( 'friends_friendship_accepted', array( $this, 'friends_friendship_filter_callback' ) );
+
+        $this->assertSame( 'friends_friendship_accepted', $this->filter_fired );
+    }
+
+    public function friends_friendship_filter_callback( $value ) {
+        $this->filter_fired = current_filter();
+        return $value;
+    }
 }