acf_delete_metadata_by_field() │ ACF 6.4

Deletes metadata from the database.

Returns

true|false.

Usage

acf_delete_metadata_by_field( $post_id, $field, $hidden );

$post_id(int|string)

The post id.

$field(array)

The field array.
Default: array()

$hidden(true|false)

True if we should update the reference key.
Default: false

Changelog

acf_delete_metadata_by_field() acf delete metadata by field code ^{ACF 6.8.8}

function acf_delete_metadata_by_field( $post_id = 0, $field = array(), bool $hidden = false ) {
	if ( empty( $field['name'] ) ) {
		return null;
	}

	// Allow filter to short-circuit logic.
	$pre = apply_filters( 'acf/pre_delete_metadata', null, $post_id, $field['name'], $hidden );
	if ( $pre !== null ) {
		return $pre;
	}

	// Decode the $post_id for $type and $id.
	$decoded = acf_decode_post_id( $post_id );
	$id      = $decoded['id'];
	$type    = $decoded['type'];

	// Bail early if no $id (possible during new acf_form).
	if ( ! $id ) {
		return false;
	}

	$meta_instance = acf_get_meta_instance( $type );

	if ( ! $meta_instance ) {
		return false;
	}

	if ( $hidden ) {
		return $meta_instance->delete_reference( $id, $field['name'] );
	}

	return $meta_instance->delete_value( $id, $field );
}