Contents

Code Reference Functions bp_delete_user_meta()

bp_delete_user_meta( int $user_id, string $key, mixed $value = '' )

Delete a piece of usermeta.

Description

This is a wrapper for delete_user_meta() that allows for easy use of bp_get_user_meta_key(), thereby increasing compatibility with non-standard BP setups.

See also

Parameters

$user_id

(Required) The ID of the user whose meta you're deleting.

$key

(Required) The meta key to delete.

$value

(Optional) Metadata value.

Default value: ''

Return

(bool) False for failure. True for success.

Source

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

function bp_delete_user_meta( $user_id, $key, $value = '' ) {
	return delete_user_meta( $user_id, bp_get_user_meta_key( $key ), $value );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyPress 1.5.0 Introduced.

Uses

Uses
Uses Description
bp-core/bp-core-functions.php: bp_get_user_meta_key()

Get the meta_key for a given piece of user metadata
Used By
Used By Description
bp-xprofile/bp-xprofile-functions.php: bp_xprofile_reset_cover_image_position()

Reset cover image position while uploading/deleting profile cover photo.
bp-settings/classes/class-bp-rest-account-settings-options-endpoint.php: BP_REST_Account_Settings_Options_Endpoint::update_invites_fields()

Update Invites fields “Group Invites”.
bp-settings/actions/general.php: bp_settings_verify_email_change()

Process email change verification or cancel requests.
bp-members/bp-members-functions.php: bp_core_activate_signup()

Activate a signup, as identified by an activation key.
bp-friends/bp-friends-functions.php: friends_remove_data()

Remove all friends-related data concerning a given user.
bp-templates/bp-nouveau/includes/groups/functions.php: bp_nouveau_groups_screen_invites_restriction()

Group invites restriction screen.
bp-core/bp-core-filters.php: bp_dd_delete_avatar()

Delete avatar of group and user
bp-core/bp-core-filters.php: bp_dd_delete_xprofile_cover_images_url()

Delete the user cover photo attachment
bp-core/gdpr/class-bp-settings-export.php: BP_Settings_Export::process_erase()

Delete user profile settings.
bp-activity/bp-activity-functions.php: bp_activity_delete()

Delete activity item(s).
bp-activity/bp-activity-functions.php: bp_activity_remove_all_user_data()

Completely remove a user’s activity data.
bp-activity/bp-activity-functions.php: bp_activity_clear_new_mentions()

Reset a user’s unread mentions list and count.
bp-activity/classes/class-bp-akismet.php: BP_Akismet::check_member_activity_update()

Clean up the bp_latest_update usermeta in case of spamming.
Show 8 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.