<!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][9174] trunk/src/bp-friends/bp-friends-functions.php: Add hook documentation in bp-friends-functions.php.</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/9174">9174</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/9174","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:59 +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'>Add hook documentation in bp-friends-functions.php.
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>
</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 14:51:55 UTC (rev 9173)
+++ trunk/src/bp-friends/bp-friends-functions.php 2014-11-25 14:51:59 UTC (rev 9174)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -99,18 +99,46 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $friendship_id = BP_Friends_Friendship::get_friendship_id( $initiator_userid, $friend_userid );
</span><span class="cx" style="display: block; padding: 0 10px"> $friendship = new BP_Friends_Friendship( $friendship_id );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Fires before the deletion of a friendship activity item
+ * for the user who canceled the friendship.
+ *
+ * @since BuddyPress (1.5.0)
+ *
+ * @param int $friendship_id ID of the friendship object, if any, between a pair of users.
+ * @param int $initiator_userid ID of the friendship initiator.
+ * @param int $friend_userid ID of the friend user.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'friends_before_friendship_delete', $friendship_id, $initiator_userid, $friend_userid );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Remove the activity stream item for the user who canceled the friendship
</span><span class="cx" style="display: block; padding: 0 10px"> friends_delete_activity( array( 'item_id' => $friendship_id, 'type' => 'friendship_accepted', 'user_id' => bp_displayed_user_id() ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // This hook is misleadingly named - the friendship is not yet deleted.
- // This is your last chance to do something while the friendship exists
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Fires before the friendship connection is removed.
+ *
+ * This hook is misleadingly named - the friendship is not yet deleted.
+ * This is your last chance to do something while the friendship exists.
+ *
+ * @since BuddyPress (1.0.0)
+ *
+ * @param int $friendship_id ID of the friendship object, if any, between a pair of users.
+ * @param int $initiator_userid ID of the friendship initiator.
+ * @param int $friend_userid ID of the friend user.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'friends_friendship_deleted', $friendship_id, $initiator_userid, $friend_userid );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $friendship->delete() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> friends_update_friend_totals( $initiator_userid, $friend_userid, 'remove' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Fires after the friendship connection is removed.
+ *
+ * @since BuddyPress (1.8.0)
+ *
+ * @param int $initiator_userid ID of the friendship initiator.
+ * @param int $friend_userid ID of the friend user.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'friends_friendship_post_delete', $initiator_userid, $friend_userid );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return true;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -138,6 +166,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Bump the friendship counts
</span><span class="cx" style="display: block; padding: 0 10px"> friends_update_friend_totals( $friendship->initiator_user_id, $friendship->friend_user_id );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Fires after a friendship is accepted.
+ *
+ * @since BuddyPress (1.0.0)
+ *
+ * @param int $id ID of the pending friendship object.
+ * @param int $initiator_user_id ID of the friendship initiator.
+ * @param int $friend_user_id ID of the user requested friendship with.
+ * @param object $friendship BuddyPress Friendship Object.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'friends_friendship_accepted', $friendship->id, $friendship->initiator_user_id, $friendship->friend_user_id, $friendship );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return true;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -156,6 +194,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $friendship = new BP_Friends_Friendship( $friendship_id, true, false );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $friendship->is_confirmed ) && BP_Friends_Friendship::reject( $friendship_id ) ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Fires after a friendship request is rejected.
+ *
+ * @since BuddyPress (1.0.0)
+ *
+ * @param int $friendship_id ID of the pending friendship.
+ * @param BP_Friends_Friendship $friendships Friendship object. Passed by reference.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action_ref_array( 'friends_friendship_rejected', array( $friendship_id, &$friendship ) );
</span><span class="cx" style="display: block; padding: 0 10px"> return true;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -180,7 +227,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // @deprecated Since 1.9
</span><span class="cx" style="display: block; padding: 0 10px"> do_action_ref_array( 'friends_friendship_whithdrawn', array( $friendship_id, &$friendship ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // @since 1.9
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Fires after a friendship request has been withdrawn.
+ *
+ * @since BuddyPress (1.9.0)
+ *
+ * @param int $friendship_id ID of the friendship.
+ * @param BP_Friends_Friendship $friendship Friendship object. Passed by reference.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action_ref_array( 'friends_friendship_withdrawn', array( $friendship_id, &$friendship ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return true;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -246,6 +300,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $count ) )
</span><span class="cx" style="display: block; padding: 0 10px"> $count = 0;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters the total friend count for a given user.
+ *
+ * @since BuddyPress (1.2.0)
+ *
+ * @param int $count Total friend count for a given user.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'friends_get_total_friend_count', $count );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -337,6 +398,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array See {@link BP_Core_User::get_users()}.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function friends_get_recently_active( $user_id, $per_page = 0, $page = 0, $filter = '' ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Filters a user's most recently active friends.
+ *
+ * @since BuddyPress (1.2.0)
+ *
+ * @param array {
+ * @type int $total_users Total number of users matched by query params.
+ * @type array $paged_users The current page of users matched by query params.
+ * }
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'friends_get_recently_active', BP_Core_User::get_users( 'active', $per_page, $page, $user_id, $filter ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -355,6 +427,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array See {@link BP_Core_User::get_users()}.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function friends_get_alphabetically( $user_id, $per_page = 0, $page = 0, $filter = '' ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Filters a user's friends listed in alphabetical order.
+ *
+ * @since BuddyPress (1.2.0)
+ *
+ * @return array {
+ * @type int $total_users Total number of users matched by query params.
+ * @type array $paged_users The current page of users matched by query params.
+ * }
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'friends_get_alphabetically', BP_Core_User::get_users( 'alphabetical', $per_page, $page, $user_id, $filter ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -373,6 +456,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array See {@link BP_Core_User::get_users()}.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function friends_get_newest( $user_id, $per_page = 0, $page = 0, $filter = '' ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Filters a user's friends listed from newest to oldest.
+ *
+ * @since BuddyPress (1.2.0)
+ *
+ * @param array {
+ * @type int $total_users Total number of users matched by query params.
+ * @type array $paged_users The current page of users matched by query params.
+ * }
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'friends_get_newest', BP_Core_User::get_users( 'newest', $per_page, $page, $user_id, $filter ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -414,7 +508,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Assume no friends
</span><span class="cx" style="display: block; padding: 0 10px"> $friends = array();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Default args
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters default arguments for list of friends a user can invite into this group.
+ *
+ * @since BuddyPress (1.5.4)
+ *
+ * @param array $value Array of default paremters for invite list.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $args = apply_filters( 'bp_friends_pre_get_invite_list', array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'user_id' => $user_id,
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'alphabetical',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -461,7 +561,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $friends ) )
</span><span class="cx" style="display: block; padding: 0 10px"> $friends = false;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Allow friends to be filtered
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters the list of potential friends that can be invited to this group.
+ *
+ * @since BuddyPress (1.5.4)
+ *
+ * @param array|bool $friends Array friends available to invite or false for no friends.
+ * @param int $user_id ID of the user checked for who they can invite.
+ * @param int $group_id ID of the group being checked on.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'bp_friends_get_invite_list', $friends, $user_id, $group_id );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -566,6 +674,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function friends_remove_data( $user_id ) {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Fires before deletion of friend-related data for a given user.
+ *
+ * @since BuddyPress (1.5.0)
+ *
+ * @param int $user_id ID for the user whose friend data is being removed.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'friends_before_remove_data', $user_id );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> BP_Friends_Friendship::delete_all_for_user( $user_id );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -573,6 +688,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Remove usermeta
</span><span class="cx" style="display: block; padding: 0 10px"> bp_delete_user_meta( $user_id, 'total_friend_count' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Fires after deletion of friend-related data for a given user.
+ *
+ * @since BuddyPress (1.0.0)
+ *
+ * @param int $user_id ID for the user whose friend data is being removed.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'friends_remove_data', $user_id );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'wpmu_delete_user', 'friends_remove_data' );
</span></span></pre>
</div>
</div>
</body>
</html>