Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
07/04/2015 10:23:19 PM (5 years ago)
Author:
tw2113
Message:

Docs cleanup for Friends component.

See #6400.

File:
1 edited

Legend:

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

    r9819 r9995  
    22
    33/**
    4  * BuddyPress Friends Activity Functions
     4 * BuddyPress Friends Activity Functions.
    55 *
    66 * These functions handle the recording, deleting and formatting of activity
     
    2323 *      return values.
    2424 *
    25  * @param array $args {
     25 * @param array|string $args {
    2626 *     An array of arguments for the new activity item. Accepts all parameters
    2727 *     of {@link bp_activity_add()}. The one difference is the following
    2828 *     argument, which has a different default here:
    2929 *     @type string $component Default: the id of your Friends component
    30  *           (usually 'friends').
     30 *                             (usually 'friends').
    3131 * }
    3232 * @return bool See {@link bp_activity_add()}.
     
    5959 * @param array $args {
    6060 *     An array of arguments for the item to delete.
    61  *     @type int $item_id ID of the 'item' associated with the activity item.
    62  *           For Friends activity items, this is usually the user ID of one
    63  *           of the friends.
    64  *     @type string $type The 'type' of the activity item (eg
    65  *           'friendship_accepted').
    66  *     @type int $user_id ID of the user associated with the activity item.
     61 *     @type int    $item_id ID of the 'item' associated with the activity item.
     62 *                           For Friends activity items, this is usually the user ID of one
     63 *                           of the friends.
     64 *     @type string $type    The 'type' of the activity item (eg
     65 *                           'friendship_accepted').
     66 *     @type int    $user_id ID of the user associated with the activity item.
    6767 * }
    6868 * @return bool True on success, false on failure.
     
    128128 * @since BuddyPress (2.0.0)
    129129 *
     130 * @param string $action   Activity action string.
    130131 * @param object $activity Activity data.
     132 *
    131133 * @return string $action Formatted activity action.
    132134 */
     
    150152     * @since BuddyPress (2.0.0)
    151153     *
    152      * @param string $action String text for the 'friendship_accepted' action.
     154     * @param string $action   String text for the 'friendship_accepted' action.
    153155     * @param object $activity Activity data.
    154156     */
     
    161163 * @since BuddyPress (2.0.0)
    162164 *
    163  * @param string $action Static activity action.
     165 * @param string $action   Static activity action.
    164166 * @param object $activity Activity data.
     167 *
    165168 * @return string $action Formatted activity action.
    166169 */
     
    184187     * @since BuddyPress (2.0.0)
    185188     *
    186      * @param string $action String text for the 'friendship_created' action.
     189     * @param string $action   String text for the 'friendship_created' action.
    187190     * @param object $activity Activity data.
    188191     */
     
    198201 *
    199202 * @param array $activities Array of activity items.
     203 *
    200204 * @return array
    201205 */
     
    237241 * @param array $retval Empty array by default
    238242 * @param array $filter Current activity arguments
     243 *
    239244 * @return array
    240245 */
     
    290295 * @param array $retval Empty array by default
    291296 * @param array $filter Current activity arguments
     297 *
    292298 * @return array
    293299 */
     
    364370 * @since BuddyPress (1.9.0)
    365371 *
    366  * @param int $friendship_id
    367  * @param int $initiator_user_id
    368  * @param int $friend_user_id
    369  * @param object $friendship Optional
     372 * @param int         $friendship_id
     373 * @param int         $initiator_user_id
     374 * @param int         $friend_user_id
     375 * @param object|bool $friendship Optional
    370376 */
    371377function bp_friends_friendship_accepted_activity( $friendship_id, $initiator_user_id, $friend_user_id, $friendship = false ) {
Note: See TracChangeset for help on using the changeset viewer.