Skip to:
Content

BuddyPress.org

Changeset 10139


Ignore:
Timestamp:
09/25/2015 12:02:25 AM (11 years ago)
Author:
tw2113
Message:

Standardizing our @since tags for the Messages component.

See #6576.

Location:
trunk/src/bp-messages
Files:
15 edited

Legend:

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

    r9966 r10139  
    11<?php
    2 
    32/**
    43 * BuddyPress Messages Actions.
    … …  
    1211 */
    1312
    14 // Exit if accessed directly
     13// Exit if accessed directly.
    1514defined( 'ABSPATH' ) || exit;
    1615
    … …  
    1817 * Handle creating of private messages or sitewide notices
    1918 *
    20  * @since BuddyPress (2.4.0) This function was split from messages_screen_compose(). See #6505.
     19 * @since 2.4.0 This function was split from messages_screen_compose(). See #6505.
    2120 *
    2221 * @return boolean
    … …  
    7978                         * Filters the array of recipients to receive the composed message.
    8079                         *
    81                          * @since BuddyPress (1.2.10)
     80                         * @since 1.2.10
    8281                         *
    8382                         * @param array $recipients Array of recipients to receive message.
    … …  
    129128 * Handle editing of sitewide notices
    130129 *
    131  * @since BuddyPress (2.4.0) This function was split from messages_screen_notices(). See #6505.
     130 * @since 2.4.0 This function was split from messages_screen_notices(). See #6505.
    132131 *
    133132 * @global int $notice_id
    … …  
    253252         * Fires after processing a view request for a single message thread.
    254253         *
    255          * @since BuddyPress (1.7.0)
     254         * @since 1.7.0
    256255         */
    257256        do_action( 'messages_action_conversation' );
    … …  
    293292 * Handle marking a single message thread as read.
    294293 *
    295  * @since BuddyPress (2.2.0)
     294 * @since 2.2.0
    296295 *
    297296 * @return bool|null Returns false on failure. Otherwise redirects back to the
    … …  
    334333 * Handle marking a single message thread as unread.
    335334 *
    336  * @since BuddyPress (2.2.0)
     335 * @since 2.2.0
    337336 *
    338337 * @return bool|null Returns false on failure. Otherwise redirects back to the
    … …  
    375374 * Handle bulk management (mark as read/unread, delete) of message threads.
    376375 *
    377  * @since BuddyPress (2.2.0)
     376 * @since 2.2.0
    378377 *
    379378 * @return bool Returns false on failure. Otherwise redirects back to the
  • trunk/src/bp-messages/bp-messages-cache.php

    r9862 r10139  
    11<?php
    2 
    32/**
    43 * BuddyPress Messages Caching.
    … …  
    87 *
    98 * @package BuddyPress
     9 * @subpackage MessagesCache
    1010 */
    1111
    12 // Exit if accessed directly
     12// Exit if accessed directly.
    1313defined( 'ABSPATH' ) || exit;
    1414
    … …  
    2020 * message meta within a loop context.
    2121 *
    22  * @since BuddyPress (2.2.0)
     22 * @since 2.2.0
    2323 *
    2424 * @param int|string|array|bool $message_ids Accepts a single message_id, or a
    … …  
    4949 * Clear message cache after a message is saved.
    5050 *
    51  * @since BuddyPress (2.0.0)
     51 * @since 2.0.0
    5252 *
    5353 * @param BP_Messages_Message $message
    … …  
    7070 * Clear message cache after a message thread is deleted.
    7171 *
    72  * @since BuddyPress (2.0.0)
     72 * @since 2.0.0
    7373 *
    7474 * @param int|array $thread_ids If single thread, the thread ID.
    … …  
    9292 * Currently, invalidates active notice cache.
    9393 *
    94  * @since BuddyPress (2.0.0)
     94 * @since 2.0.0
    9595 *
    9696 * @param BP_Messages_Notice $notice
  • trunk/src/bp-messages/bp-messages-classes.php

    r9928 r10139  
    11<?php
    22/**
    3  * BuddyPress Messages Classes
     3 * BuddyPress Messages Classes.
    44 *
    55 * @package BuddyPress
    … …  
    77 */
    88
    9 // Exit if accessed directly
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
  • trunk/src/bp-messages/bp-messages-cssjs.php

    r9819 r10139  
    11<?php
    2 
    32/**
    4  * BuddyPress Messages CSS and JS
     3 * BuddyPress Messages CSS and JS.
    54 *
    65 * @package BuddyPress
    … …  
    87 */
    98
    10 // Exit if accessed directly
     9// Exit if accessed directly.
    1110defined( 'ABSPATH' ) || exit;
    1211
  • trunk/src/bp-messages/bp-messages-filters.php

    r10060 r10139  
    11<?php
    2 
    32/**
    43 * BuddyPress Messages Filters.
    … …  
    109 */
    1110
    12 // Exit if accessed directly
     11// Exit if accessed directly.
    1312defined( 'ABSPATH' ) || exit;
    1413
    … …  
    7170 * Enforce limitations on viewing private message contents
    7271 *
    73  * @since BuddyPress (2.3.2)
     72 * @since 2.3.2
    7473 *
    7574 * @see bp_has_message_threads() for description of parameters
  • trunk/src/bp-messages/bp-messages-functions.php

    r9862 r10139  
    11<?php
    2 
    32/**
    43 * BuddyPress Messages Functions.
    … …  
    1312 */
    1413
    15 // Exit if accessed directly
     14// Exit if accessed directly.
    1615defined( 'ABSPATH' ) || exit;
    1716
    … …  
    158157         * Fires after a message has been successfully sent.
    159158         *
    160          * @since BuddyPress (1.1.0)
     159         * @since 1.1.0
    161160         *
    162161         * @param BP_Messages_Message $message Message object. Passed by reference.
    … …  
    192191                 * Fires after a notice has been successfully sent.
    193192                 *
    194                  * @since BuddyPress (1.0.0)
     193                 * @since 1.0.0
    195194                 *
    196195                 * @param string $subject Subject of the notice.
    … …  
    215214         * Fires before specified thread IDs have been deleted.
    216215         *
    217          * @since BuddyPress (1.5.0)
     216         * @since 1.5.0
    218217         *
    219218         * @param int|array Thread ID or array of thread IDs that were deleted.
    … …  
    236235                 * Fires after specified thread IDs have been deleted.
    237236                 *
    238                  * @since BuddyPress (1.0.0)
     237                 * @since 1.0.0
    239238                 *
    240239                 * @param int|array Thread ID or array of thread IDs that were deleted.
    … …  
    374373 * Get the thread ID from a message ID.
    375374 *
    376  * @since BuddyPress (2.3.0)
     375 * @since 2.3.0
    377376 *
    378377 * @param  int $message_id ID of the message.
    … …  
    394393 * If $meta_key is false, this will delete all meta for the message ID.
    395394 *
    396  * @since BuddyPress (2.2.0)
     395 * @since 2.2.0
    397396 *
    398397 * @see delete_metadata() for full documentation excluding $meta_type variable.
    … …  
    437436 * Get a piece of message metadata.
    438437 *
    439  * @since BuddyPress (2.2.0)
     438 * @since 2.2.0
    440439 *
    441440 * @see get_metadata() for full documentation excluding $meta_type variable.
    … …  
    458457 * Update a piece of message metadata.
    459458 *
    460  * @since BuddyPress (2.2.0)
     459 * @since 2.2.0
    461460 *
    462461 * @see update_metadata() for full documentation excluding $meta_type variable.
    … …  
    481480 * Add a piece of message metadata.
    482481 *
    483  * @since BuddyPress (2.2.0)
     482 * @since 2.2.0
    484483 *
    485484 * @see add_metadata() for full documentation excluding $meta_type variable.
  • trunk/src/bp-messages/bp-messages-loader.php

    r9936 r10139  
    11<?php
    2 
    32/**
    4  * BuddyPress Messages Loader
     3 * BuddyPress Messages Loader.
    54 *
    65 * A private messages component, for users to send messages to each other.
    … …  
    109 */
    1110
    12 // Exit if accessed directly
     11// Exit if accessed directly.
    1312defined( 'ABSPATH' ) || exit;
    1413
    … …  
    1615 * Implementation of BP_Component for the Messages component.
    1716 *
    18  * @since BuddyPress (1.5.0)
     17 * @since 1.5.0
    1918 */
    2019class BP_Messages_Component extends BP_Component {
    … …  
    2423         * this is set to false, in which any matching users will be returned.
    2524         *
    26          * @since BuddyPress (1.5.0)
     25         * @since 1.5.0
    2726         * @var bool
    2827         */
    … …  
    3231         * Start the messages component creation process.
    3332         *
    34          * @since BuddyPress (1.5.0)
     33         * @since 1.5.0
    3534         */
    3635        public function __construct() {
    … …  
    4948         * Include files.
    5049         *
    51          * @since BuddyPress (1.5.0)
     50         * @since 1.5.0
    5251         *
    5352         * @param array $includes See {BP_Component::includes()} for details.
    … …  
    8382         * backwards compatibility.
    8483         *
    85          * @since BuddyPress (1.5.0)
     84         * @since 1.5.0
    8685         *
    8786         * @param array $args Not used.
    … …  
    327326         * Setup cache groups
    328327         *
    329          * @since BuddyPress (2.2.0)
     328         * @since 2.2.0
    330329         */
    331330        public function setup_cache_groups() {
  • trunk/src/bp-messages/bp-messages-notifications.php

    r9862 r10139  
    11<?php
    2 
    3 /**
    4  * BuddyPress Messages Notifications
     2/**
     3 * BuddyPress Messages Notifications.
    54 *
    65 * @package BuddyPress
    … …  
    87 */
    98
    10 // Exit if accessed directly
     9// Exit if accessed directly.
    1110defined( 'ABSPATH' ) || exit;
    1211
    … …  
    1615 * Email message recipients to alert them of a new unread private message.
    1716 *
    18  * @since BuddyPress (1.0.0)
     17 * @since 1.0.0
    1918 *
    2019 * @param array|BP_Messages_Message $raw_args {
    … …  
    9695                         * Filters the user email that the message notification will be sent to.
    9796                         *
    98                          * @since BuddyPress (1.2.0)
     97                         * @since 1.2.0
    9998                         *
    10099                         * @param string  $email_to User email the notification is being sent to.
    … …  
    106105                         * Filters the message notification subject that will be sent to user.
    107106                         *
    108                          * @since BuddyPress (1.2.0)
     107                         * @since 1.2.0
    109108                         *
    110109                         * @param string  $email_subject Email notification subject text.
    … …  
    117116                         * Filters the message notification message that will be sent to user.
    118117                         *
    119                          * @since BuddyPress (1.2.0)
     118                         * @since 1.2.0
    120119                         *
    121120                         * @param string  $email_content Email notification message text.
    … …  
    136135         * Fires after the sending of a new message email notification.
    137136         *
    138          * @since BuddyPress (1.5.0)
     137         * @since 1.5.0
    139138         *
    140139         * @param array  $recipients    User IDs of recipients.
    … …  
    152151 * Format notifications for the Messages component.
    153152 *
    154  * @since BuddyPress (1.0.0)
     153 * @since 1.0.0
    155154 *
    156155 * @param string $action            The kind of notification being rendered.
    … …  
    224223         * Fires right before returning the formatted message notifications.
    225224         *
    226          * @since BuddyPress (1.0.0)
     225         * @since 1.0.0
    227226         *
    228227         * @param string $action            The type of message notification.
    … …  
    239238 * Send notifications to message recipients.
    240239 *
    241  * @since BuddyPress (1.9.0)
     240 * @since 1.9.0
    242241 *
    243242 * @param BP_Messages_Message $message Message object.
    … …  
    263262 * Mark new message notification when member reads a message thread directly.
    264263 *
    265  * @since BuddyPress (1.9.0)
     264 * @since 1.9.0
    266265 */
    267266function bp_messages_screen_conversation_mark_notifications() {
    … …  
    297296 * When a message is deleted, delete corresponding notifications.
    298297 *
    299  * @since BuddyPress (2.0.0)
     298 * @since 2.0.0
    300299 *
    301300 * @param int   $thread_id   ID of the thread.
  • trunk/src/bp-messages/bp-messages-screens.php

    r10081 r10139  
    11<?php
    2 
    32/**
    43 * BuddyPress Messages Screens.
    … …  
    1211 */
    1312
    14 // Exit if accessed directly
     13// Exit if accessed directly.
    1514defined( 'ABSPATH' ) || exit;
    1615
    … …  
    1817 * Load the Messages > Inbox screen.
    1918 *
    20  * @since BuddyPress (1.0.0)
     19 * @since 1.0.0
    2120 */
    2221function messages_screen_inbox() {
    … …  
    3029         * Fires right before the loading of the Messages inbox screen template file.
    3130         *
    32          * @since BuddyPress (1.0.0)
     31         * @since 1.0.0
    3332         */
    3433        do_action( 'messages_screen_inbox' );
    … …  
    3736         * Filters the template to load for the Messages inbox screen.
    3837         *
    39          * @since BuddyPress (1.0.0)
     38         * @since 1.0.0
    4039         *
    4140         * @param string $template Path to the messages template to load.
    … …  
    4746 * Load the Messages > Sent screen.
    4847 *
    49  * @since BuddyPress (1.0.0)
     48 * @since 1.0.0
    5049 */
    5150function messages_screen_sentbox() {
    … …  
    5958         * Fires right before the loading of the Messages sentbox screen template file.
    6059         *
    61          * @since BuddyPress (1.0.0)
     60         * @since 1.0.0
    6261         */
    6362        do_action( 'messages_screen_sentbox' );
    … …  
    6665         * Filters the template to load for the Messages sentbox screen.
    6766         *
    68          * @since BuddyPress (1.0.0)
     67         * @since 1.0.0
    6968         *
    7069         * @param string $template Path to the messages template to load.
    … …  
    7675 * Load the Messages > Compose screen.
    7776 *
    78  * @since BuddyPress (1.0.0)
     77 * @since 1.0.0
    7978 */
    8079function messages_screen_compose() {
    … …  
    9190         * Fires right before the loading of the Messages compose screen template file.
    9291         *
    93          * @since BuddyPress (1.0.0)
     92         * @since 1.0.0
    9493         */
    9594        do_action( 'messages_screen_compose' );
    … …  
    9897         * Filters the template to load for the Messages compose screen.
    9998         *
    100          * @since BuddyPress (1.0.0)
     99         * @since 1.0.0
    101100         *
    102101         * @param string $template Path to the messages template to load.
    … …  
    108107 * Load an individual conversation screen.
    109108 *
    110  * @since BuddyPress (1.0.0)
     109 * @since 1.0.0
    111110 *
    112111 * @return bool|null False on failure.
    … …  
    134133         * Fires right before the loading of the Messages view screen template file.
    135134         *
    136          * @since BuddyPress (1.7.0)
     135         * @since 1.7.0
    137136         */
    138137        do_action( 'messages_screen_conversation' );
    … …  
    141140         * Filters the template to load for the Messages view screen.
    142141         *
    143          * @since BuddyPress (1.0.0)
     142         * @since 1.0.0
    144143         *
    145144         * @param string $template Path to the messages template to load.
    … …  
    152151 * Load the Messages > Notices screen.
    153152 *
    154  * @since BuddyPress (1.0.0)
     153 * @since 1.0.0
    155154 *
    156155 * @return false|null False on failure.
    … …  
    166165         * Fires right before the loading of the Messages notices screen template file.
    167166         *
    168          * @since BuddyPress (1.0.0)
     167         * @since 1.0.0
    169168         */
    170169        do_action( 'messages_screen_notices' );
    … …  
    173172         * Filters the template to load for the Messages notices screen.
    174173         *
    175          * @since BuddyPress (1.0.0)
     174         * @since 1.0.0
    176175         *
    177176         * @param string $template Path to the messages template to load.
    … …  
    183182 * Render the markup for the Messages section of Settings > Notifications.
    184183 *
    185  * @since BuddyPress (1.0.0)
     184 * @since 1.0.0
    186185 */
    187186function messages_screen_notification_settings() {
    … …  
    219218                         * Fires inside the closing </tbody> tag for messages screen notification settings.
    220219                         *
    221                          * @since BuddyPress (1.0.0)
     220                         * @since 1.0.0
    222221                         */
    223222                        do_action( 'messages_screen_notification_settings' ); ?>
  • trunk/src/bp-messages/bp-messages-star.php

    r9951 r10139  
    44 *
    55 * @since BuddyPress (2.3.0)
    6  */
     6 *
     7 * @package BuddyPress
     8 * @subpackage MessagesStar
     9 */
     10
     11// Exit if accessed directly.
     12defined( 'ABSPATH' ) || exit;
    713
    814/** UTILITY **************************************************************/
    … …  
    1117 * Return the starred messages slug. Defaults to 'starred'.
    1218 *
    13  * @since BuddyPress (2.3.0)
     19 * @since 2.3.0
    1420 *
    1521 * @return string
    … …  
    1925         * Filters the starred message slug.
    2026         *
    21          * @since BuddyPress (2.3.0)
     27         * @since 2.3.0
    2228         *
    2329         * @param string
    … …  
    2935 * Function to determine if a message ID is starred.
    3036 *
    31  * @since BuddyPress (2.3.0)
     37 * @since 2.3.0
    3238 *
    3339 * @param  int $mid     The message ID. Please note that this isn't the message thread ID.
    … …  
    5662 * Output the link or raw URL for starring or unstarring a message.
    5763 *
    58  * @since BuddyPress (2.3.0)
     64 * @since 2.3.0
    5965 *
    6066 * @param array $args See bp_get_the_message_star_action_link() for full documentation.
    … …  
    6672         * Return the link or raw URL for starring or unstarring a message.
    6773         *
    68          * @since BuddyPress (2.3.0)
     74         * @since 2.3.0
    6975         *
    7076         * @param array $args {
    … …  
    207213                 * Filters the star action URL for starring / unstarring a message.
    208214                 *
    209                  * @since BuddyPress (2.3.0)
     215                 * @since 2.3.0
    210216                 *
    211217                 * @param string $retval URL for starring / unstarring a message.
    … …  
    220226                 * Filters the star action link, including markup.
    221227                 *
    222                  * @since BuddyPress (2.3.0)
     228                 * @since 2.3.0
    223229                 *
    224230                 * @param string $retval Link for starring / unstarring a message, including markup.
    … …  
    231237 * Save or delete star message meta according to a message's star status.
    232238 *
    233  * @since BuddyPress (2.3.0)
     239 * @since 2.3.0
    234240 *
    235241 * @param array $args {
    … …  
    311317 * Screen handler to display a user's "Starred" private messages page.
    312318 *
    313  * @since BuddyPress (2.3.0)
     319 * @since 2.3.0
    314320 */
    315321function bp_messages_star_screen() {
    … …  
    319325         * Fires right before the loading of the "Starred" messages box.
    320326         *
    321          * @since BuddyPress (2.3.0)
     327         * @since 2.3.0
    322328         */
    323329        do_action( 'bp_messages_screen_star' );
    … …  
    329335 * Screen content callback to display a user's "Starred" messages page.
    330336 *
    331  * @since BuddyPress (2.3.0)
     337 * @since 2.3.0
    332338 */
    333339function bp_messages_star_content() {
    … …  
    345351 * Filter message threads by those starred by the logged-in user.
    346352 *
    347  * @since BuddyPress (2.3.0)
     353 * @since 2.3.0
    348354 *
    349355 * @param  array $r Current message thread arguments.
    … …  
    365371 * Action handler to set a message's star status for those not using JS.
    366372 *
    367  * @since BuddyPress (2.3.0)
     373 * @since 2.3.0
    368374 */
    369375function bp_messages_star_action_handler() {
    … …  
    402408 * Bulk manage handler to set the star status for multiple messages.
    403409 *
    404  * @since BuddyPress (2.3.0)
     410 * @since 2.3.0
    405411 */
    406412function bp_messages_star_bulk_manage_handler() {
    … …  
    475481 * The dashicons font is used for the star / unstar icon.
    476482 *
    477  * @since BuddyPress (2.3.0)
     483 * @since 2.3.0
    478484 */
    479485function bp_messages_star_enqueue_scripts() {
    … …  
    489495 * Add the "Add star" and "Remove star" options to the bulk management list.
    490496 *
    491  * @since BuddyPress (2.3.0)
     497 * @since 2.3.0
    492498 */
    493499function bp_messages_star_bulk_management_dropdown() {
    … …  
    504510 * Add CSS class for the current message depending on starred status.
    505511 *
    506  * @since BuddyPress (2.3.0)
     512 * @since 2.3.0
    507513 *
    508514 * @param  array $retval Current CSS classes
  • trunk/src/bp-messages/bp-messages-template.php

    r10060 r10139  
    11<?php
    2 
    32/**
    43 * BuddyPress Messages Template Tags.
    … …  
    87 */
    98
    10 // Exit if accessed directly
     9// Exit if accessed directly.
    1110defined( 'ABSPATH' ) || exit;
    1211
    … …  
    290289                         * Fires when at the end of threads to iterate over.
    291290                         *
    292                          * @since BuddyPress (1.5.0)
     291                         * @since 1.5.0
    293292                         */
    294293                        do_action( 'messages_box_loop_end' );
    … …  
    352351                         * Fires if at the start of the message thread loop.
    353352                         *
    354                          * @since BuddyPress (1.5.0)
     353                         * @since 1.5.0
    355354                         */
    356355                        do_action( 'messages_box_loop_start' );
    … …  
    366365 * the theme via individual template parts for a member's inbox/sentbox/notices.
    367366 *
    368  * @since BuddyPress (1.0.0)
     367 * @since 1.0.0
    369368 *
    370369 * @global BP_Messages_Box_Template $messages_template
    … …  
    430429         * Filters if there are any message threads to display in inbox/sentbox/notices.
    431430         *
    432          * @since BuddyPress (1.1.0)
     431         * @since 1.1.0
    433432         *
    434433         * @param bool                     $value             Whether or not the message has threads.
    … …  
    476475                 * Filters the ID of the current thread in the loop.
    477476                 *
    478                  * @since BuddyPress (1.0.0)
     477                 * @since 1.0.0
    479478                 *
    480479                 * @param int $thread_id ID of the current thread in the loop.
    … …  
    500499                 * Filters the subject of the current thread in the loop.
    501500                 *
    502                  * @since BuddyPress (1.1.0)
     501                 * @since 1.1.0
    503502                 *
    504503                 * @param string $value Subject of the current thread in the loop.
    … …  
    524523                 * Filters the excerpt of the current thread in the loop.
    525524                 *
    526                  * @since BuddyPress (1.0.0)
     525                 * @since 1.0.0
    527526                 *
    528527                 * @param string $value Excerpt of the current thread in the loop.
    … …  
    540539 * the thread of which you *are* the member.
    541540 *
    542  * @since BuddyPress (2.0.0)
     541 * @since 2.0.0
    543542 */
    544543function bp_message_thread_content() {
    … …  
    554553         * the thread of which you *are* the member.
    555554         *
    556          * @since BuddyPress (2.0.0)
     555         * @since 2.0.0
    557556         * @return string The raw content of the last message in the thread.
    558557         */
    … …  
    563562                 * Filters the content of the last message in the thread.
    564563                 *
    565                  * @since BuddyPress (2.0.0)
     564                 * @since 2.0.0
    566565                 *
    567566                 * @param string $last_message_content Content of the last message in the thread.
    … …  
    587586                 * Filters the link to the page of the current thread's last author.
    588587                 *
    589                  * @since BuddyPress (1.0.0)
     588                 * @since 1.0.0
    590589                 *
    591590                 * @param string $value Link to the page of the current thread's last author.
    … …  
    611610                 * Filters the HTML links to the pages of the current thread's recipients.
    612611                 *
    613                  * @since BuddyPress (1.0.0)
     612                 * @since 1.0.0
    614613                 *
    615614                 * @param string $value HTML links to the pages of the current thread's recipients.
    … …  
    646645                 * Filters the permalink of a particular thread.
    647646                 *
    648                  * @since BuddyPress (1.0.0)
     647                 * @since 1.0.0
    649648                 *
    650649                 * @param string $value permalink of a particular thread.
    … …  
    670669                 * Filters the URL for deleting the current thread.
    671670                 *
    672                  * @since BuddyPress (1.0.0)
     671                 * @since 1.0.0
    673672                 *
    674673                 * @param string $value URL for deleting the current thread.
    … …  
    683682 * Since this function directly outputs a URL, it is escaped.
    684683 *
    685  * @since BuddyPress (2.2.0)
     684 * @since 2.2.0
    686685 */
    687686function bp_the_message_thread_mark_unread_url() {
    … …  
    691690         * Return the URL used for marking a single message thread as unread.
    692691         *
    693          * @since BuddyPress (2.2.0)
     692         * @since 2.2.0
    694693         *
    695694         * @return string
    … …  
    718717                 * Filters the URL used for marking a single message thread as unread.
    719718                 *
    720                  * @since BuddyPress (2.2.0)
     719                 * @since 2.2.0
    721720                 *
    722721                 * @param string $url URL used for marking a single message thread as unread.
    … …  
    730729 * Since this function directly outputs a URL, it is escaped.
    731730 *
    732  * @since BuddyPress (2.2.0)
     731 * @since 2.2.0
    733732 */
    734733function bp_the_message_thread_mark_read_url() {
    … …  
    738737         * Return the URL used for marking a single message thread as read.
    739738         *
    740          * @since BuddyPress (2.2.0)
     739         * @since 2.2.0
    741740         *
    742741         * @return string
    … …  
    765764                 * Filters the URL used for marking a single message thread as read.
    766765                 *
    767                  * @since BuddyPress (2.2.0)
     766                 * @since 2.2.0
    768767                 *
    769768                 * @param string $url URL used for marking a single message thread as read.
    … …  
    795794                 * Filters the CSS class for the current thread.
    796795                 *
    797                  * @since BuddyPress (1.2.10)
     796                 * @since 1.2.10
    798797                 *
    799798                 * @param string $class Class string to be added to the list of classes.
    … …  
    817816         * Filters whether or not a message thread has unread items.
    818817         *
    819          * @since BuddyPress (2.1.0)
     818         * @since 2.1.0
    820819         *
    821820         * @param bool $retval Whether or not a message thread has unread items.
    … …  
    845844                 * Filters the current thread's unread count.
    846845                 *
    847                  * @since BuddyPress (1.0.0)
     846                 * @since 1.0.0
    848847                 *
    849848                 * @param int $count Current thread unread count.
    … …  
    855854 * Output a thread's total message count.
    856855 *
    857  * @since BuddyPress (2.2.0)
     856 * @since 2.2.0
    858857 *
    859858 * @param int|bool $thread_id Optional. ID of the thread. Defaults to current thread ID.
    … …  
    865864         * Get the current thread's total message count.
    866865         *
    867          * @since BuddyPress (2.2.0)
     866         * @since 2.2.0
    868867         *
    869868         * @param int|bool $thread_id Optional. ID of the thread.
    … …  
    889888                 * Filters the current thread's total message count.
    890889                 *
    891                  * @since BuddyPress (2.2.0)
     890                 * @since 2.2.0
    892891                 *
    893892                 * @param int $count Current thread total message count.
    … …  
    899898 * Output markup for the current thread's total and unread count.
    900899 *
    901  * @since BuddyPress (2.2.0)
     900 * @since 2.2.0
    902901 *
    903902 * @param int|bool $thread_id Optional. ID of the thread. Default: current thread ID.
    … …  
    945944                 * Filters the unformatted date of the last post in the current thread.
    946945                 *
    947                  * @since BuddyPress (2.1.0)
     946                 * @since 2.1.0
    948947                 *
    949948                 * @param string $last_message_date Unformatted date of the last post in the current thread.
    … …  
    968967                 * Filters the nicely formatted date of the last post in the current thread.
    969968                 *
    970                  * @since BuddyPress (2.1.0)
     969                 * @since 2.1.0
    971970                 *
    972971                 * @param string $value Formatted date of the last post in the current thread.
    … …  
    10221021                 * Filters the avatar for the last sender in the current message thread.
    10231022                 *
    1024                  * @since BuddyPress (1.0.0)
     1023                 * @since 1.0.0
    10251024                 *
    10261025                 * @param string $value User avatar string.
    … …  
    10531052                 * Filters the unread messages count for the current inbox.
    10541053                 *
    1055                  * @since BuddyPress (1.0.0)
     1054                 * @since 1.0.0
    10561055                 *
    10571056                 * @param int $value Unread messages count for the current inbox.
    … …  
    10771076                 * Filters the pagination HTML for the current thread loop.
    10781077                 *
    1079                  * @since BuddyPress (1.0.0)
     1078                 * @since 1.0.0
    10801079                 *
    10811080                 * @param int $pag_links Pagination HTML for the current thread loop.
    … …  
    11101109 *
    11111110 * @todo  Move markup to template part in: /members/single/messages/search.php
    1112  * @since BuddyPress (1.6.0)
     1111 * @since 1.6.0
    11131112 */
    11141113function bp_message_search_form() {
    … …  
    11391138         * Filters the private message component search form.
    11401139         *
    1141          * @since BuddyPress (2.2.0)
     1140         * @since 2.2.0
    11421141         *
    11431142         * @param string $search_form_html HTML markup for the message search form.
    … …  
    11621161                 * Filters the form action for Messages HTML forms.
    11631162                 *
    1164                  * @since BuddyPress (1.0.0)
     1163                 * @since 1.0.0
    11651164                 *
    11661165                 * @param string $value The form action.
    … …  
    11891188                         * cookie or 'r' $_GET parameter is set.
    11901189                         *
    1191                          * @since BuddyPress (1.0.0)
     1190                         * @since 1.0.0
    11921191                         *
    11931192                         * @param string $value Default user name.
    … …  
    12241223                 * Filters the default value for the subject field.
    12251224                 *
    1226                  * @since BuddyPress (1.0.0)
     1225                 * @since 1.0.0
    12271226                 *
    12281227                 * @param string $subject The default value for the subject field.
    … …  
    12551254                 * Filters the default value for the content field.
    12561255                 *
    1257                  * @since BuddyPress (1.0.0)
     1256                 * @since 1.0.0
    12581257                 *
    12591258                 * @param string $content The default value for the content field.
    … …  
    12941293 * Output the dropdown for bulk management of messages.
    12951294 *
    1296  * @since BuddyPress (2.2.0)
     1295 * @since 2.2.0
    12971296 */
    12981297function bp_messages_bulk_management_dropdown() {
    … …  
    13081307                         * Action to add additional options to the messages bulk management dropdown.
    13091308                         *
    1310                          * @since BuddyPress (2.3.0)
     1309                         * @since 2.3.0
    13111310                         */
    13121311                        do_action( 'bp_messages_bulk_management_dropdown' );
    … …  
    13201319 * Return whether or not the notice is currently active.
    13211320 *
    1322  * @since BuddyPress (1.6.0)
     1321 * @since 1.6.0
    13231322 */
    13241323function bp_messages_is_active_notice() {
    … …  
    13321331         * Filters whether or not the notice is currently active.
    13331332         *
    1334          * @since BuddyPress (2.1.0)
     1333         * @since 2.1.0
    13351334         *
    13361335         * @param bool $retval Whether or not the notice is currently active.
    … …  
    13441343 * Since 1.6 this function has been deprecated in favor of text in the theme.
    13451344 *
    1346  * @since BuddyPress (1.0.0)
    1347  * @deprecated BuddyPress (1.6.0)
     1345 * @since 1.0.0
     1346 * @deprecated 1.6.0
    13481347 * @uses bp_get_message_is_active_notice()
    13491348 */
    … …  
    13571356         * theme.
    13581357         *
    1359          * @since BuddyPress (1.0.0)
    1360          * @deprecated BuddyPress (1.6.0)
     1358         * @since 1.0.0
     1359         * @deprecated 1.6.0
    13611360         * @uses bp_messages_is_active_notice()
    13621361         */
    … …  
    13871386                 * Filters the ID of the current notice in the loop.
    13881387                 *
    1389                  * @since BuddyPress (1.5.0)
     1388                 * @since 1.5.0
    13901389                 *
    13911390                 * @param int $id ID of the current notice in the loop.
    … …  
    14111410                 * Filters the post date of the current notice in the loop.
    14121411                 *
    1413                  * @since BuddyPress (1.0.0)
     1412                 * @since 1.0.0
    14141413                 *
    14151414                 * @param string $value Formatted post date of the current notice in the loop.
    … …  
    14351434                 * Filters the subject of the current notice in the loop.
    14361435                 *
    1437                  * @since BuddyPress (1.0.0)
     1436                 * @since 1.0.0
    14381437                 *
    14391438                 * @param string $subject Subject of the current notice in the loop.
    … …  
    14591458                 * Filters the text of the current notice in the loop.
    14601459                 *
    1461                  * @since BuddyPress (1.0.0)
     1460                 * @since 1.0.0
    14621461                 *
    14631462                 * @param string $message Text for the current notice in the loop.
    … …  
    14831482                 * Filters the URL for deleting the current notice.
    14841483                 *
    1485                  * @since BuddyPress (1.0.0)
     1484                 * @since 1.0.0
    14861485                 *
    14871486                 * @param string $value URL for deleting the current notice.
    … …  
    15141513                 * Filters the URL for deactivating the current notice.
    15151514                 *
    1516                  * @since BuddyPress (1.0.0)
     1515                 * @since 1.0.0
    15171516                 *
    15181517                 * @param string $link URL for deactivating the current notice.
    … …  
    15441543                 * Filters the "Deactivate" or "Activate" text for notice action links.
    15451544                 *
    1546                  * @since BuddyPress (1.0.0)
     1545                 * @since 1.0.0
    15471546                 *
    15481547                 * @param string $text Text used for notice action links.
    … …  
    15541553 * Output the messages component slug.
    15551554 *
    1556  * @since BuddyPress (1.5.0)
     1555 * @since 1.5.0
    15571556 *
    15581557 * @uses bp_get_messages_slug()
    … …  
    15641563         * Return the messages component slug.
    15651564         *
    1566          * @since BuddyPress (1.5.0)
     1565         * @since 1.5.0
    15671566         *
    15681567         * @return string
    … …  
    15731572                 * Filters the messages component slug.
    15741573                 *
    1575                  * @since BuddyPress (1.5.0)
     1574                 * @since 1.5.0
    15761575                 *
    15771576                 * @param string $slug Messages component slug.
    … …  
    16311630                 * Filters the URL for the Private Message link in member profile headers.
    16321631                 *
    1633                  * @since BuddyPress (1.2.10)
     1632                 * @since 1.2.10
    16341633                 *
    16351634                 * @param string $value URL for the Private Message link in member profile headers.
    … …  
    16431642 * Explicitly named function to avoid confusion with public messages.
    16441643 *
    1645  * @since BuddyPress (1.2.6)
     1644 * @since 1.2.6
    16461645 *
    16471646 * @uses bp_get_send_message_button()
    … …  
    16701669                         * Filters the "Private Message" button for member profile headers.
    16711670                         *
    1672                          * @since BuddyPress (1.8.0)
     1671                         * @since 1.8.0
    16731672                         *
    16741673                         * @param array $value See {@link BP_Button}.
    … …  
    17041703                 * Filters the URL of the Messages AJAX loader gif.
    17051704                 *
    1706                  * @since BuddyPress (1.0.0)
     1705                 * @since 1.0.0
    17071706                 *
    17081707                 * @param string $value URL of the Messages AJAX loader gif.
    … …  
    17571756                 * Filters the recipients usernames for prefilling the 'To' field on the Compose screen.
    17581757                 *
    1759                  * @since BuddyPress (1.0.0)
     1758                 * @since 1.0.0
    17601759                 *
    17611760                 * @param string $recipients Recipients usernames for 'To' field prefilling.
    … …  
    19121911                         * Fires when at the end of messages to iterate over.
    19131912                         *
    1914                          * @since BuddyPress (1.1.0)
     1913                         * @since 1.1.0
    19151914                         */
    19161915                        do_action( 'thread_loop_end' );
    … …  
    19421941                         * Fires if at the start of the message loop.
    19431942                         *
    1944                          * @since BuddyPress (1.1.0)
     1943                         * @since 1.1.0
    19451944                         */
    19461945                        do_action( 'thread_loop_start' );
    … …  
    20402039                 * Filters the ID of the thread that the current loop belongs to.
    20412040                 *
    2042                  * @since BuddyPress (1.1.0)
     2041                 * @since 1.1.0
    20432042                 *
    20442043                 * @param int $thread_id ID of the thread.
    … …  
    20642063                 * Filters the subject of the thread currently being iterated over.
    20652064                 *
    2066                  * @since BuddyPress (1.1.0)
     2065                 * @since 1.1.0
    20672066                 *
    20682067                 * @return string $last_message_subject Subject of the thread currently being iterated over.
    … …  
    20932092 * Get the number of recipients in the current thread.
    20942093 *
    2095  * @since BuddyPress (2.2.0)
     2094 * @since 2.2.0
    20962095 *
    20972096 * @return int
    … …  
    21052104 * Get the max number of recipients to list in the 'Conversation between...' gloss.
    21062105 *
    2107  * @since BuddyPress (2.3.0)
     2106 * @since 2.3.0
    21082107 *
    21092108 * @return int
    … …  
    21132112         * Filters the max number of recipients to list in the 'Conversation between...' gloss.
    21142113         *
    2115          * @since BuddyPress (2.3.0)
     2114         * @since 2.3.0
    21162115         *
    21172116         * @param int $count Recipient count. Default: 5.
    … …  
    21232122 * Output HTML links to recipients in the current thread.
    21242123 *
    2125  * @since BuddyPress (2.2.0)
     2124 * @since 2.2.0
    21262125 */
    21272126function bp_the_thread_recipients_list() {
    … …  
    21312130         * Generate HTML links to the profiles of recipients in the current thread.
    21322131         *
    2133          * @since BuddyPress (2.2.0)
     2132         * @since 2.2.0
    21342133         *
    21352134         * @return string
    … …  
    21552154                 * Filters the HTML links to the profiles of recipients in the current thread.
    21562155                 *
    2157                  * @since BuddyPress (2.2.0)
     2156                 * @since 2.2.0
    21582157                 *
    21592158                 * @param string $value Comma-separated list of recipient HTML links for current thread.
    … …  
    21652164 * Echo the ID of the current message in the thread.
    21662165 *
    2167  * @since BuddyPress (1.9.0)
     2166 * @since 1.9.0
    21682167 */
    21692168function bp_the_thread_message_id() {
    … …  
    21732172         * Get the ID of the current message in the thread.
    21742173         *
    2175          * @since BuddyPress (1.9.0)
     2174         * @since 1.9.0
    21762175         *
    21772176         * @return int
    … …  
    21872186                 * Filters the ID of the current message in the thread.
    21882187                 *
    2189                  * @since BuddyPress (1.9.0)
     2188                 * @since 1.9.0
    21902189                 *
    21912190                 * @param int $thread_message_id ID of the current message in the thread.
    … …  
    21972196 * Output the CSS classes for messages within a single thread.
    21982197 *
    2199  * @since BuddyPress (2.1.0)
     2198 * @since 2.1.0
    22002199 */
    22012200function bp_the_thread_message_css_class() {
    … …  
    22052204         * Generate the CSS classes for messages within a single thread.
    22062205         *
    2207          * @since BuddyPress (2.1.0)
     2206         * @since 2.1.0
    22082207         *
    22092208         * @return string
    … …  
    22282227                 * Filters the CSS classes for messages within a single thread.
    22292228                 *
    2230                  * @since BuddyPress (2.1.0)
     2229                 * @since 2.1.0
    22312230                 *
    22322231                 * @param array $classes Array of classes to add to the HTML class attribute.
    … …  
    22602259                 * Filters the CSS class used for message zebra striping.
    22612260                 *
    2262                  * @since BuddyPress (1.1.0)
     2261                 * @since 1.1.0
    22632262                 *
    22642263                 * @param string $class Class determined to be next for zebra striping effect.
    … …  
    22702269 * Output the ID for message sender within a single thread.
    22712270 *
    2272  * @since BuddyPress (2.1.0)
     2271 * @since 2.1.0
    22732272 */
    22742273function bp_the_thread_message_sender_id() {
    … …  
    22782277         * Return the ID for message sender within a single thread.
    22792278         *
    2280          * @since BuddyPress (2.1.0)
     2279         * @since 2.1.0
    22812280         *
    22822281         * @return string
    … …  
    22922291                 * Filters the ID for message sender within a single thread.
    22932292                 *
    2294                  * @since BuddyPress (2.1.0)
     2293                 * @since 2.1.0
    22952294                 *
    22962295                 * @param int $user_id ID of the message sender.
    … …  
    23322331                 * Filters the avatar for the current message sender.
    23332332                 *
    2334                  * @since BuddyPress (1.1.0)
     2333                 * @since 1.1.0
    23352334                 *
    23362335                 * @param string $value <img> tag containing the avatar value.
    … …  
    23622361                 * Filters the link to the sender of the current message.
    23632362                 *
    2364                  * @since BuddyPress (1.1.0)
     2363                 * @since 1.1.0
    23652364                 *
    23662365                 * @param string $value Link to the sender of the current message.
    … …  
    23922391                 * Filters the display name of the sender of the current message.
    23932392                 *
    2394                  * @since BuddyPress (1.1.0)
     2393                 * @since 1.1.0
    23952394                 *
    23962395                 * @param string $display_name Display name of the sender of the current message.
    … …  
    24152414                 * Filters the URL for deleting the current thread.
    24162415                 *
    2417                  * @since BuddyPress (1.0.0)
     2416                 * @since 1.0.0
    24182417                 *
    24192418                 * @param string $value URL for deleting the current thread.
    … …  
    24392438                 * Filters the 'Sent x hours ago' string for the current message.
    24402439                 *
    2441                  * @since BuddyPress (1.1.0)
     2440                 * @since 1.1.0
    24422441                 *
    24432442                 * @param string $value Default text of 'Sent x hours ago'.
    … …  
    24492448 * Output the timestamp for the current message.
    24502449 *
    2451  * @since BuddyPress (2.1.0)
     2450 * @since 2.1.0
    24522451 */
    24532452function bp_the_thread_message_date_sent() {
    … …  
    24572456         * Generate the 'Sent x hours ago' string for the current message.
    24582457         *
    2459          * @since BuddyPress (2.1.0)
     2458         * @since 2.1.0
    24602459         *
    24612460         * @uses strtotime() To convert the message string into a usable timestamp.
    … …  
    24692468                 * Filters the date sent value for the current message as a timestamp.
    24702469                 *
    2471                  * @since BuddyPress (2.1.0)
     2470                 * @since 2.1.0
    24722471                 *
    24732472                 * @param string $value Timestamp of the date sent value for the current message.
    … …  
    24932492                 * Filters the content of the current message in the loop.
    24942493                 *
    2495                  * @since BuddyPress (1.1.0)
     2494                 * @since 1.1.0
    24962495                 *
    24972496                 * @param string $message The content of the current message in the loop.
    … …  
    25052504 * Enable oEmbed support for Messages.
    25062505 *
    2507  * @since BuddyPress (1.5.0)
     2506 * @since 1.5.0
    25082507 *
    25092508 * @see BP_Embed
    … …  
    25212520 * Used during {@link BP_Embed::parse_oembed()} via {@link bp_messages_embed()}.
    25222521 *
    2523  * @since BuddyPress (2.2.0)
     2522 * @since 2.2.0
    25242523 *
    25252524 * @param string $cache    An empty string passed by BP_Embed::parse_oembed() for
    … …  
    25392538 * Used during {@link BP_Embed::parse_oembed()} via {@link bp_messages_embed()}.
    25402539 *
    2541  * @since BuddyPress (2.2.0)
     2540 * @since 2.2.0
    25422541 *
    25432542 * @param string $cache    An empty string passed by BP_Embed::parse_oembed() for
  • trunk/src/bp-messages/bp-messages-widgets.php

    r9862 r10139  
    77 */
    88
     9// Exit if accessed directly.
     10defined( 'ABSPATH' ) || exit;
     11
    912/**
    1013 * Register widgets for the Messages component.
    1114 *
    12  * @since BuddyPress (1.9.0)
     15 * @since 1.9.0
    1316 */
    1417function bp_messages_register_widgets() {
    … …  
    2225 * A widget that displays sitewide notices.
    2326 *
    24  * @since BuddyPress (1.9.0)
     27 * @since 1.9.0
    2528 */
    2629class BP_Messages_Sitewide_Notices_Widget extends WP_Widget {
    … …  
    6770                 * Filters the title of the Messages widget.
    6871                 *
    69                  * @since BuddyPress (1.9.0)
    70                  * @since BuddyPress (2.3.0) Added 'instance' and 'id_base' to arguments passed to filter.
     72                 * @since 1.9.0
     73                 * @since 2.3.0 Added 'instance' and 'id_base' to arguments passed to filter.
    7174                 *
    7275                 * @param string $title    The widget title.
  • trunk/src/bp-messages/classes/class-bp-messages-message.php

    r9862 r10139  
    11<?php
    22/**
    3  * BuddyPress Messages Classes
     3 * BuddyPress Messages Classes.
    44 *
    55 * @package BuddyPress
    … …  
    77 */
    88
    9 // Exit if accessed directly
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
    … …  
    119119                 * Please use this hook to filter the properties above. Each part will be passed in.
    120120                 *
    121                  * @since BuddyPress (1.0.0)
     121                 * @since 1.0.0
    122122                 *
    123123                 * @param BP_Messages_Message $this Current instance of the message item being saved. Passed by reference.
    … …  
    165165                 * Fires after the current message item has been saved.
    166166                 *
    167                  * @since BuddyPress (1.0.0)
     167                 * @since 1.0.0
    168168                 *
    169169                 * @param BP_Messages_Message $this Current instance of the message item being saved. Passed by reference.
  • trunk/src/bp-messages/classes/class-bp-messages-notice.php

    r9862 r10139  
    11<?php
    22/**
    3  * BuddyPress Messages Classes
     3 * BuddyPress Messages Classes.
    44 *
    55 * @package BuddyPress
    … …  
    77 */
    88
    9 // Exit if accessed directly
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
    … …  
    1515 * Use this class to create, activate, deactivate or delete notices.
    1616 *
    17  * @since BuddyPress (1.0.0)
     17 * @since 1.0.0
    1818 */
    1919class BP_Messages_Notice {
    … …  
    5656         * Constructor.
    5757         *
    58          * @since BuddyPress (1.0.0)
     58         * @since 1.0.0
    5959         * @param int $id Optional. The ID of the current notice.
    6060         */
    … …  
    7171         * Runs during constructor.
    7272         *
    73          * @since BuddyPress (1.0.0)
     73         * @since 1.0.0
    7474         */
    7575        public function populate() {
    … …  
    9191         * Saves a notice.
    9292         *
    93          * @since BuddyPress (1.0.0)
     93         * @since 1.0.0
    9494         *
    9595         * @return bool
    … …  
    108108                 * Please use this hook to filter the properties above. Each part will be passed in.
    109109                 *
    110                  * @since BuddyPress (1.0.0)
     110                 * @since 1.0.0
    111111                 *
    112112                 * @param BP_Messages_Notice $this Current instance of the message notice item being saved. Passed by reference.
    … …  
    136136                 * Fires after the current message notice item has been saved.
    137137                 *
    138                  * @since BuddyPress (1.0.0)
     138                 * @since 1.0.0
    139139                 *
    140140                 * @param BP_Messages_Notice $this Current instance of the message item being saved. Passed by reference.
    … …  
    148148         * Activates a notice.
    149149         *
    150          * @since BuddyPress (1.0.0)
     150         * @since 1.0.0
    151151         *
    152152         * @return bool
    … …  
    160160         * Deactivates a notice.
    161161         *
    162          * @since BuddyPress (1.0.0)
     162         * @since 1.0.0
    163163         *
    164164         * @return bool
    … …  
    172172         * Deletes a notice.
    173173         *
    174          * @since BuddyPress (1.0.0)
     174         * @since 1.0.0
    175175         *
    176176         * @return bool
    … …  
    182182                 * Fires before the current message item has been deleted.
    183183                 *
    184                  * @since BuddyPress (1.0.0)
     184                 * @since 1.0.0
    185185                 *
    186186                 * @param BP_Messages_Notice $this Current instance of the message notice item being deleted.
    … …  
    205205         * To get all notices, pass a value of -1 to pag_num.
    206206         *
    207          * @since BuddyPress (1.0.0)
     207         * @since 1.0.0
    208208         *
    209209         * @param array $args {
    … …  
    237237         * Returns the total number of recorded notices.
    238238         *
    239          * @since BuddyPress (1.0.0)
     239         * @since 1.0.0
    240240         *
    241241         * @return int
    … …  
    254254         * Returns the active notice that should be displayed on the frontend.
    255255         *
    256          * @since BuddyPress (1.0.0)
     256         * @since 1.0.0
    257257         *
    258258         * @return object The BP_Messages_Notice object.
  • trunk/src/bp-messages/classes/class-bp-messages-thread.php

    r10038 r10139  
    11<?php
    22/**
    3  * BuddyPress Messages Classes
     3 * BuddyPress Messages Classes.
    44 *
    55 * @package BuddyPress
    … …  
    77 */
    88
    9 // Exit if accessed directly
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
    … …  
    1313 * BuddyPress Message Thread class.
    1414 *
    15  * @since BuddyPress (1.0.0)
     15 * @since 1.0.0
    1616 */
    1717class BP_Messages_Thread {
    … …  
    2020         * The message thread ID.
    2121         *
    22          * @since BuddyPress (1.0.0)
     22         * @since 1.0.0
    2323         * @var int
    2424         */
    … …  
    2828         * The current messages.
    2929         *
    30          * @since BuddyPress (1.0.0)
     30         * @since 1.0.0
    3131         * @var array
    3232         */
    … …  
    3636         * The current recipients in the message thread.
    3737         *
    38          * @since BuddyPress (1.0.0)
     38         * @since 1.0.0
    3939         * @var array
    4040         */
    … …  
    4444         * The user IDs of all messages in the message thread.
    4545         *
    46          * @since BuddyPress (1.2.0)
     46         * @since 1.2.0
    4747         * @var array
    4848         */
    … …  
    5252         * The unread count for the logged-in user.
    5353         *
    54          * @since BuddyPress (1.2.0)
     54         * @since 1.2.0
    5555         * @var int
    5656         */
    … …  
    6060         * The content of the last message in this thread.
    6161         *
    62          * @since BuddyPress (1.2.0)
     62         * @since 1.2.0
    6363         * @var string
    6464         */
    … …  
    6868         * The date of the last message in this thread.
    6969         *
    70          * @since BuddyPress (1.2.0)
     70         * @since 1.2.0
    7171         * @var string
    7272         */
    … …  
    7676         * The ID of the last message in this thread.
    7777         *
    78          * @since BuddyPress (1.2.0)
     78         * @since 1.2.0
    7979         * @var int
    8080         */
    … …  
    8484         * The subject of the last message in this thread.
    8585         *
    86          * @since BuddyPress (1.2.0)
     86         * @since 1.2.0
    8787         * @var string
    8888         */
    … …  
    9292         * The user ID of the author of the last message in this thread.
    9393         *
    94          * @since BuddyPress (1.2.0)
     94         * @since 1.2.0
    9595         * @var int
    9696         */
    … …  
    100100         * Sort order of the messages in this thread (ASC or DESC).
    101101         *
    102          * @since BuddyPress (1.5.0)
     102         * @since 1.5.0
    103103         * @var string
    104104         */
    … …  
    108108         * Constructor.
    109109         *
    110          * @since BuddyPress (1.0.0)
     110         * @since 1.0.0
    111111         *
    112112         * @see BP_Messages_Thread::populate() for full description of parameters.
    … …  
    127127         * Used in constructor.
    128128         *
    129          * @since BuddyPress (1.0.0)
     129         * @since 1.0.0
    130130         *
    131131         * @param int    $thread_id The message thread ID.
    … …  
    192192                 * Fires after a BP_Messages_Thread object has been populated.
    193193                 *
    194                  * @since BuddyPress (2.2.0)
     194                 * @since 2.2.0
    195195                 *
    196196                 * @param BP_Messages_Thread $this Message thread object.
    … …  
    202202         * Mark a thread initialized in this class as read.
    203203         *
    204          * @since BuddyPress (1.0.0)
     204         * @since 1.0.0
    205205         *
    206206         * @see BP_Messages_Thread::mark_as_read()
    … …  
    213213         * Mark a thread initialized in this class as unread.
    214214         *
    215          * @since BuddyPress (1.0.0)
     215         * @since 1.0.0
    216216         *
    217217         * @see BP_Messages_Thread::mark_as_unread()
    … …  
    224224         * Returns recipients for a message thread.
    225225         *
    226          * @since BuddyPress (1.0.0)
    227          * @since BuddyPress (2.3.0) Added $thread_id as a parameter.
     226         * @since 1.0.0
     227         * @since 2.3.0 Added $thread_id as a parameter.
    228228         *
    229229         * @param int $thread_id The thread ID.
    … …  
    258258                 * Filters the recipients of a message thread.
    259259                 *
    260                  * @since BuddyPress (2.2.0)
     260                 * @since 2.2.0
    261261                 *
    262262                 * @param array $recipients Array of recipient objects.
    … …  
    271271         * Get all messages associated with a thread.
    272272         *
    273          * @since BuddyPress (2.3.0)
     273         * @since 2.3.0
    274274         *
    275275         * @param int $thread_id The message thread ID.
    … …  
    298298         * Static method to get message recipients by thread ID.
    299299         *
    300          * @since BuddyPress (2.3.0)
     300         * @since 2.3.0
    301301         *
    302302         * @param  int $thread_id The thread ID.
    … …  
    315315         * has marked the thread as deleted.
    316316         *
    317          * @since BuddyPress (1.0.0)
     317         * @since 1.0.0
    318318         *
    319319         * @param int $thread_id The message thread ID.
    … …  
    329329                 * Fires before a message thread is marked as deleted.
    330330                 *
    331                  * @since BuddyPress (2.2.0)
     331                 * @since 2.2.0
    332332                 *
    333333                 * @param int $thread_id ID of the thread being deleted.
    … …  
    355355                         * Fires before an entire message thread is deleted.
    356356                         *
    357                          * @since BuddyPress (2.2.0)
     357                         * @since 2.2.0
    358358                         *
    359359                         * @param int   $thread_id   ID of the thread being deleted.
    … …  
    374374                                 * Fires after a message is deleted. This hook is poorly named.
    375375                                 *
    376                                  * @since BuddyPress (1.0.0)
     376                                 * @since 1.0.0
    377377                                 *
    378378                                 * @param int $message_id ID of the message.
    … …  
    388388                 * Fires after a message thread is either marked as deleted or deleted.
    389389                 *
    390                  * @since BuddyPress (2.2.0)
     390                 * @since 2.2.0
    391391                 *
    392392                 * @param int   $thread_id   ID of the thread being deleted.
    … …  
    401401         * Get current message threads for a user.
    402402         *
    403          * @since BuddyPress (1.0.0)
     403         * @since 1.0.0
    404404         *
    405405         * @param array $args {
    … …  
    536536                 * Filters the results of the query for a user's message threads.
    537537                 *
    538                  * @since BuddyPress (2.2.0)
     538                 * @since 2.2.0
    539539                 *
    540540                 * @param array $value {
    … …  
    555555         * and creating the necessary SQL clauses.
    556556         *
    557          * @since BuddyPress (2.2.0)
     557         * @since 2.2.0
    558558         *
    559559         * @param array $meta_query An array of meta_query filters. See the
    … …  
    586586         * Mark a thread as read.
    587587         *
    588          * @since BuddyPress (1.0.0)
     588         * @since 1.0.0
    589589         *
    590590         * @param int $thread_id The message thread ID.
    … …  
    604604         * Mark a thread as unread.
    605605         *
    606          * @since BuddyPress (1.0.0)
     606         * @since 1.0.0
    607607         *
    608608         * @param int $thread_id The message thread ID.
    … …  
    622622         * Returns the total number of message threads for a user.
    623623         *
    624          * @since BuddyPress (1.0.0)
     624         * @since 1.0.0
    625625         *
    626626         * @param int    $user_id The user ID.
    … …  
    653653         * Determine if the logged-in user is a sender of any message in a thread.
    654654         *
    655          * @since BuddyPress (1.0.0)
     655         * @since 1.0.0
    656656         *
    657657         * @param int $thread_id The message thread ID.
    … …  
    676676         * Returns the userlink of the last sender in a message thread.
    677677         *
    678          * @since BuddyPress (1.0.0)
     678         * @since 1.0.0
    679679         *
    680680         * @param int $thread_id The message thread ID.
    … …  
    697697         * Gets the unread message count for a user.
    698698         *
    699          * @since BuddyPress (1.0.0)
     699         * @since 1.0.0
    700700         *
    701701         * @param int $user_id The user ID.
    … …  
    723723                 * Filters a user's unread message count.
    724724                 *
    725                  * @since BuddyPress (2.2.0)
     725                 * @since 2.2.0
    726726                 *
    727727                 * @param int $unread_count Unread message count.
    … …  
    734734         * Checks whether a user is a part of a message thread discussion.
    735735         *
    736          * @since BuddyPress (1.0.0)
     736         * @since 1.0.0
    737737         *
    738738         * @param int $thread_id The message thread ID.
    … …  
    759759         * Checks whether a message thread exists.
    760760         *
    761          * @since BuddyPress (1.0.0)
     761         * @since 1.0.0
    762762         *
    763763         * @param int $thread_id The message thread ID.
    … …  
    789789         * "X Recipients" where "X" is the number of recipients in the message thread.
    790790         *
    791          * @since BuddyPress (1.0.0)
     791         * @since 1.0.0
    792792         *
    793793         * @param array $recipients Array containing the message recipients (array of objects).
    … …  
    819819         * Upgrade method for the older BP message thread DB table.
    820820         *
    821          * @since BuddyPress (1.2.0)
     821         * @since 1.2.0
    822822         *
    823823         * @todo We should remove this.  No one is going to upgrade from v1.1, right?
Note: See TracChangeset for help on using the changeset viewer.