Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
07/04/2015 10:17:42 PM (9 years ago)
Author:
tw2113
Message:

Docs cleanup for Notifications component.

See #6404.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/bp-notifications/bp-notifications-functions.php

    r9992 r9993  
    2020 * @param array $args {
    2121 *     Array of arguments describing the notification. All are optional.
    22  *     @type int $user_id ID of the user to associate the notification with.
    23  *     @type int $item_id ID of the item to associate the notification with.
    24  *     @type int $secondary_item_id ID of the secondary item to associate the
    25  *           notification with.
    26  *     @type string $component_name Name of the component to associate the
    27  *           notification with.
    28  *     @type string $component_action Name of the action to associate the
    29  *           notification with.
    30  *     @type string $date_notified Timestamp for the notification.
     22 *     @type int    $user_id          ID of the user to associate the notification with.
     23 *     @type int    $item_id          ID of the item to associate the notification with.
     24 *     @type int    $secondary_item_id ID of the secondary item to associate the
     25 *                                     notification with.
     26 *     @type string $component_name    Name of the component to associate the
     27 *                                     notification with.
     28 *     @type string $component_action  Name of the action to associate the
     29 *                                     notification with.
     30 *     @type string $date_notified     Timestamp for the notification.
    3131 * }
    3232 * @return int|bool ID of the newly created notification on success, false
    … …  
    8484 *
    8585 * @param int $id ID of the notification.
     86 *
    8687 * @return BP_Notifications_Notification
    8788 */
    … …  
    9697 *
    9798 * @param int $id ID of the notification to delete.
     99 *
    98100 * @return bool True on success, false on failure.
    99101 */
    … …  
    113115 * @since BuddyPress (1.9.0)
    114116 *
    115  * @param int $id ID of the user whose notifications are being deleted.
    116  * @param int $is_new 0 for read, 1 for unread.
     117 * @param int      $id     ID of the user whose notifications are being deleted.
     118 * @param int|bool $is_new 0 for read, 1 for unread.
     119 *
    117120 * @return bool True on success, false on failure.
    118121 */
    … …  
    134137 *
    135138 * @param int $user_id ID of the user whose notifications are being fetched.
     139 *
    136140 * @return array
    137141 */
    … …  
    168172 * @since BuddyPress (1.9.0)
    169173 *
    170  * @param int $user_id ID of the user whose notifications are being fetched.
    171  * @param string $format Format of the returned values. 'string' returns HTML,
    172  *        while 'object' returns a structured object for parsing.
     174 * @param int    $user_id ID of the user whose notifications are being fetched.
     175 * @param string $format  Format of the returned values. 'string' returns HTML,
     176 *                        while 'object' returns a structured object for parsing.
     177 *
    173178 * @return mixed Object or array on success, false on failure.
    174179 */
    … …  
    313318     * @since BuddyPress (1.6.0)
    314319     *
    315      * @param Array|Bool $renderable Array of notifications to render or false if no notifications.
     320     * @param array|bool $renderable Array of notifications to render or false if no notifications.
    316321     * @param int        $user_id    ID of the user whose notifications are being displayed.
    317322     * @param string     $format     Display format requested for the notifications.
    … …  
    330335 * @since BuddyPress (1.9.0)
    331336 *
    332  * @param int $user_id ID of the user whose notifications are being deleted.
    333  * @param string $component_name Name of the associated component.
     337 * @param int    $user_id          ID of the user whose notifications are being deleted.
     338 * @param string $component_name   Name of the associated component.
    334339 * @param string $component_action Name of the associated action.
     340 *
    335341 * @return bool True on success, false on failure.
    336342 */
    … …  
    351357 * @since BuddyPress (1.9.0)
    352358 *
    353  * @param int $user_id ID of the user whose notifications are being deleted.
    354  * @param int $item_id ID of the associated item.
    355  * @param string $component_name Name of the associated component.
    356  * @param string $component_action Name of the associated action.
    357  * @param int $secondary_item_id ID of the secondary associated item.
     359 * @param int      $user_id           ID of the user whose notifications are being deleted.
     360 * @param int      $item_id           ID of the associated item.
     361 * @param string   $component_name    Name of the associated component.
     362 * @param string   $component_action  Name of the associated action.
     363 * @param int|bool $secondary_item_id ID of the secondary associated item.
     364 *
    358365 * @return bool True on success, false on failure.
    359366 */
    … …  
    375382 * @since BuddyPress (1.9.0)
    376383 *
    377  * @param int $item_id ID of the user whose notifications are being deleted.
    378  * @param string $component_name Name of the associated component.
    379  * @param string $component_action Optional. Name of the associated action.
    380  * @param int $secondary_item_id Optional. ID of the secondary associated item.
     384 * @param int         $item_id           ID of the user whose notifications are being deleted.
     385 * @param string      $component_name    Name of the associated component.
     386 * @param string|bool $component_action  Optional. Name of the associated action.
     387 * @param int|bool    $secondary_item_id Optional. ID of the secondary associated item.
     388 *
    381389 * @return bool True on success, false on failure.
    382390 */
    … …  
    401409 * @since BuddyPress (1.9.0)
    402410 *
    403  * @param int $user_id ID of the user whose associated items are being deleted.
    404  * @param string $component_name Name of the associated component.
     411 * @param int    $user_id          ID of the user whose associated items are being deleted.
     412 * @param string $component_name   Name of the associated component.
    405413 * @param string $component_action Name of the associated action.
     414 *
    406415 * @return bool True on success, false on failure.
    407416 */
    … …  
    424433 * @since BuddyPress (1.9.0)
    425434 *
    426  * @param int $user_id ID of the user whose notifications are being deleted.
    427  * @param string $component_name Name of the associated component.
    428  * @param string $component_action Name of the associated action.
    429  * @param int $is_new 0 for read, 1 for unread.
     435 * @param int      $user_id          ID of the user whose notifications are being deleted.
     436 * @param string   $component_name   Name of the associated component.
     437 * @param string   $component_action Name of the associated action.
     438 * @param int|bool $is_new           0 for read, 1 for unread.
     439 *
    430440 * @return bool True on success, false on failure.
    431441 */
    … …  
    451461 * @since BuddyPress (1.9.0)
    452462 *
    453  * @param int $user_id ID of the user whose notifications are being deleted.
    454  * @param int $item_id ID of the associated item.
    455  * @param string $component_name Name of the associated component.
    456  * @param string $component_action Name of the associated action.
    457  * @param int $secondary_item_id ID of the secondary associated item.
    458  * @param int $is_new 0 for read, 1 for unread.
     463 * @param int      $user_id           ID of the user whose notifications are being deleted.
     464 * @param int      $item_id           ID of the associated item.
     465 * @param string   $component_name    Name of the associated component.
     466 * @param string   $component_action  Name of the associated action.
     467 * @param int|bool $secondary_item_id ID of the secondary associated item.
     468 * @param int|bool $is_new            0 for read, 1 for unread.
     469 *
    459470 * @return bool True on success, false on failure.
    460471 */
    … …  
    481492 * @since BuddyPress (1.9.0)
    482493 *
    483  * @param int $user_id ID of the user whose notifications are being deleted.
    484  * @param int $is_new 0 for read, 1 for unread
    485  * @param string $component_name Name of the associated component.
    486  * @param string $component_action Optional. Name of the associated action.
    487  * @param int $secondary_item_id Optional. ID of the secondary associated item.
    488  * @param int $is_new 0 for read, 1 for unread.
     494 * @param int         $item_id          ID of the user whose notifications are being deleted.
     495 * @param string      $component_name    Name of the associated component.
     496 * @param string|bool $component_action  Optional. Name of the associated action.
     497 * @param int|bool    $secondary_item_id Optional. ID of the secondary associated item.
     498 * @param int|bool    $is_new            0 for read, 1 for unread.
     499 *
    489500 * @return bool True on success, false on failure.
    490501 */
    … …  
    514525 * @since BuddyPress (1.9.0)
    515526 *
    516  * @param int $user_id ID of the user whose associated items are being deleted.
    517  * @param int $is_new 0 for read, 1 for unread
    518  * @param string $component_name Name of the associated component.
    519  * @param string $component_action Name of the associated action.
    520  * @param int $is_new 0 for read, 1 for unread.
     527 * @param int      $user_id          ID of the user whose associated items are being deleted.
     528 * @param string   $component_name   Name of the associated component.
     529 * @param string   $component_action Name of the associated action.
     530 * @param int|bool $is_new           0 for read, 1 for unread.
     531 *
    521532 * @return bool True on success, false on failure.
    522533 */
    … …  
    543554 * @since BuddyPress (1.9.0)
    544555 *
    545  * @param int $user_id ID of the user being checked.
     556 * @param int $user_id         ID of the user being checked.
    546557 * @param int $notification_id ID of the notification being checked.
     558 *
    547559 * @return bool True if the notification belongs to the user, otherwise false.
    548560 */
    … …  
    557569 *
    558570 * @param int $user_id ID of the user whose unread notifications are being
    559  *        counted.
     571 *                     counted.
     572 *
    560573 * @return int Unread notification count.
    561574 */
Note: See TracChangeset for help on using the changeset viewer.