bp_activity_delete_meta( int $activity_id, string $meta_key = '', string $meta_value = '', bool $delete_all = false )

Delete a meta entry from the DB for an activity feed item.

Description

Parameters

$activity_id

(Required) ID of the activity item whose metadata is being deleted.

$meta_key

(Optional) The key of the metadata being deleted. If omitted, all metadata associated with the activity item will be deleted.

Default value: ''

$meta_value

(Optional) If present, the metadata will only be deleted if the meta_value matches this parameter.

Default value: ''

$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.

Default value: false

Return

(bool) True on success, false on failure.

Source

File: bp-activity/bp-activity-functions.php

function bp_activity_delete_meta( $activity_id, $meta_key = '', $meta_value = '', $delete_all = false ) {
 
    // Legacy - if no meta_key is passed, delete all for the item.
    if ( empty( $meta_key ) ) {
        $all_meta = bp_activity_get_meta( $activity_id );
        $keys     = ! empty( $all_meta ) ? array_keys( $all_meta ) : array();
 
        // With no meta_key, ignore $delete_all.
        $delete_all = false;
    } else {
        $keys = array( $meta_key );
    }
 
    $retval = true;
 
    add_filter( 'query', 'bp_filter_metaid_column_name' );
    foreach ( $keys as $key ) {
        $retval = delete_metadata( 'activity', $activity_id, $key, $meta_value, $delete_all );
    }
    remove_filter( 'query', 'bp_filter_metaid_column_name' );
 
    return $retval;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 1.2.0	Introduced.

Uses

Uses
Uses	Description
bp-activity/bp-activity-functions.php: bp_activity_get_meta()	Get metadata for a given activity item.

Used By
Used By	Description
bp-document/classes/class-bp-rest-document-endpoint.php: BP_REST_Document_Endpoint::bp_documents_update_rest_field_callback()	The function to use to update the document’s value of the activity REST Field.
bp-document/bp-document-filters.php: bp_document_update_activity_document_meta()	Update document for activity.
bp-media/bp-media-filters.php: bp_media_update_activity_media_meta()	Update media for activity
bp-media/classes/class-bp-rest-media-endpoint.php: BP_REST_Media_Endpoint::bp_media_ids_update_rest_field_callback()	The function to use to update the medias’s value of the activity REST Field.
bp-media/classes/class-bp-rest-media-endpoint.php: BP_REST_Media_Endpoint::bp_gif_data_update_rest_field_callback()	The function to use to update the Gif data’s value of the activity REST Field.
bp-media/bp-media-filters.php: bp_media_activity_save_gif_data()	Save gif data into activity meta key “_gif_attachment_id”
bp-blogs/bp-blogs-functions.php: bp_blogs_update_post_activity_meta()	Updates a blog post’s activity meta entry during a post edit.
bp-activity/classes/class-bp-activity-activity.php: BP_Activity_Activity::delete_activity_meta_entries()	Delete the meta entries associated with a set of activity items.
bp-activity/bp-activity-akismet.php: bp_activity_akismet_delete_old_metadata()	Delete old spam activity meta data.

Show 4 more used by Hide more used by

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.

Contents