Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
09/24/2015 11:55:02 PM (9 years ago)
Author:
tw2113
Message:

Standardizing our @since tags for the Notifications component.

See #6576

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-notifications/bp-notifications-functions.php

    r10055 r10138  
    11<?php
    2 
    32/**
    43 * BuddyPress Member Notifications Functions.
     
    109 */
    1110
    12 // Exit if accessed directly
     11// Exit if accessed directly.
    1312defined( 'ABSPATH' ) || exit;
    1413
     
    1615 * Add a notification for a specific user, from a specific component.
    1716 *
    18  * @since BuddyPress (1.9.0)
     17 * @since 1.9.0
    1918 *
    2019 * @param array $args {
     
    8180 * Get a specific notification by its ID.
    8281 *
    83  * @since BuddyPress (1.9.0)
     82 * @since 1.9.0
    8483 *
    8584 * @param int $id ID of the notification.
     
    9493 * Delete a specific notification by its ID.
    9594 *
    96  * @since BuddyPress (1.9.0)
     95 * @since 1.9.0
    9796 *
    9897 * @param int $id ID of the notification to delete.
     
    113112 * Used when clearing out notifications for a specific notification item.
    114113 *
    115  * @since BuddyPress (1.9.0)
     114 * @since 1.9.0
    116115 *
    117116 * @param int      $id     ID of the notification.
     
    134133 * Get all notifications for a user and cache them.
    135134 *
    136  * @since BuddyPress (2.1.0)
     135 * @since 2.1.0
    137136 *
    138137 * @param int $user_id ID of the user whose notifications are being fetched.
     
    159158     * Filters all notifications for a user.
    160159     *
    161      * @since BuddyPress (2.1.0)
     160     * @since 2.1.0
    162161     *
    163162     * @param array $notifications Array of notifications for user.
     
    170169 * Get notifications for a specific user.
    171170 *
    172  * @since BuddyPress (1.9.0)
     171 * @since 1.9.0
    173172 *
    174173 * @param int    $user_id ID of the user whose notifications are being fetched.
     
    277276                     * Filters the notifications for a user.
    278277                     *
    279                      * @since BuddyPress (1.9.0)
     278                     * @since 1.9.0
    280279                     *
    281280                     * @param array $ref_array Array of properties for the current notification being rendered.
     
    316315     * Filters the final array of notifications to be displayed for a user.
    317316     *
    318      * @since BuddyPress (1.6.0)
     317     * @since 1.6.0
    319318     *
    320319     * @param array|bool $renderable Array of notifications to render or false if no notifications.
     
    333332 * has visited that component.
    334333 *
    335  * @since BuddyPress (1.9.0)
     334 * @since 1.9.0
    336335 *
    337336 * @param int    $user_id          ID of the user whose notifications are being deleted.
     
    355354 * has visited that component.
    356355 *
    357  * @since BuddyPress (1.9.0)
     356 * @since 1.9.0
    358357 *
    359358 * @param int      $user_id           ID of the user whose notifications are being deleted.
     
    380379 * Used when clearing out notifications for an entire component.
    381380 *
    382  * @since BuddyPress (1.9.0)
     381 * @since 1.9.0
    383382 *
    384383 * @param int         $item_id           ID of the user whose notifications are being deleted.
     
    407406 *       certain components (such as Friends). Use with caution!
    408407 *
    409  * @since BuddyPress (1.9.0)
     408 * @since 1.9.0
    410409 *
    411410 * @param int    $user_id          ID of the user whose associated items are being deleted.
     
    431430 * has visited that component.
    432431 *
    433  * @since BuddyPress (1.9.0)
     432 * @since 1.9.0
    434433 *
    435434 * @param int      $user_id          ID of the user whose notifications are being deleted.
     
    459458 * has visited that component.
    460459 *
    461  * @since BuddyPress (1.9.0)
     460 * @since 1.9.0
    462461 *
    463462 * @param int      $user_id           ID of the user whose notifications are being deleted.
     
    490489 * Used when clearing out notifications for an entire component.
    491490 *
    492  * @since BuddyPress (1.9.0)
     491 * @since 1.9.0
    493492 *
    494493 * @param int         $item_id           ID of the user whose notifications are being deleted.
     
    523522 *       certain components (such as Friends). Use with caution!
    524523 *
    525  * @since BuddyPress (1.9.0)
     524 * @since 1.9.0
    526525 *
    527526 * @param int      $user_id          ID of the user whose associated items are being deleted.
     
    552551 * Used before deleting a notification for a user.
    553552 *
    554  * @since BuddyPress (1.9.0)
     553 * @since 1.9.0
    555554 *
    556555 * @param int $user_id         ID of the user being checked.
     
    566565 * Get a count of unread notification items for a user.
    567566 *
    568  * @since BuddyPress (1.9.0)
     567 * @since 1.9.0
    569568 *
    570569 * @param int $user_id ID of the user whose unread notifications are being
     
    580579     * Filters the count of unread notification items for a user.
    581580     *
    582      * @since BuddyPress (1.9.0)
     581     * @since 1.9.0
    583582     *
    584583     * @param int $count Count of unread notification items for a user.
     
    591590 * registered Notifications callbacks.
    592591 *
    593  * @since BuddyPress (1.9.1)
     592 * @since 1.9.1
    594593 *
    595594 * @see http://buddypress.trac.wordpress.org/ticket/5300
     
    618617     * Filters active components with registered notifications callbacks.
    619618     *
    620      * @since BuddyPress (1.9.1)
     619     * @since 1.9.1
    621620     *
    622621     * @param array $component_names   Array of registered component names.
     
    631630 * Delete a meta entry from the DB for a notification item.
    632631 *
    633  * @since BuddyPress (2.3.0)
     632 * @since 2.3.0
    634633 *
    635634 * @global object $wpdb WordPress database access object.
     
    677676 * Get metadata for a given notification item.
    678677 *
    679  * @since BuddyPress (2.3.0)
     678 * @since 2.3.0
    680679 *
    681680 * @uses apply_filters() To call the 'bp_notifications_get_meta' hook.
     
    699698     * Filters the metadata for a specified notification item.
    700699     *
    701      * @since BuddyPress (2.3.0)
     700     * @since 2.3.0
    702701     *
    703702     * @param mixed  $retval          The meta values for the notification item.
     
    712711 * Update a piece of notification meta.
    713712 *
    714  * @since BuddyPress (1.2.0)
     713 * @since 1.2.0
    715714 *
    716715 * @param  int    $notification_id ID of the notification item whose metadata is being
     
    738737 * Add a piece of notification metadata.
    739738 *
    740  * @since BuddyPress (2.3.0)
     739 * @since 2.3.0
    741740 *
    742741 * @param int    $notification_id ID of the notification item.
Note: See TracChangeset for help on using the changeset viewer.