Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
05/12/2015 04:39:07 AM (10 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-message.php

    r9819 r9862  
    101101     *
    102102     * @return int|bool ID of the newly created message on success, false
    103      *         on failure.
     103     *                  on failure.
    104104     */
    105105    public function send() {
    … …  
    121121         * @since BuddyPress (1.0.0)
    122122         *
    123          * @param BP_Messages_Message Current instance of the message item being saved. Passed by reference.
     123         * @param BP_Messages_Message $this Current instance of the message item being saved. Passed by reference.
    124124         */
    125125        do_action_ref_array( 'messages_message_before_save', array( &$this ) );
    … …  
    167167         * @since BuddyPress (1.0.0)
    168168         *
    169          * @param BP_Messages_Message Current instance of the message item being saved. Passed by reference.
     169         * @param BP_Messages_Message $this Current instance of the message item being saved. Passed by reference.
    170170         */
    171171        do_action_ref_array( 'messages_message_after_save', array( &$this ) );
    … …  
    193193     *
    194194     * @param array $recipient_usernames Usernames of recipients.
     195     *
    195196     * @return array
    196197     */
    … …  
    214215     *
    215216     * @param int $thread_id ID of the thread.
     217     *
    216218     * @return int|null ID of the message if found, otherwise null.
    217219     */
    … …  
    227229     * Check whether a user is the sender of a message.
    228230     *
    229      * @param int $user_id ID of the user.
     231     * @param int $user_id    ID of the user.
    230232     * @param int $message_id ID of the message.
     233     *
    231234     * @return int|null Returns the ID of the message if the user is the
    232      *         sender, otherwise null.
     235     *                  sender, otherwise null.
    233236     */
    234237    public static function is_user_sender( $user_id, $message_id ) {
    … …  
    244247     *
    245248     * @param int $message_id ID of the message.
     249     *
    246250     * @return int|null The ID of the sender if found, otherwise null.
    247251     */
Note: See TracChangeset for help on using the changeset viewer.