Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
06/02/2015 05:21:07 AM (10 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-notifications.php

    r9819 r9906  
    22
    33/**
    4  * BuddyPress Groups Notification Functions
     4 * BuddyPress Groups Notification Functions.
    55 *
    66 * These functions handle the recording, deleting and formatting of notifications
    … …  
    2121 * @since BuddyPress (1.0.0)
    2222 *
    23  * @param int $group_id ID of the group.
    24  * @param BP_Groups_Group $old_group Group before new details were saved.
     23 * @param int                  $group_id ID of the group.
     24 * @param BP_Groups_Group|null $old_group Group before new details were saved.
    2525 */
    2626function groups_notification_group_updated( $group_id = 0, $old_group = null ) {
    … …  
    148148 *
    149149 * @param int $requesting_user_id ID of the user requesting group membership.
    150  * @param int $admin_id ID of the group admin.
    151  * @param int $group_id ID of the group.
    152  * @param int $membership_id ID of the group membership object.
    153  * @return bool|null False on failure.
     150 * @param int $admin_id           ID of the group admin.
     151 * @param int $group_id           ID of the group.
     152 * @param int $membership_id      ID of the group membership object.
     153 *
     154 * @return false|null False on failure.
    154155 */
    155156function groups_notification_new_membership_request( $requesting_user_id = 0, $admin_id = 0, $group_id = 0, $membership_id = 0 ) {
    … …  
    285286 * @since BuddyPress (1.0.0)
    286287 *
    287  * @param int $requesting_user_id ID of the user requesting group membership.
    288  * @param int $group_id ID of the group.
    289  * @param bool $accepted Optional. Whether the membership request was accepted.
    290  *        Default: true.
    291  * @return boolean
     288 * @param int  $requesting_user_id ID of the user requesting group membership.
     289 * @param int  $group_id           ID of the group.
     290 * @param bool $accepted           Optional. Whether the membership request was accepted.
     291 *                                 Default: true.
     292 *
     293 * @return false|null
    292294 */
    293295function groups_notification_membership_request_completed( $requesting_user_id = 0, $group_id = 0, $accepted = true ) {
    … …  
    401403 * @since BuddyPress (1.0.0)
    402404 *
    403  * @param int $user_id ID of the user.
     405 * @param int $user_id  ID of the user.
    404406 * @param int $group_id ID of the group.
    405  * @return bool|null False on failure.
     407 *
     408 * @return false|null False on failure.
    406409 */
    407410function groups_notification_promoted_member( $user_id = 0, $group_id = 0 ) {
    … …  
    506509 * @since BuddyPress (1.0.0)
    507510 *
    508  * @param BP_Groups_Group $group Group object.
    509  * @param BP_Groups_Member $member Member object.
    510  * @param int $inviter_user_id ID of the user who sent the invite.
    511  * @return bool|null False on failure.
     511 * @param BP_Groups_Group  $group           Group object.
     512 * @param BP_Groups_Member $member          Member object.
     513 * @param int              $inviter_user_id ID of the user who sent the invite.
     514 *
     515 * @return null|false False on failure.
    512516 */
    513517function groups_notification_group_invites( &$group, &$member, $inviter_user_id ) {
    … …  
    624628 * @since BuddyPress (1.0.0)
    625629 *
    626  * @param string $action The kind of notification being rendered.
    627  * @param int $item_id The primary item ID.
    628  * @param int $secondary_item_id The secondary item ID.
    629  * @param int $total_items The total number of messaging-related notifications
    630  *        waiting for the user.
    631  * @param string $format 'string' for BuddyBar-compatible notifications; 'array'
    632  *        for WP Toolbar. Default: 'string'.
     630 * @param string $action            The kind of notification being rendered.
     631 * @param int    $item_id           The primary item ID.
     632 * @param int    $secondary_item_id The secondary item ID.
     633 * @param int    $total_items       The total number of messaging-related notifications
     634 *                                  waiting for the user.
     635 * @param string $format            'string' for BuddyBar-compatible notifications; 'array'
     636 *                                  for WP Toolbar. Default: 'string'.
     637 *
    633638 * @return string
    634639 */
    … …  
    11991204 * @since BuddyPress (2.0.0)
    12001205 *
    1201  * @param int $user_id ID of the user.
     1206 * @param int $user_id  ID of the user.
    12021207 * @param int $group_id ID of the group.
    12031208 */
    … …  
    12151220 * @since BuddyPress (1.9.0)
    12161221 *
    1217  * @param int $user_id ID of the user.
     1222 * @param int $user_id  ID of the user.
    12181223 * @param int $group_id ID of the group.
    12191224 */
Note: See TracChangeset for help on using the changeset viewer.