Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
09/27/2015 05:08:37 AM (11 years ago)
Author:
tw2113
Message:

Standardizing our @since tags for the Friends Component.

See #6576.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-friends/bp-friends-template.php

    r9995 r10147  
    11<?php
    2 
    32/**
    43 * BuddyPress Friends Template Functions.
     
    87 */
    98
    10 // Exit if accessed directly
     9// Exit if accessed directly.
    1110defined( 'ABSPATH' ) || exit;
    1211
     
    1413 * Output the friends component slug.
    1514 *
    16  * @since BuddyPress (1.5.0)
     15 * @since 1.5.0
    1716 *
    1817 * @uses bp_get_friends_slug()
     
    2423         * Return the friends component slug.
    2524         *
    26          * @since BuddyPress (1.5.0)
     25         * @since 1.5.0
    2726         */
    2827        function bp_get_friends_slug() {
     
    3130                 * Filters the friends component slug.
    3231                 *
    33                  * @since BuddyPress (1.5.0)
     32                 * @since 1.5.0
    3433                 *
    3534                 * @param string $value Friends component slug.
     
    4140 * Output the friends component root slug.
    4241 *
    43  * @since BuddyPress (1.5.0)
     42 * @since 1.5.0
    4443 *
    4544 * @uses bp_get_friends_root_slug()
     
    5150         * Return the friends component root slug.
    5251         *
    53          * @since BuddyPress (1.5.0)
     52         * @since 1.5.0
    5453         */
    5554        function bp_get_friends_root_slug() {
     
    5857                 * Filters the friends component root slug.
    5958                 *
    60                  * @since BuddyPress (1.5.0)
     59                 * @since 1.5.0
    6160                 *
    6261                 * @param string $value Friends component root slug.
     
    206205 * Output the "Add Friend" button in the member loop.
    207206 *
    208  * @since BuddyPress (1.2.6)
     207 * @since 1.2.6
    209208 */
    210209function bp_member_add_friend_button() {
     
    234233                         * Filters text used to denote total friend count.
    235234                         *
    236                          * @since BuddyPress (1.2.0)
     235                         * @since 1.2.0
    237236                         *
    238237                         * @param string $value String of the form "x friends".
     
    278277                 * Filters the ID of current user in the friend request loop.
    279278                 *
    280                  * @since BuddyPress (1.2.10)
     279                 * @since 1.2.10
    281280                 *
    282281                 * @param int $user_id ID of current user in the friend request loop.
     
    309308         * Filters the status of friendship between logged in user and given user.
    310309         *
    311          * @since BuddyPress (1.2.10)
     310         * @since 1.2.10
    312311         *
    313312         * @param string $value String status of friendship. Possible values are 'is_friend', 'not_friends', 'pending'.
     
    419418                 * Filters the HTML for the add friend button.
    420419                 *
    421                  * @since BuddyPress (1.1.0)
     420                 * @since 1.1.0
    422421                 *
    423422                 * @param string $button HTML markup for add friend button.
     
    479478         * Filters the total pending friendship requests for a user.
    480479         *
    481          * @since BuddyPress (1.2.0)
     480         * @since 1.2.0
    482481         *
    483482         * @param array|int An array of user IDs if found, or a 0 if none are found.
     
    508507                 * Filters the ID of the friendship between the logged in user and the current user in the loop.
    509508                 *
    510                  * @since BuddyPress (1.2.0)
     509                 * @since 1.2.0
    511510                 *
    512511                 * @param int $friendship_id ID of the friendship.
     
    537536                 * Filters the URL for accepting the current friendship request in the loop.
    538537                 *
    539                  * @since BuddyPress (1.0.0)
     538                 * @since 1.0.0
    540539                 *
    541540                 * @param string $value Accept-friendship URL.
     
    566565                 * Filters the URL for rejecting the current friendship request in the loop.
    567566                 *
    568                  * @since BuddyPress (1.0.0)
     567                 * @since 1.0.0
    569568                 *
    570569                 * @param string $value Reject-friendship URL.
     
    593592                 * Filters the total friend count for a given user.
    594593                 *
    595                  * @since BuddyPress (1.2.0)
     594                 * @since 1.2.0
    596595                 *
    597596                 * @param int $value Total friend count.
     
    626625                 * Filters the total friendship request count for a given user.
    627626                 *
    628                  * @since BuddyPress (1.2.0)
     627                 * @since 1.2.0
    629628                 *
    630629                 * @param int $value Friendship request count.
     
    638637 * Display the number of friends in user's profile.
    639638 *
    640  * @since BuddyPress (2.0.0)
     639 * @since 2.0.0
    641640 *
    642641 * @uses bp_friends_get_profile_stats() to get the stats.
     
    652651 * Return the number of friends in user's profile.
    653652 *
    654  * @since BuddyPress (2.0.0)
     653 * @since 2.0.0
    655654 *
    656655 * @param array|string $args before|after|user_id
     
    688687         * Filters the number of friends in user's profile.
    689688         *
    690          * @since BuddyPress (2.0.0)
     689         * @since 2.0.0
    691690         *
    692691         * @param string $value Formatted string displaying total friends count.
Note: See TracChangeset for help on using the changeset viewer.