Changeset 9176

Timestamp:

11/25/2014 03:00:40 PM (10 years ago)

Author:

boonebgorges

Message:

Add hook documentation in bp-friends-template.php.

Props tw2113.
See #5942.

File:

• trunk/src/bp-friends/bp-friends-template.php (modified) (13 diffs)

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

@@ -27 +27 @@
      */
     function bp_get_friends_slug() {
+
+        /**
+         * Filters the friends component slug.
+         *
+         * @since BuddyPress (1.5.0)
+         *
+         * @param string $value Friends component slug.
+         */
         return apply_filters( 'bp_get_friends_slug', buddypress()->friends->slug );
     }
@@ -46 +54 @@
      */
     function bp_get_friends_root_slug() {
+
+        /**
+         * Filters the friends component root slug.
+         *
+         * @since BuddyPress (1.5.0)
+         *
+         * @param string $value Friends component root slug.
+         */
         return apply_filters( 'bp_get_friends_root_slug', buddypress()->friends->root_slug );
     }
@@ -213 +229 @@
         global $members_template;
 
-        if ( 1 == (int) $members_template->member->total_friend_count )
+        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.
+             */
             return apply_filters( 'bp_get_member_total_friend_count', sprintf( __( '%d friend', 'buddypress' ), (int) $members_template->member->total_friend_count ) );
-        else
+        } else {
+
+            /** This filter is documented in bp-friends/bp-friends-template.php */
             return apply_filters( 'bp_get_member_total_friend_count', sprintf( __( '%d friends', 'buddypress' ), (int) $members_template->member->total_friend_count ) );
+        }
     }
 
@@ -246 +274 @@
             $user_id = bp_displayed_user_id();
 
+        /**
+         * 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.
+         */
         return apply_filters( 'bp_get_potential_friend_id', (int) $user_id );
     }
@@ -269 +304 @@
         return false;
 
+    /**
+     * 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'.
+     */
     return apply_filters( 'bp_is_friend', friends_check_friendship_status( bp_loggedin_user_id(), $user_id ), $user_id );
 }
@@ -371 +413 @@
         }
 
-        // Filter and return the HTML button
+        /**
+         * Filters the HTML for the add friend button.
+         *
+         * @since BuddyPress (1.1.0)
+         *
+         * @param string $button HTML markup for add friend button.
+         */
         return bp_get_button( apply_filters( 'bp_get_add_friend_button', $button ) );
     }
@@ -423 +471 @@
     }
 
+    /**
+     * 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.
+     */
     return apply_filters( 'bp_get_friendship_requests', $requests );
 }
@@ -445 +500 @@
         }
 
+        /**
+         * 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.
+         */
         return apply_filters( 'bp_get_friend_friendship_id', $friendship_id );
     }
@@ -467 +529 @@
         }
 
+        /**
+         * Filters the URL for accepting the current friendship request in the loop.
+         *
+         * @since BuddyPress (1.0.0)
+         *
+         * @param string $value Accept-friendship URL.
+         */
         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' ) );
     }
@@ -489 +558 @@
         }
 
+        /**
+         * Filters the URL for rejecting the current friendship request in the loop.
+         *
+         * @since BuddyPress (1.0.0)
+         *
+         * @param string $value Reject-friendship URL.
+         */
         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' ) );
     }
@@ -507 +583 @@
      */
     function bp_get_total_friend_count( $user_id = 0 ) {
+
+        /**
+         * Filters the total friend count for a given user.
+         *
+         * @since BuddyPress (1.2.0)
+         *
+         * @param int $value Total friend count.
+         */
         return apply_filters( 'bp_get_total_friend_count', friends_get_total_friend_count( $user_id ) );
     }
@@ -532 +616 @@
             $user_id = bp_loggedin_user_id();
 
+        /**
+         * Filters the total friendship request count for a given user.
+         *
+         * @since BuddyPress (1.2.0)
+         *
+         * @param int $value Friendship request count.
+         */
         return apply_filters( 'bp_friend_get_total_requests_count', count( BP_Friends_Friendship::get_friend_user_ids( $user_id, true ) ) );
     }
@@ -585 +676 @@
     }
 
-    // Filter and return
+    /**
+     * 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.
+     */
     return apply_filters( 'bp_friends_get_profile_stats', $r['output'], $r );
 }