WP_REST_Meta_Fields::delete_meta_value() │ protected │ WP 4.7.0

Deletes a meta value for an object.

Method of the class: WP_REST_Meta_Fields{}

No Hooks.

Return

true|WP_Error. True if meta field is deleted, WP_Error otherwise.

Usage

// protected - for code of main (parent) or child class
$result = $this->delete_meta_value( $object_id, $meta_key, $name );

$object_id(int) (required)

Object ID the field belongs to.

$meta_key(string) (required)

Key for the field.

$name(string) (required)

Name for the field that is exposed in the REST API.

Changelog

WP_REST_Meta_Fields::delete_meta_value() WP REST Meta Fields::delete meta value code ^{WP 6.1.1}

protected function delete_meta_value( $object_id, $meta_key, $name ) {
	$meta_type = $this->get_meta_type();

	if ( ! current_user_can( "delete_{$meta_type}_meta", $object_id, $meta_key ) ) {
		return new WP_Error(
			'rest_cannot_delete',
			/* translators: %s: Custom field key. */
			sprintf( __( 'Sorry, you are not allowed to edit the %s custom field.' ), $name ),
			array(
				'key'    => $name,
				'status' => rest_authorization_required_code(),
			)
		);
	}

	if ( null === get_metadata_raw( $meta_type, $object_id, wp_slash( $meta_key ) ) ) {
		return true;
	}

	if ( ! delete_metadata( $meta_type, $object_id, wp_slash( $meta_key ) ) ) {
		return new WP_Error(
			'rest_meta_database_error',
			__( 'Could not delete meta value from database.' ),
			array(
				'key'    => $name,
				'status' => WP_Http::INTERNAL_SERVER_ERROR,
			)
		);
	}

	return true;
}