<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[BuddyPress][9173] trunk: Generate friend initiation hook dynamically.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://buddypress.trac.wordpress.org/changeset/9173">9173</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/9173","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>boonebgorges</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2014-11-25 14:51:55 +0000 (Tue, 25 Nov 2014)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Generate friend initiation hook dynamically.
This makes it easier to document per WP standards.
Props tw2113.
See <a href="http://buddypress.trac.wordpress.org/ticket/5942">#5942</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpfriendsbpfriendsfunctionsphp">trunk/src/bp-friends/bp-friends-functions.php</a></li>
<li><a href="#trunktestsphpunittestcasesfriendsfunctionsphp">trunk/tests/phpunit/testcases/friends/functions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpfriendsbpfriendsfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-friends/bp-friends-functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-friends/bp-friends-functions.php 2014-11-25 08:45:22 UTC (rev 9172)
+++ trunk/src/bp-friends/bp-friends-functions.php 2014-11-25 14:51:55 UTC (rev 9173)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -59,16 +59,28 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Send notifications
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $force_accept ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $action = 'friends_friendship_requested';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $action = 'requested';
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Update friend totals
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $action = 'friends_friendship_accepted';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $action = 'accepted';
</ins><span class="cx" style="display: block; padding: 0 10px"> friends_update_friend_totals( $friendship->initiator_user_id, $friendship->friend_user_id, 'add' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // 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 );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * 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 );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return true;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestcasesfriendsfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/testcases/friends/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/friends/functions.php 2014-11-25 08:45:22 UTC (rev 9172)
+++ trunk/tests/phpunit/testcases/friends/functions.php 2014-11-25 14:51:55 UTC (rev 9173)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -6,6 +6,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> class BP_Tests_Friends_Functions extends BP_UnitTestCase {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ protected $filter_fired;
+
+ public function setUp() {
+ parent::setUp();
+ $this->filter_fired = '';
+ }
+
+ public function tearDown() {
+ parent::tearDown();
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * @group friends_get_friendship_request_user_ids
</span><span class="cx" style="display: block; padding: 0 10px"> * @group friends_add_friend
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -227,4 +238,37 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( $expected, $found );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * @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;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>