Changeset 7883 for trunk/bp-activity/bp-activity-functions.php

Timestamp:

02/14/2014 07:02:16 PM (11 years ago)

Author:

boonebgorges

Message:

Add delete_all support for all _delete_meta() functions

The delete_all parameter allows you to delete all meta items matching the
specified meta_key, regardless of the associated object.

Because our meta delete functions also support the deletion of all metadata
associated with an object (by leaving out the meta_key param), a decision had
to be made regarding the behavior when _delete_meta() is called with delete_all

true and meta_key = false. The most logical (and least destructive) strategy

was deemed to be: force delete_all to false when meta_key is also false. This
ensures that you don't accidentally wipe out all metadata for a component.

See #5400

File:

• trunk/bp-activity/bp-activity-functions.php (modified) (3 diffs)

trunk/bp-activity/bp-activity-functions.php

@@ -539 +539 @@
  * Delete a meta entry from the DB for an activity stream item.
  *
- * @since BuddyPress (1.2)
+ * @since BuddyPress (1.2.0)
  *
  * @global object $wpdb WordPress database access object.
  * @global object $bp BuddyPress global settings.
- * @uses wp_cache_delete()
- * @uses is_wp_error()
  *
  * @param int $activity_id ID of the activity item whose metadata is being deleted.
  * @param string $meta_key Optional. The key of the metadata being deleted. If
- *                         omitted, all metadata associated with the activity
- *                         item will be deleted.
+ *        omitted, all metadata associated with the activity
+ *        item will be deleted.
  * @param string $meta_value Optional. If present, the metadata will only be
- *                           deleted if the meta_value matches this parameter.
+ *        deleted if the meta_value matches this parameter.
+ * @param bool $delete_all Optional. If true, delete matching metadata entries
+ *    for all objects, ignoring the specified object_id. Otherwise,
+ *    only delete matching metadata entries for the specified
+ *    activity item. Default: false.
  * @return bool True on success, false on failure.
  */
-function bp_activity_delete_meta( $activity_id, $meta_key = '', $meta_value = '' ) {
+function bp_activity_delete_meta( $activity_id, $meta_key = '', $meta_value = '', $delete_all = false ) {
     global $wpdb, $bp;
 
@@ -572 +574 @@
         $all_meta = bp_activity_get_meta( $activity_id );
         $keys     = ! empty( $all_meta ) ? wp_list_pluck( $all_meta, 'meta_key' ) : array();
+
+        // With no meta_key, ignore $delete_all
+        $delete_all = false;
     } else {
         $keys = array( $meta_key );
@@ -578 +583 @@
     add_filter( 'query', 'bp_filter_metaid_column_name' );
     foreach ( $keys as $key ) {
-        $retval = delete_metadata( 'activity', $activity_id, $key, $meta_value );
+        $retval = delete_metadata( 'activity', $activity_id, $key, $meta_value, $delete_all );
     }
     remove_filter( 'query', 'bp_filter_metaid_column_name' );