Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
05/12/2015 04:39:07 AM (9 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/classes/class-bp_messages-thread.php

    r9819 r9862  
    5757
    5858    /**
    59      * The content of the last message in this thread
     59     * The content of the last message in this thread.
    6060     *
    6161     * @since BuddyPress (1.2.0)
     
    6565
    6666    /**
    67      * The date of the last message in this thread
     67     * The date of the last message in this thread.
    6868     *
    6969     * @since BuddyPress (1.2.0)
     
    7373
    7474    /**
    75      * The ID of the last message in this thread
     75     * The ID of the last message in this thread.
    7676     *
    7777     * @since BuddyPress (1.2.0)
     
    8181
    8282    /**
    83      * The subject of the last message in this thread
     83     * The subject of the last message in this thread.
    8484     *
    8585     * @since BuddyPress (1.2.0)
     
    8989
    9090    /**
    91      * The user ID of the author of the last message in this thread
     91     * The user ID of the author of the last message in this thread.
    9292     *
    9393     * @since BuddyPress (1.2.0)
     
    109109     * @since BuddyPress (1.0.0)
    110110     *
    111      * @see BP_Messages_Thread::populate() for full description of parameters
     111     * @see BP_Messages_Thread::populate() for full description of parameters.
     112     *
     113     * @param bool   $thread_id
     114     * @param string $order
     115     * @param array  $args
    112116     */
    113117    public function __construct( $thread_id = false, $order = 'ASC', $args = array() ) {
     
    124128     * @since BuddyPress (1.0.0)
    125129     *
    126      * @param int $thread_id The message thread ID.
    127      * @param string $order The order to sort the messages. Either 'ASC' or 'DESC'.
     130     * @param int    $thread_id The message thread ID.
     131     * @param string $order     The order to sort the messages. Either 'ASC' or 'DESC'.
    128132     * @param array $args {
    129133     *     Array of arguments.
    130134     *     @type bool $update_meta_cache Whether to pre-fetch metadata for
    131      *           queried message items. Default: true.
     135     *                                   queried message items. Default: true.
    132136     * }
    133137     * @return bool False on failure.
     
    182186         * @since BuddyPress (2.2.0)
    183187         *
    184          * @param BP_Messages_Thread Message thread object.
     188         * @param BP_Messages_Thread $this Message thread object.
    185189         */
    186190        do_action( 'bp_messages_thread_post_populate', $this );
     
    215219     * @since BuddyPress (2.3.0) Added $thread_id as a parameter.
    216220     *
    217      * @param int $thread_id The thread ID
     221     * @param int $thread_id The thread ID.
     222     *
    218223     * @return array
    219224     */
     
    257262     * @since BuddyPress (2.3.0)
    258263     *
    259      * @param int $thread_id The message thread ID
     264     * @param int $thread_id The message thread ID.
     265     *
    260266     * @return array
    261267     */
     
    282288     * @since BuddyPress (2.3.0)
    283289     *
    284      * @param  int $thread_id The thread ID
     290     * @param  int $thread_id The thread ID.
     291     *
    285292     * @return array
    286293     */
     
    298305     * @since BuddyPress (1.0.0)
    299306     *
    300      * @param int $thread_id The message thread ID
     307     * @param int $thread_id The message thread ID.
     308     *
    301309     * @return bool
    302310     */
     
    353361                 * @since BuddyPress (1.0.0)
    354362                 *
    355                  * @param int $message_id ID of the message
     363                 * @param int $message_id ID of the message.
    356364                 */
    357365                do_action( 'messages_thread_deleted_thread', $message_id );
     
    363371
    364372        /**
    365          * Fires after a message thread is either marked as deleted or deleted
     373         * Fires after a message thread is either marked as deleted or deleted.
    366374         *
    367375         * @since BuddyPress (2.2.0)
     
    521529     *
    522530     * @param array $meta_query An array of meta_query filters. See the
    523      *   documentation for WP_Meta_Query for details.
     531     *                          documentation for WP_Meta_Query for details.
     532     *
    524533     * @return array $sql_array 'join' and 'where' clauses.
    525534     */
     
    587596     *
    588597     * @param int    $user_id The user ID.
    589      * @param string $box  The type of mailbox to get. Either 'inbox' or 'sentbox'.
    590      *                     Defaults to 'inbox'.
    591      * @param string $type The type of messages to get. Either 'all' or 'unread'
    592      *                     or 'read'. Defaults to 'all'.
     598     * @param string $box     The type of mailbox to get. Either 'inbox' or 'sentbox'.
     599     *                        Defaults to 'inbox'.
     600     * @param string $type    The type of messages to get. Either 'all' or 'unread'.
     601     *                        or 'read'. Defaults to 'all'.
    593602     * @return int
    594603     */
     
    616625     *
    617626     * @param int $thread_id The message thread ID.
     627     *
    618628     * @return bool
    619629     */
     
    638648     *
    639649     * @param int $thread_id The message thread ID.
     650     *
    640651     * @return string|bool The user link on success. Boolean false on failure.
    641652     */
     
    658669     *
    659670     * @param int $user_id The user ID.
     671     *
    660672     * @return int
    661673     */
     
    694706     *
    695707     * @param int $thread_id The message thread ID.
    696      * @param int $user_id The user ID.
    697      * @return int|null The recorded recipient ID on success, null on failure
     708     * @param int $user_id   The user ID.
     709     *
     710     * @return int|null The recorded recipient ID on success, null on failure.
    698711     */
    699712    public static function check_access( $thread_id, $user_id = 0 ) {
     
    717730     *
    718731     * @param int $thread_id The message thread ID.
    719      * @return int|null The message thread ID on success, null on failure
     732     *
     733     * @return int|null The message thread ID on success, null on failure.
    720734     */
    721735    public static function is_valid( $thread_id = 0 ) {
     
    745759     *
    746760     * @param array $recipients Array containing the message recipients (array of objects).
     761     *
    747762     * @return string
    748763     */
Note: See TracChangeset for help on using the changeset viewer.