BBP_User_Engagements_Meta::remove_user_from_all_objects( int $user_id, string $meta_key = '', string $meta_type = 'post' )
Remove a user id from all objects
Description Description
Parameters Parameters
- $user_id
-
(Required) The user id
- $meta_key
-
(Optional) The relationship key
Default value: ''
- $meta_type
-
(Optional) The relationship type (usually 'post')
Default value: 'post'
Return Return
(bool) Returns true on success, false on failure
Source Source
File: includes/common/engagements.php
public function remove_user_from_all_objects( $user_id = 0, $meta_key = '', $meta_type = 'post' ) {
return delete_metadata( $meta_type, null, $meta_key, $user_id, true );
}
Changelog Changelog
| Version | Description |
|---|---|
| 2.6.0 | Introduced. |