Changeset 8132 for trunk/bp-xprofile/bp-xprofile-functions.php

Timestamp:

03/14/2014 12:50:26 AM (11 years ago)

Author:

boonebgorges

Message:

In update_meta() functions, return integer value if a new metadata is created

Previously, BP update_meta() functions returned true on a successful update
*or* on the successful creation of new metadata. This is not consistent with
WP's update_metadata(), which on the creation of new metadata acts as a wrapper
for add_metadata(), which in turn returns an integer (the ID of the newly
created database row).

This changeset aligns BP's behavior with WP's.

We don't have any tests that directly address the data type returned by these
functions, but we do have a number of assertTrue assertions to verify the
setup of various tests. Where appropriate, these have been changed to the more
generous assertNotEmpty.

See #5399

File:

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

trunk/bp-xprofile/bp-xprofile-functions.php

@@ -665 +665 @@
  *        metadata entries with the specified value. Otherwise, update all
  *        entries.
- * @return bool True on success, false on failure.
+ * @return bool|int Returns false on failure. On successful update of existing
+ *         metadata, returns true. On successful creation of new metadata,
+ *         returns the integer ID of the new metadata row.
  */
 function bp_xprofile_update_meta( $object_id, $object_type, $meta_key, $meta_value, $prev_value = '' ) {
@@ -674 +676 @@
     remove_filter( 'query', 'bp_xprofile_filter_meta_query' );
     remove_filter( 'query', 'bp_filter_metaid_column_name' );
-
-    // Legacy - if we fall through to add_metadata(), return true rather
-    // than the integer meta_id
-    if ( is_int( $retval ) ) {
-        $retval = (bool) $retval;
-    }
 
     return $retval;