ata = []; // phpcs:disable WooCommerce.Commenting.CommentHooks.MissingSinceComment /** * Allows to check if WP_DEBUG mode is enabled before returning previous Exception. * * @param bool The WP_DEBUG mode. */ if ( apply_filters( 'woocommerce_return_previous_exceptions', Constants::is_true( 'WP_DEBUG' ) ) && $e->getPrevious() ) { $additional_data = [ 'previous' => get_class( $e->getPrevious() ), ]; } throw new RouteException( 'woocommerce_rest_checkout_process_payment_error', esc_html( $e->getMessage() ), 400, array_map( 'esc_attr', $additional_data ) ); } } /** * Gets the chosen payment method ID from the request. * * @throws RouteException On error. * @param \WP_REST_Request $request Request object. * @return string */ private function get_request_payment_method_id( \WP_REST_Request $request ) { $payment_method = $this->get_request_payment_method( $request ); return is_null( $payment_method ) ? '' : $payment_method->id; } /** * Gets and formats payment request data. * * @param \WP_REST_Request $request Request object. * @return array */ private function get_request_payment_data( \WP_REST_Request $request ) { static $payment_data = []; if ( ! empty( $payment_data ) ) { return $payment_data; } if ( ! empty( $request['payment_data'] ) ) { foreach ( $request['payment_data'] as $data ) { $payment_data[ sanitize_key( $data['key'] ) ] = wc_clean( $data['value'] ); } } return $payment_data; } /** * Update the current order using the posted values from the request. * * Called only with a real, persisted order — either the place-order POST flow or * the rare failed-payment PATCH retry flow where `get_draft_order()` resolved to * an existing `pending`/`failed` order from the customer's session. Fresh-session * PATCHes never call this method; they go through the no-order draft path. * * @param \WP_REST_Request $request Full details about the request. * @param bool $persist Whether to persist the changes right away (defaults to true). * @throws RouteException If the order is missing, or if the order requires a payment method on POST and none was supplied. */ private function update_order_from_request( \WP_REST_Request $request, bool $persist = true ) { $order = $this->get_order_or_throw(); $order->set_customer_note( wc_sanitize_textarea( $request['customer_note'] ) ?? '' ); $payment_method = $this->get_request_payment_method( $request ); if ( null !== $payment_method ) { WC()->session->set( 'chosen_payment_method', $payment_method->id ); $order->set_payment_method( $payment_method->id ); $order->set_payment_method_title( $payment_method->title ); } else { $order_needs_payment = $order->needs_payment(); if ( $order_needs_payment && 'POST' === $request->get_method() ) { throw new RouteException( 'woocommerce_rest_checkout_missing_payment_method', esc_html__( 'No payment method provided.', 'woocommerce' ), 400 ); } if ( ! $order_needs_payment ) { $order->set_payment_method( '' ); } } wc_log_order_step( '[Store API #5::update_order_from_request] Set customer note and payment method', array( 'order_id' => $order->get_id(), 'payment' => $order->get_payment_method_title(), ) ); $this->persist_additional_fields_for_order( $request ); wc_log_order_step( '[Store API #5::update_order_from_request] Persisted additional fields', array( 'order_id' => $order->get_id(), 'payment' => $order->get_payment_method_title(), ) ); wc_do_deprecated_action( '__experimental_woocommerce_blocks_checkout_update_order_from_request', array( $order, $request, ), '6.3.0', 'woocommerce_store_api_checkout_update_order_from_request', 'This action was deprecated in WooCommerce Blocks version 6.3.0. Please use woocommerce_store_api_checkout_update_order_from_request instead.' ); wc_do_deprecated_action( 'woocommerce_blocks_checkout_update_order_from_request', array( $order, $request, ), '7.2.0', 'woocommerce_store_api_checkout_update_order_from_request', 'This action was deprecated in WooCommerce Blocks version 7.2.0. Please use woocommerce_store_api_checkout_update_order_from_request instead.' ); /** * Fires when the Checkout Block/Store API updates an order's from the API request data. * * This hook gives extensions the chance to update orders based on the data in the request. This can be used in * conjunction with the ExtendSchema class to post custom data and then process it. * * @since 7.2.0 * * @param \WC_Order $order Order object. * @param \WP_REST_Request $request Full details about the request. */ do_action( 'woocommerce_store_api_checkout_update_order_from_request', $order, $request ); if ( $persist ) { $order->save(); } } /** * Gets the chosen payment method title from the request. * * @throws RouteException On error. * @param \WP_REST_Request $request Request object. * @return string */ private function get_request_payment_method_title( \WP_REST_Request $request ) { $payment_method = $this->get_request_payment_method( $request ); return is_null( $payment_method ) ? '' : $payment_method->get_title(); } /** * Persist additional fields for the order after validating them. * * @throws RouteException If the order is missing. * * @param \WP_REST_Request $request Full details about the request. */ private function persist_additional_fields_for_order( \WP_REST_Request $request ) { // Local alias so the closure and downstream calls keep a non-null `WC_Order`. $order = $this->get_order_or_throw(); $this->resolve_and_persist_additional_fields( $request, function ( string $key, $value ) use ( $order ) { $this->additional_fields_controller->persist_field_for_order( $key, $value, $order, 'other', false ); } ); if ( 0 !== $order->get_customer_id() && get_current_user_id() === $order->get_customer_id() ) { $this->additional_fields_controller->sync_customer_additional_fields_with_order( $order, wc()->customer ); } } /** * Persist additional fields for the customer session. * * Counterpart to `persist_additional_fields_for_order` for routes that operate * without a persisted order (e.g. the deferred-draft PATCH path). * * @phpstan-param \WP_REST_Request> $request * * @param \WP_REST_Request $request Full details about the request. */ private function persist_additional_fields_for_customer( \WP_REST_Request $request ): void { $customer = wc()->customer; $this->resolve_and_persist_additional_fields( $request, function ( string $key, $value ) use ( $customer ) { $this->additional_fields_controller->persist_field_for_customer( $key, $value, $customer, 'other' ); } ); $customer->save(); } /** * Resolve the additional checkout fields from the request and persist each one * via the supplied callback. Fields hidden by conditional logic that were still * posted are cleared (passed with an empty value). * * @phpstan-param \WP_REST_Request> $request * * @param \WP_REST_Request $request Full details about the request. * @param callable $persist Callback invoked as `$persist( string $key, mixed $value )` for each field. */ private function resolve_and_persist_additional_fields( \WP_REST_Request $request, callable $persist ): void { if ( Features::is_enabled( 'experimental-blocks' ) ) { $document_object = $this->get_document_object_from_rest_request( $request ); $document_object->set_context( 'order' ); $additional_fields = array_merge( $this->additional_fields_controller->get_contextual_fields_for_location( 'order', $document_object ), $this->additional_fields_controller->get_contextual_fields_for_location( 'contact', $document_object ) ); } else { $additional_fields = array_merge( $this->additional_fields_controller->get_fields_for_location( 'order' ), $this->additional_fields_controller->get_fields_for_location( 'contact' ) ); } $field_values = isset( $request['additional_fields'] ) ? (array) $request['additional_fields'] : array(); foreach ( $additional_fields as $key => $field ) { if ( isset( $field_values[ $key ] ) ) { $persist( $key, $field_values[ $key ] ); } } $hidden_posted_field_values = array_diff_key( $field_values, $additional_fields ); foreach ( $hidden_posted_field_values as $key => $value ) { if ( $this->additional_fields_controller->is_field( $key ) ) { $persist( $key, '' ); } } } /** * Returns a document object from a REST request. * * @param \WP_REST_Request $request The REST request. * @return DocumentObject The document object or null if experimental blocks are not enabled. */ public function get_document_object_from_rest_request( \WP_REST_Request $request ) { return new DocumentObject( [ 'customer' => [ 'billing_address' => $request['billing_address'], 'shipping_address' => $request['shipping_address'], 'additional_fields' => array_intersect_key( $request['additional_fields'] ?? [], array_flip( $this->additional_fields_controller->get_contact_fields_keys() ) ), ], 'checkout' => [ 'payment_method' => $request['payment_method'], 'create_account' => $request['create_account'], 'customer_note' => $request['customer_note'], 'additional_fields' => array_intersect_key( $request['additional_fields'] ?? [], array_flip( $this->additional_fields_controller->get_order_fields_keys() ) ), ], ] ); } }