Skip to:
Content

BuddyPress.org

Changeset 11308


Ignore:
Timestamp:
12/19/2016 10:36:43 PM (7 years ago)
Author:
slaffik
Message:

Messages: improved code comments for bp_messages_delete_meta()

Spaces, new lines etc, according to WordPress standards. Always define a retval variable as false.

See #5193.

File:
1 edited

Legend:

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

    r11153 r11308  
    442442 * @see delete_metadata() for full documentation excluding $meta_type variable.
    443443 *
    444  * @param int         $message_id ID of the message to have meta deleted for.
    445  * @param string|bool $meta_key   Meta key to delete. Default false.
     444 * @param int $message_id ID of the message to have meta deleted for.
     445 * @param string|bool $meta_key Meta key to delete. Default false.
    446446 * @param string|bool $meta_value Meta value to delete. Default false.
    447  * @param bool        $delete_all Whether or not to delete all meta data.
    448  * @return bool
     447 * @param bool $delete_all Whether or not to delete all meta data.
     448 *
     449 * @return bool True on successful delete, false on failure.
    449450 */
    450451function bp_messages_delete_meta( $message_id, $meta_key = false, $meta_value = false, $delete_all = false ) {
     
    461462    }
    462463
     464    $retval = false;
     465
    463466    // No keys, so stop now!
    464467    if ( empty( $keys ) ) {
    465         return false;
     468        return $retval;
    466469    }
    467470
Note: See TracChangeset for help on using the changeset viewer.