Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
03/14/2014 12:50:26 AM (10 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:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/bp-xprofile/bp-xprofile-functions.php

    r8130 r8132  
    665665 *        metadata entries with the specified value. Otherwise, update all
    666666 *        entries.
    667  * @return bool True on success, false on failure.
     667 * @return bool|int Returns false on failure. On successful update of existing
     668 *         metadata, returns true. On successful creation of new metadata,
     669 *         returns the integer ID of the new metadata row.
    668670 */
    669671function bp_xprofile_update_meta( $object_id, $object_type, $meta_key, $meta_value, $prev_value = '' ) {
     
    674676    remove_filter( 'query', 'bp_xprofile_filter_meta_query' );
    675677    remove_filter( 'query', 'bp_filter_metaid_column_name' );
    676 
    677     // Legacy - if we fall through to add_metadata(), return true rather
    678     // than the integer meta_id
    679     if ( is_int( $retval ) ) {
    680         $retval = (bool) $retval;
    681     }
    682678
    683679    return $retval;
Note: See TracChangeset for help on using the changeset viewer.