Changeset 10323 for trunk/src/bp-friends/bp-friends-template.php

Timestamp:

11/02/2015 02:07:44 AM (10 years ago)

Author:

tw2113

Message:

More docs cleanup for Friends component.

See #6400.

File:

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

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

@@ -263 +263 @@
      * @param int $user_id Optional. If provided, the function will simply
      *                     return this value.
-     *
      * @return int ID of potential friend.
      */
@@ -291 +290 @@
  * @param int $user_id ID of the potential friend. Default: the value of
  *                     {@link bp_get_potential_friend_id()}.
- *
  * @return string 'is_friend', 'not_friends', or 'pending'.
  */
@@ -332 +330 @@
      *                                  applies. Default: value of {@link bp_get_potential_friend_id()}.
      * @param bool $friend_status       Not currently used.
-     *
      * @return string HTML for the Add Friend button.
      */
@@ -357 +354 @@
                     'link_text'         => __( 'Cancel Friendship Request', 'buddypress' ),
                     'link_title'        => __( 'Cancel Friendship Requested', 'buddypress' ),
-                    'link_id'           => 'friend-' . $potential_friend_id,
-                    'link_rel'          => 'remove',
+                    'link_id'           => 'friend-' . $potential_friend_id,
+                    'link_rel'          => 'remove',
                     'link_class'        => 'friendship-button pending_friend requested'
                 );
@@ -430 +427 @@
  * @param int $user_id Optional. Default: the displayed user's ID, or the
  *                     logged-in user's ID.
- *
  * @return string|bool A comma-separated list of friend IDs if any are found,
  *                     otherwise false.
@@ -455 +451 @@
  * @param int $user_id ID of the user whose requests are being retrieved.
  *                     Defaults to displayed user.
- *
  * @return array|int An array of user IDs if found, or a 0 if none are found.
  */
@@ -584 +579 @@
      *
      * @param int $user_id See {@link friends_get_total_friend_count()}.
-     *
      * @return int Total friend count.
      */
@@ -615 +609 @@
      * @param int $user_id ID of the user whose requests are being counted.
      *                     Default: ID of the logged-in user.
-     *
      * @return int Friend count.
      */
@@ -641 +634 @@
  * @uses bp_friends_get_profile_stats() to get the stats.
  *
- * @param array|string $args before|after|user_id
+ * @param array|string $args before|after|user_id.
  */
 function bp_friends_profile_stats( $args = '' ) {
@@ -653 +646 @@
  * @since 2.0.0
  *
- * @param array|string $args before|after|user_id
- *
+ * @param array|string $args before|after|user_id.
  * @return string HTML for stats output.
  */
 function bp_friends_get_profile_stats( $args = '' ) {
 
-    // Parse the args
+    // Parse the args.
     $r = bp_parse_args( $args, array(
         'before'  => '<li class="bp-friends-profile-stats">',
@@ -668 +660 @@
     ), 'friends_get_profile_stats' );
 
-    // Allow completely overloaded output
+    // Allow completely overloaded output.
     if ( empty( $r['output'] ) ) {
 
-        // Only proceed if a user ID was passed
+        // Only proceed if a user ID was passed.
         if ( ! empty( $r['user_id'] ) ) {
 
-            // Get the user's friends
+            // Get the user's friends.
             if ( empty( $r['friends'] ) ) {
                 $r['friends'] = absint( friends_get_total_friend_count( $r['user_id'] ) );
             }
 
-            // If friends exist, show some formatted output
+            // If friends exist, show some formatted output.
             $r['output'] = $r['before'] . sprintf( _n( '%s friend', '%s friends', $r['friends'], 'buddypress' ), '<strong>' . $r['friends'] . '</strong>' ) . $r['after'];
         }