<!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][9176] trunk/src/bp-friends/bp-friends-template.php: Add hook documentation in bp-friends-template.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/9176">9176</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/9176","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 15:00:40 +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-template.php.
Props tw2113.
See <a href="http://buddypress.trac.wordpress.org/ticket/5942">#5942</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpfriendsbpfriendstemplatephp">trunk/src/bp-friends/bp-friends-template.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpfriendsbpfriendstemplatephp"></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-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-friends/bp-friends-template.php 2014-11-25 15:00:37 UTC (rev 9175)
+++ trunk/src/bp-friends/bp-friends-template.php 2014-11-25 15:00:40 UTC (rev 9176)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -26,6 +26,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since BuddyPress (1.5.0)
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_get_friends_slug() {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Filters the friends component slug.
+ *
+ * @since BuddyPress (1.5.0)
+ *
+ * @param string $value Friends component slug.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'bp_get_friends_slug', buddypress()->friends->slug );
</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">@@ -45,6 +53,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since BuddyPress (1.5.0)
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_get_friends_root_slug() {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Filters the friends component root slug.
+ *
+ * @since BuddyPress (1.5.0)
+ *
+ * @param string $value Friends component root slug.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'bp_get_friends_root_slug', buddypress()->friends->root_slug );
</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">@@ -212,10 +228,22 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_get_member_total_friend_count() {
</span><span class="cx" style="display: block; padding: 0 10px"> global $members_template;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( 1 == (int) $members_template->member->total_friend_count )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( 1 == (int) $members_template->member->total_friend_count ) {
+
+ /**
+ * Filters text used to denote total friend count.
+ *
+ * @since BuddyPress (1.2.0)
+ *
+ * @param string $value String of the form "x friends".
+ * @param int $value Total friend count for current member in the loop.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'bp_get_member_total_friend_count', sprintf( __( '%d friend', 'buddypress' ), (int) $members_template->member->total_friend_count ) );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- else
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } else {
+
+ /** This filter is documented in bp-friends/bp-friends-template.php */
</ins><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'bp_get_member_total_friend_count', sprintf( __( '%d friends', 'buddypress' ), (int) $members_template->member->total_friend_count ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</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">@@ -245,6 +273,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> else if ( empty( $user_id ) && !isset( $friends_template->friendship->friend ) )
</span><span class="cx" style="display: block; padding: 0 10px"> $user_id = bp_displayed_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">+ /**
+ * Filters the ID of current user in the friend request loop.
+ *
+ * @since BuddyPress (1.2.10)
+ *
+ * @param int $user_id ID of current user in the friend request loop.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'bp_get_potential_friend_id', (int) $user_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">@@ -268,6 +303,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( bp_loggedin_user_id() == $user_id )
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</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 status of friendship between logged in user and given user.
+ *
+ * @since BuddyPress (1.2.10)
+ *
+ * @param string $value String status of friendship. Possible values are 'is_friend', 'not_friends', 'pending'.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'bp_is_friend', friends_check_friendship_status( bp_loggedin_user_id(), $user_id ), $user_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">@@ -370,7 +412,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> break;
</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">- // Filter and return the HTML button
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters the HTML for the add friend button.
+ *
+ * @since BuddyPress (1.1.0)
+ *
+ * @param string $button HTML markup for add friend button.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> return bp_get_button( apply_filters( 'bp_get_add_friend_button', $button ) );
</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">@@ -422,6 +470,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $requests = 0;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</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 pending friendship requests for a user.
+ *
+ * @since BuddyPress (1.2.0)
+ *
+ * @param array|int An array of user IDs if found, or a 0 if none are found.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'bp_get_friendship_requests', $requests );
</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">@@ -444,6 +499,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> wp_cache_set( 'friendship_id_' . $members_template->member->id . '_' . bp_loggedin_user_id(), $friendship_id, 'bp' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</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 ID of the friendship between the logged in user and the current user in the loop.
+ *
+ * @since BuddyPress (1.2.0)
+ *
+ * @param int $friendship_id ID of the friendship.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'bp_get_friend_friendship_id', $friendship_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">@@ -466,6 +528,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> wp_cache_set( 'friendship_id_' . $members_template->member->id . '_' . bp_loggedin_user_id(), $friendship_id, 'bp' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</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 URL for accepting the current friendship request in the loop.
+ *
+ * @since BuddyPress (1.0.0)
+ *
+ * @param string $value Accept-friendship URL.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'bp_get_friend_accept_request_link', wp_nonce_url( bp_loggedin_user_domain() . bp_get_friends_slug() . '/requests/accept/' . $friendship_id, 'friends_accept_friendship' ) );
</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">@@ -488,6 +557,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> wp_cache_set( 'friendship_id_' . $members_template->member->id . '_' . bp_loggedin_user_id(), $friendship_id, 'bp' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</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 URL for rejecting the current friendship request in the loop.
+ *
+ * @since BuddyPress (1.0.0)
+ *
+ * @param string $value Reject-friendship URL.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'bp_get_friend_reject_request_link', wp_nonce_url( bp_loggedin_user_domain() . bp_get_friends_slug() . '/requests/reject/' . $friendship_id, 'friends_reject_friendship' ) );
</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">@@ -506,6 +582,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return int Total friend count.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_get_total_friend_count( $user_id = 0 ) {
</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 $value Total friend count.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'bp_get_total_friend_count', friends_get_total_friend_count( $user_id ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'bp_get_total_friend_count', 'bp_core_number_format' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -531,6 +615,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $user_id ) )
</span><span class="cx" style="display: block; padding: 0 10px"> $user_id = bp_loggedin_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">+ /**
+ * Filters the total friendship request count for a given user.
+ *
+ * @since BuddyPress (1.2.0)
+ *
+ * @param int $value Friendship request count.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'bp_friend_get_total_requests_count', count( BP_Friends_Friendship::get_friend_user_ids( $user_id, true ) ) );
</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">@@ -584,6 +675,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</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">- // Filter and return
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters the number of friends in user's profile.
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @param string $value Formatted string displaying total friends count.
+ * @param array $r Array of arguments for string formatting and output.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'bp_friends_get_profile_stats', $r['output'], $r );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>