Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
08/26/2021 12:53:27 AM (3 years ago)
Author:
espellcaste
Message:

Making PHPDoc Improvements to the BP Messages (component) files.

Also, adding several minor PHP changes.

See #8553

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/bp-messages/classes/class-bp-messages-message.php

    r11307 r13096  
    1515 */
    1616class BP_Messages_Message {
     17
    1718    /**
    1819     * ID of the message.
    … …  
    8081    /**
    8182     * Set up data related to a specific message object.
     83     *
     84     * @global BuddyPress $bp The one true BuddyPress instance.
     85     * @global wpdb $wpdb WordPress database object.
    8286     *
    8387     * @param int $id ID of the message.
    … …  
    101105     * Send a message.
    102106     *
     107     * @global BuddyPress $bp The one true BuddyPress instance.
     108     * @global wpdb $wpdb WordPress database object.
     109     *
    103110     * @return int|bool ID of the newly created message on success, false on failure.
    104111     */
    … …  
    180187     * Get a list of recipients for a message.
    181188     *
     189     * @global BuddyPress $bp The one true BuddyPress instance.
     190     * @global wpdb $wpdb WordPress database object.
     191     *
    182192     * @return object $value List of recipients for a message.
    183193     */
    … …  
    221231         * @since 2.8.0
    222232         *
    223          * @param array $recipient_ids Array of recipients IDs that were retrieved based on submitted usernames.
     233         * @param array $recipient_ids       Array of recipients IDs that were retrieved based on submitted usernames.
    224234         * @param array $recipient_usernames Array of recipients usernames that were submitted by a user.
    225235         */
    … …  
    230240     * Get the ID of the message last sent by the logged-in user for a given thread.
    231241     *
     242     * @global BuddyPress $bp The one true BuddyPress instance.
     243     * @global wpdb $wpdb WordPress database object.
     244     *
    232245     * @param int $thread_id ID of the thread.
    233246     *
    … …  
    246259    /**
    247260     * Check whether a user is the sender of a message.
     261     *
     262     * @global BuddyPress $bp The one true BuddyPress instance.
     263     * @global wpdb $wpdb WordPress database object.
    248264     *
    249265     * @param int $user_id ID of the user.
    … …  
    266282     * Get the ID of the sender of a message.
    267283     *
     284     * @global BuddyPress $bp The one true BuddyPress instance.
     285     * @global wpdb $wpdb WordPress database object.
     286     *
    268287     * @param int $message_id ID of the message.
    269288     *
Note: See TracChangeset for help on using the changeset viewer.