RouteException::__construct( string $error_code, string $message, int $http_status_code = 400, array $additional_data = array() )
Setup exception.
Description #Description
Parameters #Parameters
- $error_code
-
(Required) Machine-readable error code, e.g
woocommerce_invalid_product_id. - $message
-
(Required) User-friendly translated error message, e.g. 'Product ID is invalid'.
- $http_status_code
-
(Optional) Proper HTTP status code to respond with, e.g. 400.
Default value: 400
- $additional_data
-
(Optional) Extra data (key value pairs) to expose in the error response.
Default value: array()
Source #Source
File: packages/woocommerce-blocks/src/StoreApi/Routes/RouteException.php
Related #Related
Used By #Used By
| Used By | Description |
|---|---|
| packages/woocommerce-blocks/src/StoreApi/Utilities/OrderController.php: OrderController::validate_coupons() |
Validate coupons applied to the order and remove those that are not valid. |
| packages/woocommerce-blocks/src/StoreApi/Utilities/OrderController.php: OrderController::validate_email() |
Validates the customer email. This is a required field. |
| packages/woocommerce-blocks/src/StoreApi/Utilities/OrderController.php: OrderController::validate_addresses() |
Validates customer address data based on the locale to ensure required fields are set. |
| packages/woocommerce-blocks/src/StoreApi/Utilities/CartController.php: CartController::get_variation_id_from_variation_data() |
Try to match request data to a variation ID and return the ID. |
| packages/woocommerce-blocks/src/StoreApi/Utilities/CartController.php: CartController::get_variable_product_attributes() |
Get product attributes from the variable product (which may be the parent if the product object is a variation). |
| packages/woocommerce-blocks/src/StoreApi/Utilities/OrderController.php: OrderController::create_order_from_cart() |
Create order and set props based on global settings. |
| packages/woocommerce-blocks/src/StoreApi/Utilities/CartController.php: CartController::get_cart_instance() |
Get main instance of cart class. |
| packages/woocommerce-blocks/src/StoreApi/Utilities/CartController.php: CartController::apply_coupon() |
Based on the core cart class but returns errors rather than rendering notices directly. |
| packages/woocommerce-blocks/src/StoreApi/Utilities/CartController.php: CartController::validate_cart_coupon() |
Validates an existing cart coupon and returns any errors. |
| packages/woocommerce-blocks/src/StoreApi/Utilities/CartController.php: CartController::get_product_for_cart() |
Get a product object to be added to the cart. |
| packages/woocommerce-blocks/src/StoreApi/Utilities/CartController.php: CartController::throw_default_product_exception() |
Default exception thrown when an item cannot be added to the cart. |
| packages/woocommerce-blocks/src/StoreApi/Utilities/CartController.php: CartController::parse_variation_data() |
If variations are set, validate and format the values ready to add to the cart. |
| packages/woocommerce-blocks/src/StoreApi/Utilities/NoticeHandler.php: NoticeHandler::convert_notices_to_exceptions() |
Convert queued error notices into an exception. |
| packages/woocommerce-blocks/src/StoreApi/Utilities/CartController.php: CartController::add_to_cart() |
Based on the core cart class but returns errors rather than rendering notices directly. |
| packages/woocommerce-blocks/src/StoreApi/Utilities/CartController.php: CartController::set_cart_item_quantity() |
Based on core |
| packages/woocommerce-blocks/src/StoreApi/Utilities/CartController.php: CartController::validate_add_to_cart() |
Validate all items in the cart and check for errors. |
| packages/woocommerce-blocks/src/StoreApi/Routes/CartRemoveItem.php: CartRemoveItem::get_route_post_response() |
Handle the request and return a valid response for this endpoint. |
| packages/woocommerce-blocks/src/StoreApi/Routes/ProductsById.php: ProductsById::get_route_response() |
Get a single item. |
| packages/woocommerce-blocks/src/StoreApi/Routes/ProductAttributesById.php: ProductAttributesById::get_route_response() |
Get a single item. |
| packages/woocommerce-blocks/src/StoreApi/Routes/CartSelectShippingRate.php: CartSelectShippingRate::get_route_post_response() |
Handle the request and return a valid response for this endpoint. |
| packages/woocommerce-blocks/src/StoreApi/Routes/CartApplyCoupon.php: CartApplyCoupon::get_route_post_response() |
Handle the request and return a valid response for this endpoint. |
| packages/woocommerce-blocks/src/StoreApi/Routes/CartCouponsByCode.php: CartCouponsByCode::get_route_response() |
Get a single cart coupon. |
| packages/woocommerce-blocks/src/StoreApi/Routes/CartCouponsByCode.php: CartCouponsByCode::get_route_delete_response() |
Delete a single cart coupon. |
| packages/woocommerce-blocks/src/StoreApi/Routes/CartItems.php: CartItems::get_route_post_response() |
Creates one item from the collection. |
| packages/woocommerce-blocks/src/StoreApi/Routes/Checkout.php: Checkout::process_customer() |
Order processing relating to customer account. |
| packages/woocommerce-blocks/src/StoreApi/Routes/ProductCategoriesById.php: ProductCategoriesById::get_route_response() |
Get a single item. |
| packages/woocommerce-blocks/src/StoreApi/Routes/CartCoupons.php: CartCoupons::get_route_post_response() |
Add a coupon to the cart and return the result. |
| packages/woocommerce-blocks/src/StoreApi/Routes/Checkout.php: Checkout::create_or_update_draft_order() |
Create or update a draft order based on the cart. |
| packages/woocommerce-blocks/src/StoreApi/Routes/Checkout.php: Checkout::process_payment() |
Fires an action hook instructing active payment gateways to process the payment for an order and provide a result. |
| packages/woocommerce-blocks/src/StoreApi/Routes/Checkout.php: Checkout::get_request_payment_method_id() |
Gets the chosen payment method ID from the request. |
| packages/woocommerce-blocks/src/StoreApi/Routes/Checkout.php: Checkout::get_request_payment_method() |
Gets the chosen payment method from the request. |
| packages/woocommerce-blocks/src/StoreApi/Routes/CartAddItem.php: CartAddItem::get_route_post_response() |
Handle the request and return a valid response for this endpoint. |
| packages/woocommerce-blocks/src/StoreApi/Routes/CartItemsByKey.php: CartItemsByKey::get_route_response() |
Get a single cart items. |
| packages/woocommerce-blocks/src/StoreApi/Routes/CartItemsByKey.php: CartItemsByKey::get_route_delete_response() |
Delete a single cart item. |
| packages/woocommerce-blocks/src/StoreApi/Routes/ProductAttributeTerms.php: ProductAttributeTerms::get_route_response() |
Get a collection of attribute terms. |
| packages/woocommerce-blocks/src/StoreApi/Routes/CartRemoveCoupon.php: CartRemoveCoupon::get_route_post_response() |
Handle the request and return a valid response for this endpoint. |
| packages/woocommerce-blocks/src/StoreApi/Routes/Batch.php: Batch::get_response() |
Get the route response. |
| packages/woocommerce-blocks/src/StoreApi/Routes/AbstractRoute.php: AbstractRoute::get_route_response() |
Get route response for GET requests. |
| packages/woocommerce-blocks/src/StoreApi/Routes/AbstractRoute.php: AbstractRoute::get_route_post_response() |
Get route response for POST requests. |
| packages/woocommerce-blocks/src/StoreApi/Routes/AbstractRoute.php: AbstractRoute::get_route_update_response() |
Get route response for PUT requests. |
| packages/woocommerce-blocks/src/StoreApi/Routes/AbstractRoute.php: AbstractRoute::get_route_delete_response() |
Get route response for DELETE requests. |