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_Product_Variations_Controller

REST API variations controller class.

WP_REST_Controller
Extended by WC_REST_Controller
Extended by WC_REST_Posts_Controller
Extended by WC_REST_CRUD_Controller
Extended by WC_REST_Legacy_Products_Controller
Extended by WC_REST_Products_Controller
Extended by WC_REST_Product_Variations_Controller
Package: WooCommerce\API
Extends: WC_REST_Products_Controller
Located at api/class-wc-rest-product-variations-controller.php

Methods summary

public
# __construct( )

Initialize product actions (parent).

Initialize product actions (parent).

Overrides

WC_REST_Products_Controller::__construct
public
# register_routes( )

Register the routes for products.

Register the routes for products.

Overrides

WC_REST_Products_Controller::register_routes
protected WC_Data
# get_object( integer $id )

Get object.

Get object.

Parameters

$id
Object ID.

Returns

WC_Data

Since

3.0.0

Overrides

WC_REST_Products_Controller::get_object
public WP_REST_Response
# prepare_object_for_response( WC_Data $object, WP_REST_Request $request )

Prepare a single variation output for response.

Prepare a single variation output for response.

Parameters

$object
Object data.
$request
Request object.

Returns

WP_REST_Response

Since

3.0.0

Overrides

WC_REST_Products_Controller::prepare_object_for_response
protected array
# prepare_objects_query( WP_REST_Request $request )

Prepare objects query.

Prepare objects query.

Parameters

$request
Full details about the request.

Returns

array

Since

3.0.0

Overrides

WC_REST_Products_Controller::prepare_objects_query
protected WP_Error|WC_Data
# prepare_object_for_database( WP_REST_Request $request, boolean $creating = false )

Prepare a single variation for create or update.

Prepare a single variation for create or update.

Parameters

$request
Request object.
$creating
If is creating a new object.

Returns

WP_Error|WC_Data

Overrides

WC_REST_Products_Controller::prepare_object_for_database
public
# clear_transients( WC_Data $object )

Clear caches here so in sync with any new variations.

Clear caches here so in sync with any new variations.

Parameters

$object
Object data.

Overrides

WC_REST_Products_Controller::clear_transients
public boolean|WP_Error|WP_REST_Response
# delete_item( WP_REST_Request $request )

Delete a variation.

Delete a variation.

Parameters

$request
Full details about the request.

Returns

boolean|WP_Error|WP_REST_Response

Overrides

WC_REST_Products_Controller::delete_item
public array
# batch_items( WP_REST_Request $request )

Bulk create, update and delete items.

Bulk create, update and delete items.

Parameters

$request
Full details about the request.

Returns

array
Of WP_Error or WP_REST_Response.

Since

3.0.0

Overrides

WC_REST_Controller::batch_items
protected array
# prepare_links( WC_Data $object, WP_REST_Request $request )

Prepare links for the request.

Prepare links for the request.

Parameters

$object
Object data.
$request
Request object.

Returns

array
Links for the given post.

Overrides

WC_REST_Products_Controller::prepare_links
public array
# get_item_schema( )

Get the Variation's schema, conforming to JSON Schema.

Get the Variation's schema, conforming to JSON Schema.

Returns

array

Overrides

WC_REST_Products_Controller::get_item_schema

Methods inherited from WC_REST_Products_Controller

get_attribute_options(), get_attribute_taxonomy_label(), get_attribute_taxonomy_name(), get_attributes(), get_collection_params(), get_default_attributes(), get_downloads(), get_images(), get_product_data(), get_taxonomy_terms(), save_default_attributes(), save_downloadable_files(), save_product_shipping_data(), save_taxonomy_terms(), set_product_images()

Methods inherited from WC_REST_Legacy_Products_Controller

add_post_meta_fields(), delete_post(), get_post_types(), get_product_menu_order(), prepare_item_for_response(), query_args(), save_product_images(), save_product_meta(), save_variations_data(), set_product_meta(), update_post_meta_fields()

Methods inherited from WC_REST_CRUD_Controller

create_item(), delete_item_permissions_check(), get_item(), get_item_permissions_check(), get_items(), get_objects(), get_permalink(), save_object(), update_item(), update_item_permissions_check()

Methods inherited from WC_REST_Posts_Controller

batch_items_permissions_check(), create_item_permissions_check(), get_allowed_query_vars(), get_items_permissions_check(), prepare_items_query()

Methods inherited from WC_REST_Controller

add_additional_fields_schema(), add_meta_query(), 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/v2'
protected string $rest_base

Route base.

Route base.
# 'products/(?P<product_id>[\d]+)/variations'
protected string $post_type

Post type.

Post type.
# 'product_variation'

Properties inherited from WC_REST_Products_Controller

$hierarchical

Properties inherited from WC_REST_Posts_Controller

$public

WooCommerce Code Reference API documentation generated by ApiGen