Skip to:
Content

BuddyPress.org

Changeset 10147


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

Standardizing our @since tags for the Friends Component.

See #6576.

Location:
trunk/src/bp-friends
Files:
12 edited

Legend:

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

    r9995 r10147  
    11<?php
    2 
    32/**
    43 * BuddyPress Friends Actions.
     
    1211 */
    1312
    14 // Exit if accessed directly
     13// Exit if accessed directly.
    1514defined( 'ABSPATH' ) || exit;
    1615
  • trunk/src/bp-friends/bp-friends-activity.php

    r9995 r10147  
    11<?php
    2 
    32/**
    43 * BuddyPress Friends Activity Functions.
     
    1110 */
    1211
    13 // Exit if accessed directly
     12// Exit if accessed directly.
    1413defined( 'ABSPATH' ) || exit;
    1514
     
    117116     * Fires after all default bp-friends activity actions have been registered.
    118117     *
    119      * @since BuddyPress (1.1.0)
     118     * @since 1.1.0
    120119     */
    121120    do_action( 'friends_register_activity_actions' );
     
    126125 * Format 'friendship_accepted' activity actions.
    127126 *
    128  * @since BuddyPress (2.0.0)
     127 * @since 2.0.0
    129128 *
    130129 * @param string $action   Activity action string.
     
    150149     * Filters the 'friendship_accepted' activity action format.
    151150     *
    152      * @since BuddyPress (2.0.0)
     151     * @since 2.0.0
    153152     *
    154153     * @param string $action   String text for the 'friendship_accepted' action.
     
    161160 * Format 'friendship_created' activity actions.
    162161 *
    163  * @since BuddyPress (2.0.0)
     162 * @since 2.0.0
    164163 *
    165164 * @param string $action   Static activity action.
     
    185184     * Filters the 'friendship_created' activity action format.
    186185     *
    187      * @since BuddyPress (2.0.0)
     186     * @since 2.0.0
    188187     *
    189188     * @param string $action   String text for the 'friendship_created' action.
     
    198197 * This reduces database overhead during the activity loop.
    199198 *
    200  * @since BuddyPress (2.0.0)
     199 * @since 2.0.0
    201200 *
    202201 * @param array $activities Array of activity items.
     
    237236 * For details on the syntax, see {@link BP_Activity_Query}.
    238237 *
    239  * @since BuddyPress (2.2.0)
     238 * @since 2.2.0
    240239 *
    241240 * @param array $retval Empty array by default
     
    291290 * For details on the syntax, see {@link BP_Activity_Query}.
    292291 *
    293  * @since BuddyPress (2.2.0)
     292 * @since 2.2.0
    294293 *
    295294 * @param array $retval Empty array by default
     
    368367 * for virtual friendship.
    369368 *
    370  * @since BuddyPress (1.9.0)
     369 * @since 1.9.0
    371370 *
    372371 * @param int         $friendship_id
  • trunk/src/bp-friends/bp-friends-cache.php

    r9995 r10147  
    11<?php
    2 
    32/**
    43 * BuddyPress Friends Caching.
     
    1110 */
    1211
    13 // Exit if accessed directly
     12// Exit if accessed directly.
    1413defined( 'ABSPATH' ) || exit;
    1514
     
    3736 * Clear the friend request cache for the user not initiating the friendship.
    3837 *
    39  * @since BuddyPress (2.0.0)
     38 * @since 2.0.0
    4039 *
    4140 * @param int $friend_user_id The user ID not initiating the friendship.
     
    5049 * A friendship is deemed saved when a friendship is requested or accepted.
    5150 *
    52  * @since BuddyPress (2.0.0)
     51 * @since 2.0.0
    5352 *
    5453 * @param int $friendship_id     The friendship ID.
     
    6766 * A friendship is deemed removed when a friendship is withdrawn or rejected.
    6867 *
    69  * @since BuddyPress (2.0.0)
     68 * @since 2.0.0
    7069 *
    7170 * @param int                   $friendship_id The friendship ID.
  • trunk/src/bp-friends/bp-friends-classes.php

    r9995 r10147  
    77 */
    88
    9 // Exit if accessed directly
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
  • trunk/src/bp-friends/bp-friends-filters.php

    r10042 r10147  
    11<?php
    2 
    32/**
    43 * BuddyPress Friend Filters.
     
    87 */
    98
     9// Exit if accessed directly.
     10defined( 'ABSPATH' ) || exit;
     11
    1012/**
    1113 * Filter BP_User_Query::populate_extras to add confirmed friendship status.
     
    1416 * against the logged-in user.
    1517 *
    16  * @since BuddyPress (1.7.0)
     18 * @since 1.7.0
    1719 *
    1820 * @global WPDB $wpdb WordPress database access object.
  • trunk/src/bp-friends/bp-friends-functions.php

    r10037 r10147  
    11<?php
    2 
    32/**
    43 * BuddyPress Friends Functions.
     
    1312 */
    1413
    15 // Exit if accessed directly
     14// Exit if accessed directly.
    1615defined( 'ABSPATH' ) || exit;
    1716
     
    7574     * The two potential hooks are: friends_friendship_requested, friends_friendship_accepted.
    7675     *
    77      * @since BuddyPress (1.0.0)
     76     * @since 1.0.0
    7877     *
    7978     * @param int    $id                ID of the pending friendship connection.
     
    106105     * for the user who canceled the friendship.
    107106     *
    108      * @since BuddyPress (1.5.0)
     107     * @since 1.5.0
    109108     *
    110109     * @param int $friendship_id    ID of the friendship object, if any, between a pair of users.
     
    123122     * This is your last chance to do something while the friendship exists.
    124123     *
    125      * @since BuddyPress (1.0.0)
     124     * @since 1.0.0
    126125     *
    127126     * @param int $friendship_id    ID of the friendship object, if any, between a pair of users.
     
    137136         * Fires after the friendship connection is removed.
    138137         *
    139          * @since BuddyPress (1.8.0)
     138         * @since 1.8.0
    140139         *
    141140         * @param int $initiator_userid ID of the friendship initiator.
     
    173172         * Fires after a friendship is accepted.
    174173         *
    175          * @since BuddyPress (1.0.0)
     174         * @since 1.0.0
    176175         *
    177176         * @param int    $id                ID of the pending friendship object.
     
    203202         * Fires after a friendship request is rejected.
    204203         *
    205          * @since BuddyPress (1.0.0)
     204         * @since 1.0.0
    206205         *
    207206         * @param int                   $friendship_id ID of the pending friendship.
     
    236235         * Fires after a friendship request has been withdrawn.
    237236         *
    238          * @since BuddyPress (1.9.0)
     237         * @since 1.9.0
    239238         *
    240239         * @param int                   $friendship_id ID of the friendship.
     
    307306     * Filters the total friend count for a given user.
    308307     *
    309      * @since BuddyPress (1.2.0)
     308     * @since 1.2.0
    310309     *
    311310     * @param int $count Total friend count for a given user.
     
    412411     * Filters a user's most recently active friends.
    413412     *
    414      * @since BuddyPress (1.2.0)
     413     * @since 1.2.0
    415414     *
    416415     * @param array {
     
    442441     * Filters a user's friends listed in alphabetical order.
    443442     *
    444      * @since BuddyPress (1.2.0)
     443     * @since 1.2.0
    445444     *
    446445     * @return array {
     
    472471     * Filters a user's friends listed from newest to oldest.
    473472     *
    474      * @since BuddyPress (1.2.0)
     473     * @since 1.2.0
    475474     *
    476475     * @param array {
     
    502501 * user is not a group admin.
    503502 *
    504  * @since BuddyPress (1.0.0)
     503 * @since 1.0.0
    505504 *
    506505 * @param int $user_id  User ID whose friends to see can be invited. Default:
     
    525524     * Filters default arguments for list of friends a user can invite into this group.
    526525     *
    527      * @since BuddyPress (1.5.4)
     526     * @since 1.5.4
    528527     *
    529528     * @param array $value Array of default parameters for invite list.
     
    578577     * Filters the list of potential friends that can be invited to this group.
    579578     *
    580      * @since BuddyPress (1.5.4)
     579     * @since 1.5.4
    581580     *
    582581     * @param array|bool $friends  Array friends available to invite or false for no friends.
     
    695694     * Fires before deletion of friend-related data for a given user.
    696695     *
    697      * @since BuddyPress (1.5.0)
     696     * @since 1.5.0
    698697     *
    699698     * @param int $user_id ID for the user whose friend data is being removed.
     
    709708     * Fires after deletion of friend-related data for a given user.
    710709     *
    711      * @since BuddyPress (1.0.0)
     710     * @since 1.0.0
    712711     *
    713712     * @param int $user_id ID for the user whose friend data is being removed.
  • trunk/src/bp-friends/bp-friends-loader.php

    r9995 r10147  
    99 */
    1010
    11 // Exit if accessed directly
     11// Exit if accessed directly.
    1212defined( 'ABSPATH' ) || exit;
    1313
     
    1717     * Start the friends component creation process.
    1818     *
    19      * @since BuddyPress (1.5.0)
     19     * @since 1.5.0
    2020     */
    2121    public function __construct() {
     
    6060     * backwards compatibility.
    6161     *
    62      * @since BuddyPress (1.5.0)
     62     * @since 1.5.0
    6363     *
    6464     * @see BP_Component::setup_globals() for description of parameters.
     
    102102     * Set up component navigation.
    103103     *
    104      * @since BuddyPress (1.5.0)
     104     * @since 1.5.0
    105105     *
    106106     * @see BP_Component::setup_nav() for a description of arguments.
     
    165165     * Set up bp-friends integration with the WordPress admin bar.
    166166     *
    167      * @since BuddyPress (1.5.0)
     167     * @since 1.5.0
    168168     *
    169169     * @see BP_Component::setup_admin_bar() for a description of arguments.
     
    245245     * Setup cache groups.
    246246     *
    247      * @since BuddyPress (2.2.0)
     247     * @since 2.2.0
    248248     */
    249249    public function setup_cache_groups() {
  • trunk/src/bp-friends/bp-friends-notifications.php

    r9995 r10147  
    11<?php
    2 
    32/**
    43 * BuddyPress Friends Activity Functions.
     
    1110 */
    1211
    13 // Exit if accessed directly
     12// Exit if accessed directly.
    1413defined( 'ABSPATH' ) || exit;
    1514
     
    6261     * Filters the email address for who is getting the friend request.
    6362     *
    64      * @since BuddyPress (1.2.0)
     63     * @since 1.2.0
    6564     *
    6665     * @param string $to Email address for who is getting the friend request.
     
    7170     * Filters the subject for the friend request email.
    7271     *
    73      * @since BuddyPress (1.2.0)
     72     * @since 1.2.0
    7473     *
    7574     * @param string $subject        Subject line to be used in friend request email.
     
    8180     * Filters the message for the friend request email.
    8281     *
    83      * @since BuddyPress (1.2.0)
     82     * @since 1.2.0
    8483     *
    8584     * @param string $message           Message to be used in friend request email.
     
    9695     * Fires after the new friend request email is sent.
    9796     *
    98      * @since BuddyPress (1.5.0)
     97     * @since 1.5.0
    9998     *
    10099     * @param int    $friend_id     ID of the request recipient.
     
    151150     * Filters the email address for whose friend request got accepted.
    152151     *
    153      * @since BuddyPress (1.2.0)
     152     * @since 1.2.0
    154153     *
    155154     * @param string $to Email address for whose friend request got accepted.
     
    160159     * Filters the subject for the friend request accepted email.
    161160     *
    162      * @since BuddyPress (1.2.0)
     161     * @since 1.2.0
    163162     *
    164163     * @param string $subject     Subject line to be used in friend request accepted email.
     
    170169     * Filters the message for the friend request accepted email.
    171170     *
    172      * @since BuddyPress (1.2.0)
     171     * @since 1.2.0
    173172     *
    174173     * @param string $message       Message to be used in friend request email.
     
    184183     * Fires after the friend request accepted email is sent.
    185184     *
    186      * @since BuddyPress (1.5.0)
     185     * @since 1.5.0
    187186     *
    188187     * @param int    $initiator_id  ID of the friendship requester.
     
    261260         *   - bp_friends_multiple_friendship_request_notification
    262261         *
    263          * @since BuddyPress (1.0.0)
     262         * @since 1.0.0
    264263         *
    265264         * @param string|array $value       Depending on format, an HTML link to new requests profile
     
    281280     * Fires at the end of the bp-friends notification format callback.
    282281     *
    283      * @since BuddyPress (1.0.0)
     282     * @since 1.0.0
    284283     *
    285284     * @param string       $action            The kind of notification being rendered.
     
    308307 * Delete any friendship request notifications for the logged in user.
    309308 *
    310  * @since BuddyPress (1.9.0)
     309 * @since 1.9.0
    311310 */
    312311function bp_friends_mark_friendship_request_notifications_by_type() {
     
    320319 * Delete any friendship acceptance notifications for the logged in user.
    321320 *
    322  * @since BuddyPress (1.9.0)
     321 * @since 1.9.0
    323322 */
    324323function bp_friends_mark_friendship_accepted_notifications_by_type() {
     
    332331 * Notify one use that another user has requested their virtual friendship.
    333332 *
    334  * @since BuddyPress (1.9.0)
     333 * @since 1.9.0
    335334 * @param int $friendship_id     The unique ID of the friendship.
    336335 * @param int $initiator_user_id The friendship initiator user ID.
     
    355354 * Remove friend request notice when a member rejects another members
    356355 *
    357  * @since BuddyPress (1.9.0)
     356 * @since 1.9.0
    358357 *
    359358 * @param int    $friendship_id (not used)
     
    370369 * Notify a member when another member accepts their virtual friendship request.
    371370 *
    372  * @since BuddyPress (1.9.0)
     371 * @since 1.9.0
    373372 *
    374373 * @param int $friendship_id     The unique ID of the friendship.
     
    402401 * Remove friend request notice when a member withdraws their friend request.
    403402 *
    404  * @since BuddyPress (1.9.0)
     403 * @since 1.9.0
    405404 *
    406405 * @param int    $friendship_id (not used)
     
    417416 * Remove friendship requests FROM user, used primarily when a user is deleted.
    418417 *
    419  * @since BuddyPress (1.9.0)
     418 * @since 1.9.0
    420419 *
    421420 * @param int $user_id
  • trunk/src/bp-friends/bp-friends-screens.php

    r10081 r10147  
    11<?php
    2 
    32/**
    43 * BuddyPress Friends Screen Functions.
     
    1211 */
    1312
    14 // Exit if accessed directly
     13// Exit if accessed directly.
    1514defined( 'ABSPATH' ) || exit;
    1615
     
    2322     * Fires before the loading of template for the My Friends page.
    2423     *
    25      * @since BuddyPress (1.0.0)
     24     * @since 1.0.0
    2625     */
    2726    do_action( 'friends_screen_my_friends' );
     
    3029     * Filters the template used to display the My Friends page.
    3130     *
    32      * @since BuddyPress (1.0.0)
     31     * @since 1.0.0
    3332     *
    3433     * @param string $template Path to the my friends template to load.
     
    7877     * Fires before the loading of template for the friends requests page.
    7978     *
    80      * @since BuddyPress (1.0.0)
     79     * @since 1.0.0
    8180     */
    8281    do_action( 'friends_screen_requests' );
     
    8584     * Filters the template used to display the My Friends page.
    8685     *
    87      * @since BuddyPress (1.0.0)
     86     * @since 1.0.0
    8887     *
    8988     * @param string $template Path to the friends request template to load.
     
    132131             * Fires after the last table row on the friends notification screen.
    133132             *
    134              * @since BuddyPress (1.0.0)
     133             * @since 1.0.0
    135134             */
    136135            do_action( 'friends_screen_notification_settings' ); ?>
  • 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.
  • trunk/src/bp-friends/bp-friends-widgets.php

    r10113 r10147  
    55 * @package BuddyPress
    66 * @subpackage Friends
    7  * @since BuddyPress (1.9.0)
    8  */
    9 
    10 // Exit if accessed directly
     7 * @since 1.9.0
     8 */
     9
     10// Exit if accessed directly.
    1111defined( 'ABSPATH' ) || exit;
    1212
     
    1414 * Register the friends widget.
    1515 *
    16  * @since BuddyPress (1.9.0)
     16 * @since 1.9.0
    1717 */
    1818function bp_friends_register_widgets() {
     
    3737 * The User Friends widget class.
    3838 *
    39  * @since BuddyPress (1.9.0)
     39 * @since 1.9.0
    4040 */
    4141class BP_Core_Friends_Widget extends WP_Widget {
     
    8080         * Filters the Friends widget title.
    8181         *
    82          * @since BuddyPress (1.8.0)
    83          * @since BuddyPress (2.3.0) Added 'instance' and 'id_base' to arguments passed to filter.
     82         * @since 1.8.0
     83         * @since 2.3.0 Added 'instance' and 'id_base' to arguments passed to filter.
    8484         *
    8585         * @param string $title    The widget title.
     
    212212 * Process AJAX pagination or filtering for the Friends widget.
    213213 *
    214  * @since BuddyPress (1.9.0)
     214 * @since 1.9.0
    215215 */
    216216function bp_core_ajax_widget_friends() {
  • trunk/src/bp-friends/classes/class-bp-friends-friendship.php

    r9995 r10147  
    77 */
    88
    9 // Exit if accessed directly
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
     
    152152         * Fires before processing and saving the current friendship request.
    153153         *
    154          * @since BuddyPress (1.0.0)
     154         * @since 1.0.0
    155155         *
    156156         * @param Object $value Current friendship request object.
     
    171171         * Fires after processing and saving the current friendship request.
    172172         *
    173          * @since BuddyPress (1.0.0)
     173         * @since 1.0.0
    174174         *
    175175         * @param Object $value Current friendship request object.
Note: See TracChangeset for help on using the changeset viewer.