Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
06/02/2015 05:21:07 AM (9 years ago)
Author:
tw2113
Message:

Initial documentation cleanup for the BP Groups component.

See #6401.

File:
1 edited

Legend:

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

    r9819 r9906  
    22
    33/**
    4  * BuddyPress Groups Activity Functions
     4 * BuddyPress Groups Activity Functions.
    55 *
    66 * These functions handle the recording, deleting and formatting of activity
     
    9090 * @since BuddyPress (2.0.0)
    9191 *
    92  * @param string $action Static activity action.
     92 * @param string $action   Static activity action.
    9393 * @param object $activity Activity data object.
     94 *
    9495 * @return string
    9596 */
     
    121122 * @since BuddyPress (2.0.0)
    122123 *
    123  * @param string $action Static activity action.
     124 * @param string $action   Static activity action.
    124125 * @param object $activity Activity data object.
     126 *
    125127 * @return string
    126128 */
     
    165167 * @param  string $action   Static activity action.
    166168 * @param  object $activity Activity data object.
     169 *
    167170 * @return string
    168171 */
     
    219222 *
    220223 * @param array $activities Array of activity items.
     224 *
    221225 * @return array
    222226 */
     
    270274 * @param array $retval Empty array by default
    271275 * @param array $filter Current activity arguments
     276 *
    272277 * @return array
    273278 */
     
    334339 *      return values.
    335340 *
    336  * @param array $args {
     341 * @param array|string $args {
    337342 *     An array of arguments for the new activity item. Accepts all parameters
    338343 *     of {@link bp_activity_add()}. However, this wrapper provides some
    339344 *     additional defaults, as described below:
    340  *     @type string $component Default: the id of your Groups component
    341  *           (usually 'groups').
    342  *     @type bool $hide_sitewide Default: True if the current group is not
    343  *           public, otherwise false.
     345 *     @type string $component     Default: the id of your Groups component
     346 *                                 (usually 'groups').
     347 *     @type bool   $hide_sitewide Default: True if the current group is not
     348 *                                 public, otherwise false.
    344349 * }
    345350 * @return bool See {@link bp_activity_add()}.
     
    386391 *
    387392 * @param int $group_id Optional. The ID of the group whose last_activity is
    388  *        being updated. Default: the current group's ID.
     393 *                      being updated. Default: the current group's ID.
     394 *
    389395 * @return bool|null False on failure.
    390396 */
     
    408414
    409415/**
    410  * Add an activity stream item when a member joins a group
     416 * Add an activity stream item when a member joins a group.
    411417 *
    412418 * @since BuddyPress (1.9.0)
    413419 *
    414  * @param int $user_id ID of the user joining the group.
     420 * @param int $user_id  ID of the user joining the group.
    415421 * @param int $group_id ID of the group.
     422 *
    416423 * @return bool|null False on failure.
    417424 */
     
    455462 * @param  BP_Groups_Group $old_group      Group object before the details had been changed.
    456463 * @param  bool            $notify_members True if the admin has opted to notify group members, otherwise false.
     464 *
    457465 * @return int|bool The ID of the activity on success. False on error.
    458466 */
     
    546554 *
    547555 * @param int $group_id ID of the group.
    548  * @param int $user_id ID of the user leaving the group.
     556 * @param int $user_id  ID of the user leaving the group.
    549557 */
    550558function bp_groups_leave_group_delete_recent_activity( $group_id, $user_id ) {
Note: See TracChangeset for help on using the changeset viewer.