Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
05/12/2015 04:39:07 AM (5 years ago)
Author:
tw2113
Message:

First pass at messages component docs cleanup.

See #6403.

File:
1 edited

Legend:

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

    r9819 r9862  
    2020 * @param array|BP_Messages_Message $raw_args {
    2121 *     Array of arguments. Also accepts a BP_Messages_Message object.
    22  *     @type array $recipients User IDs of recipients.
     22 *     @type array  $recipients    User IDs of recipients.
    2323 *     @type string $email_subject Subject line of message.
    2424 *     @type string $email_content Content of message.
    25  *     @type int $sender_id User ID of sender.
     25 *     @type int    $sender_id    User ID of sender.
    2626 * }
    2727 */
     
    154154 * @since BuddyPress (1.0.0)
    155155 *
    156  * @param string $action The kind of notification being rendered.
    157  * @param int $item_id The primary item id.
    158  * @param int $secondary_item_id The secondary item id.
    159  * @param int $total_items The total number of messaging-related notifications
    160  *        waiting for the user
    161  * @param string $format Return value format. 'string' for BuddyBar-compatible
    162  *        notifications; 'array' for WP Toolbar. Default: 'string'.
     156 * @param string $action            The kind of notification being rendered.
     157 * @param int    $item_id           The primary item id.
     158 * @param int    $secondary_item_id The secondary item id.
     159 * @param int    $total_items       The total number of messaging-related notifications
     160 *                                  waiting for the user.
     161 * @param string $format            Return value format. 'string' for BuddyBar-compatible
     162 *                                  notifications; 'array' for WP Toolbar. Default: 'string'.
     163 *
    163164 * @return string|array Formatted notifications.
    164165 */
     
    202203         *
    203204         * This is a dynamic filter. Possible filter names are:
    204          *   - 'bp_messages_multiple_new_message_notification'
    205          *   - 'bp_messages_single_new_message_notification'
     205         *   - 'bp_messages_multiple_new_message_notification'.
     206         *   - 'bp_messages_single_new_message_notification'.
    206207         *
    207208         * @param string $retval            Notification text.
     
    298299 * @since BuddyPress (2.0.0)
    299300 *
    300  * @param int   $message_id  ID of the thread.
     301 * @param int   $thread_id   ID of the thread.
    301302 * @param array $message_ids IDs of the messages.
    302303 */
Note: See TracChangeset for help on using the changeset viewer.