WooCommerce Code Reference
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo
  • Hook Reference
  • WooCommerce Docs
  • REST API Docs

Packages

  • None
  • WooCommerce
    • Abstracts
    • Admin
      • Customize
      • Functions
      • Importers
      • Meta
      • Reports
      • System
    • API
    • Classes
      • Data
        • Store
      • Emails
      • Embed
      • Integrations
      • Interfaces
      • Log
        • Handlers
      • Payment
      • Products
      • Shipping
      • Walkers
    • Export
    • Functions
    • Import
    • l10n
    • PaymentTokens
    • PayPal
    • Shortcodes
      • Cart
      • Checkout
      • My
        • Account
      • Order
        • Tracking
    • Webhooks
    • Widgets
  • WP-Background-Processing

Classes

  • WC_API
  • WC_API_Taxes
  • WC_API_XML_Handler
  • WC_Auth
  • WC_Legacy_API
  • WC_REST_Authentication
  • WC_REST_Coupons_Controller
  • WC_REST_Coupons_V1_Controller
  • WC_REST_Customer_Downloads_Controller
  • WC_REST_Customer_Downloads_V1_Controller
  • WC_REST_Customers_Controller
  • WC_REST_Customers_V1_Controller
  • WC_REST_Legacy_Coupons_Controller
  • WC_REST_Legacy_Orders_Controller
  • WC_REST_Legacy_Products_Controller
  • WC_REST_Order_Notes_Controller
  • WC_REST_Order_Notes_V1_Controller
  • WC_REST_Order_Refunds_Controller
  • WC_REST_Order_Refunds_V1_Controller
  • WC_REST_Orders_Controller
  • WC_REST_Orders_V1_Controller
  • WC_REST_Payment_Gateways_Controller
  • WC_REST_Product_Attribute_Terms_Controller
  • WC_REST_Product_Attribute_Terms_V1_Controller
  • WC_REST_Product_Attributes_Controller
  • WC_REST_Product_Attributes_V1_Controller
  • WC_REST_Product_Categories_Controller
  • WC_REST_Product_Categories_V1_Controller
  • WC_REST_Product_Reviews_Controller
  • WC_REST_Product_Reviews_V1_Controller
  • WC_REST_Product_Shipping_Classes_Controller
  • WC_REST_Product_Shipping_Classes_V1_Controller
  • WC_REST_Product_Tags_Controller
  • WC_REST_Product_Tags_V1_Controller
  • WC_REST_Product_Variations_Controller
  • WC_REST_Products_Controller
  • WC_REST_Products_V1_Controller
  • WC_REST_Report_Sales_Controller
  • WC_REST_Report_Sales_V1_Controller
  • WC_REST_Report_Top_Sellers_Controller
  • WC_REST_Report_Top_Sellers_V1_Controller
  • WC_REST_Reports_Controller
  • WC_REST_Reports_V1_Controller
  • WC_REST_Setting_Options_Controller
  • WC_REST_Settings_Controller
  • WC_REST_Shipping_Methods_Controller
  • WC_REST_Shipping_Zone_Locations_Controller
  • WC_REST_Shipping_Zone_Methods_Controller
  • WC_REST_Shipping_Zones_Controller
  • WC_REST_Shipping_Zones_Controller_Base
  • WC_REST_System_Status_Controller
  • WC_REST_System_Status_Tools_Controller
  • WC_REST_Tax_Classes_Controller
  • WC_REST_Tax_Classes_V1_Controller
  • WC_REST_Taxes_Controller
  • WC_REST_Taxes_V1_Controller
  • WC_REST_Webhook_Deliveries_Controller
  • WC_REST_Webhook_Deliveries_V1_Controller
  • WC_REST_Webhooks_Controller
  • WC_REST_Webhooks_V1_Controller

Exceptions

  • WC_REST_Exception

Class WC_REST_Tax_Classes_V1_Controller

REST API Tax Classes controller class.

WP_REST_Controller
Extended by WC_REST_Controller
Extended by WC_REST_Tax_Classes_V1_Controller

Direct known subclasses

WC_REST_Tax_Classes_Controller

Package: WooCommerce\API
Author: WooThemes
Extends: WC_REST_Controller
Located at api/v1/class-wc-rest-tax-classes-controller.php

Methods summary

public
# register_routes( )

Register the routes for tax classes.

Register the routes for tax classes.

public WP_Error|boolean
# get_items_permissions_check( WP_REST_Request $request )

Check whether a given request has permission to read tax classes.

Check whether a given request has permission to read tax classes.

Parameters

$request
Full details about the request.

Returns

WP_Error|boolean
public boolean|WP_Error
# create_item_permissions_check( WP_REST_Request $request )

Check if a given request has access create tax classes.

Check if a given request has access create tax classes.

Parameters

$request
Full details about the request.

Returns

boolean|WP_Error
public boolean|WP_Error
# delete_item_permissions_check( WP_REST_Request $request )

Check if a given request has access delete a tax.

Check if a given request has access delete a tax.

Parameters

$request
Full details about the request.

Returns

boolean|WP_Error
public array
# get_items( WP_REST_Request $request )

Get all tax classes.

Get all tax classes.

Parameters

$request

Returns

array
public WP_Error|WP_REST_Response
# create_item( WP_REST_Request $request )

Create a single tax.

Create a single tax.

Parameters

$request
Full details about the request.

Returns

WP_Error|WP_REST_Response
public WP_Error|WP_REST_Response
# delete_item( WP_REST_Request $request )

Delete a single tax class.

Delete a single tax class.

Parameters

$request
Full details about the request.

Returns

WP_Error|WP_REST_Response
public WP_REST_Response
# prepare_item_for_response( array $tax_class, WP_REST_Request $request )

Prepare a single tax class output for response.

Prepare a single tax class output for response.

Parameters

$tax_class
Tax class data.
$request
Request object.

Returns

WP_REST_Response
$response Response data.
protected array
# prepare_links( )

Prepare links for the request.

Prepare links for the request.

Returns

array
Links for the given tax class.
public array
# get_item_schema( )

Get the Tax Classes schema, conforming to JSON Schema

Get the Tax Classes schema, conforming to JSON Schema

Returns

array
public array
# get_collection_params( )

Get the query params for collections.

Get the query params for collections.

Returns

array

Methods inherited from WC_REST_Controller

add_additional_fields_schema(), add_meta_query(), batch_items(), check_batch_limit(), get_normalized_rest_base(), get_public_batch_schema(), validate_setting_checkbox_field(), validate_setting_image_width_field(), validate_setting_multiselect_field(), validate_setting_radio_field(), validate_setting_select_field(), validate_setting_text_field(), validate_setting_textarea_field()

Properties summary

protected string $namespace

Endpoint namespace.

Endpoint namespace.

# 'wc/v1'
protected string $rest_base

Route base.

Route base.

# 'taxes/classes'
WooCommerce Code Reference API documentation generated by ApiGen