Automattic\WooCommerce\StoreApi\Routes\V1
CartSelectShippingRate::get_route_post_response
Handle the request and return a valid response for this endpoint.
Method of the class: CartSelectShippingRate{}
Hooks from the method
Returns
\WP_REST_Response.
Usage
// protected - for code of main (parent) or child class $result = $this->get_route_post_response( $request );
- $request(WP_REST_Request) (required)
- Request object.
CartSelectShippingRate::get_route_post_response() CartSelectShippingRate::get route post response code WC 10.7.0
protected function get_route_post_response( \WP_REST_Request $request ) {
if ( ! wc_shipping_enabled() ) {
throw new RouteException( 'woocommerce_rest_shipping_disabled', esc_html__( 'Shipping is disabled.', 'woocommerce' ), 404 );
}
if ( ! isset( $request['rate_id'] ) ) {
throw new RouteException( 'woocommerce_rest_cart_missing_rate_id', esc_html__( 'Invalid Rate ID.', 'woocommerce' ), 400 );
}
$cart = $this->cart_controller->get_cart_instance();
$package_id = isset( $request['package_id'] ) ? sanitize_text_field( wp_unslash( $request['package_id'] ) ) : null;
$rate_id = sanitize_text_field( wp_unslash( $request['rate_id'] ) );
try {
if ( ! is_null( $package_id ) ) {
$this->cart_controller->select_shipping_rate( $package_id, $rate_id );
} else {
foreach ( $this->cart_controller->get_shipping_packages() as $package ) {
$this->cart_controller->select_shipping_rate( $package['package_id'], $rate_id );
}
}
} catch ( \WC_Rest_Exception $e ) {
throw new RouteException( $e->getErrorCode(), $e->getMessage(), $e->getCode() ); // phpcs:ignore WordPress.Security.EscapeOutput.ExceptionNotEscaped
}
/**
* Fires an action after a shipping method has been chosen for package(s) via the Store API.
*
* This allows extensions to perform addition actions after a shipping method has been chosen, but before the
* cart totals are recalculated.
*
* @since 9.0.0
*
* @param string|null $package_id The sanitized ID of the package being updated. Null if all packages are being updated.
* @param string $rate_id The sanitized chosen rate ID for the package.
* @param \WP_REST_Request $request Full details about the request.
*/
do_action( 'woocommerce_store_api_cart_select_shipping_rate', $package_id, $rate_id, $request );
$cart->calculate_totals();
return rest_ensure_response( $this->cart_schema->get_item_response( $cart ) );
}