Automattic\WooCommerce\Internal\Fulfillments

OrderFulfillmentsRestController::delete_fulfillment_metapublicWC 1.0

Delete the metadata for a specific fulfillment.

Method of the class: OrderFulfillmentsRestController{}

No Hooks.

Returns

WP_REST_Response. The deleted metadata for the fulfillment, or an error if the request fails.

Usage

$OrderFulfillmentsRestController = new OrderFulfillmentsRestController();
$OrderFulfillmentsRestController->delete_fulfillment_meta( $request );
$request(WP_REST_Request) (required)
The request object.

OrderFulfillmentsRestController::delete_fulfillment_meta() code WC 10.3.3

public function delete_fulfillment_meta( WP_REST_Request $request ) {
	$order_id       = (int) $request->get_param( 'order_id' );
	$fulfillment_id = (int) $request->get_param( 'fulfillment_id' );

	// Delete the metadata for the fulfillment.
	try {
		$fulfillment = new Fulfillment( $fulfillment_id );
		$this->validate_fulfillment( $fulfillment, $fulfillment_id, $order_id );

		$meta_key = sanitize_text_field( wp_unslash( (string) $request->get_param( 'meta_key' ) ) );
		$fulfillment->delete_meta_data( $meta_key );
		$fulfillment->save();
	} catch ( ApiException $ex ) {
		return $this->prepare_error_response(
			$ex->getErrorCode(),
			$ex->getMessage(),
			WP_Http::BAD_REQUEST
		);
	} catch ( \Exception $e ) {
		return $this->prepare_error_response(
			$e->getCode(),
			$e->getMessage(),
			WP_Http::BAD_REQUEST
		);
	}

	return new WP_REST_Response(
		$fulfillment->get_raw_meta_data(),
		WP_Http::OK
	);
}