friends_delete_activity( array $args )
Delete an activity item related to the Friends component.
Description Description
Parameters Parameters
- $args
-
(Required) An array of arguments for the item to delete.
- 'item_id'
(int) ID of the 'item' associated with the activity item. For Friends activity items, this is usually the user ID of one of the friends. - 'type'
(string) The 'type' of the activity item (eg 'friendship_accepted'). - 'user_id'
(int) ID of the user associated with the activity item.
- 'item_id'
Return Return
(bool) True on success, false on failure.
Source Source
File: bp-friends/bp-friends-activity.php
function friends_delete_activity( $args ) {
if ( ! bp_is_active( 'activity' ) ) {
return;
}
bp_activity_delete_by_item_id( array(
'component' => buddypress()->friends->id,
'item_id' => $args['item_id'],
'type' => $args['type'],
'user_id' => $args['user_id']
) );
}
Changelog Changelog
| Version | Description |
|---|---|
| 1.0.0 | Introduced. |