xprofile_delete_field_data( string $field = '', int $user_id )

Delete XProfile field data.

Description

Parameters

$field

(Optional) Field to delete.

Default value: ''

$user_id

(Required) User ID to delete field from.

Return

(bool) Whether or not the field was deleted.

Source

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

function xprofile_delete_field_data( $field = '', $user_id = 0 ) {

	// Get the field ID.
	if ( is_numeric( $field ) ) {
		$field_id = (int) $field;
	} else {
		$field_id = xprofile_get_field_id_from_name( $field );
	}

	// Bail if field or user ID are empty.
	if ( empty( $field_id ) || empty( $user_id ) ) {
		return false;
	}

	// Get the profile field data to delete.
	$field = new BP_XProfile_ProfileData( $field_id, $user_id );

	// Delete the field data.
	return $field->delete();
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 1.1.0	Introduced.

Uses

Uses
Uses	Description
bp-xprofile/bp-xprofile-functions.php: xprofile_get_field_id_from_name()	Returns the ID for the field based on the field name.
bp-xprofile/classes/class-bp-xprofile-profiledata.php: BP_XProfile_ProfileData::__construct()	BP_XProfile_ProfileData constructor.

Used By
Used By	Description
bp-xprofile/classes/class-bp-rest-xprofile-repeater-endpoint.php: BP_REST_XProfile_Repeater_Endpoint::bp_profile_repeaters_update_field_data()	Update Field data with delete.
bp-xprofile/bp-xprofile-functions.php: xprofile_set_field_data()	A simple function to set profile data for a specific field for a specific user.
bp-xprofile/screens/edit.php: xprofile_screen_edit_profile()	Handles the display of the profile edit page by loading the correct template file.
bp-xprofile/bp-xprofile-repeaters.php: bp_profile_repeaters_update_field_data()	Update/Sort repeater fields when profile data is updated.

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