Changeset 11308 for trunk/src/bp-messages/bp-messages-functions.php

Timestamp:

12/19/2016 10:36:43 PM (8 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:

• trunk/src/bp-messages/bp-messages-functions.php (modified) (2 diffs)

trunk/src/bp-messages/bp-messages-functions.php

@@ -442 +442 @@
  * @see delete_metadata() for full documentation excluding $meta_type variable.
  *
- * @param int         $message_id ID of the message to have meta deleted for.
- * @param string|bool $meta_key   Meta key to delete. Default false.
+ * @param int $message_id ID of the message to have meta deleted for.
+ * @param string|bool $meta_key Meta key to delete. Default false.
  * @param string|bool $meta_value Meta value to delete. Default false.
- * @param bool        $delete_all Whether or not to delete all meta data.
- * @return bool
+ * @param bool $delete_all Whether or not to delete all meta data.
+ *
+ * @return bool True on successful delete, false on failure.
  */
 function bp_messages_delete_meta( $message_id, $meta_key = false, $meta_value = false, $delete_all = false ) {
@@ -461 +462 @@
     }
 
+    $retval = false;
+
     // No keys, so stop now!
     if ( empty( $keys ) ) {
-        return false;
+        return $retval;
     }