WooCommerce 3.0.x Code Reference

Packages summary

Classes summary

WC_Abstract_Legacy_Order	Legacy Abstract Order
WC_Abstract_Legacy_Product	Legacy Abstract Product
WC_Abstract_Order	Abstract Order
WC_Addons_Gateway_Simplify_Commerce	Simplify Commerce Gateway for subscriptions.
WC_Admin	WC_Admin class.
WC_Admin_Addons	WC_Admin_Addons Class.
WC_Admin_API_Keys	WC_Admin_API_Keys.
WC_Admin_API_Keys_Table_List
WC_Admin_Assets	WC_Admin_Assets Class.
WC_Admin_Attributes	WC_Admin_Attributes Class.
WC_Admin_Dashboard	WC_Admin_Dashboard Class.
WC_Admin_Duplicate_Product	WC_Admin_Duplicate_Product Class.
WC_Admin_Help	WC_Admin_Help Class.
WC_Admin_Importers	WC_Admin_Importers Class.
WC_Admin_Log_Table_List
WC_Admin_Menus	WC_Admin_Menus Class.
WC_Admin_Meta_Boxes	WC_Admin_Meta_Boxes.
WC_Admin_Notices	WC_Admin_Notices Class.
WC_Admin_Permalink_Settings	WC_Admin_Permalink_Settings Class.
WC_Admin_Pointers	WC_Admin_Pointers Class.
WC_Admin_Post_Types	WC_Admin_Post_Types Class.
WC_Admin_Profile	WC_Admin_Profile Class.
WC_Admin_Report	Admin Report.
WC_Admin_Reports	WC_Admin_Reports Class.
WC_Admin_Settings	WC_Admin_Settings Class.
WC_Admin_Setup_Wizard	WC_Admin_Setup_Wizard class.
WC_Admin_Status	WC_Admin_Status Class.
WC_Admin_Taxonomies	WC_Admin_Taxonomies class.
WC_Admin_Webhooks	WC_Admin_Webhooks.
WC_Admin_Webhooks_Table_List
WC_AJAX	WooCommerce WC_AJAX.
WC_API
WC_Auth
WC_Autoloader	WooCommerce Autoloader.
WC_Background_Updater	WC_Background_Updater Class.
WC_Breadcrumb	WC_Breadcrumb class.
WC_Cache_Helper	WC_Cache_Helper class.
WC_Cart	WooCommerce cart
WC_Checkout	Main checkout class.
WC_CLI	Enables WooCommerce, via the the command line.
WC_CLI_REST_Command	Main Command for WooCommere CLI.
WC_CLI_Runner	WC API to WC CLI Bridge.
WC_CLI_Tool_Command	Hooks up our system status tools to the CLI.
WC_CLI_Update_Command	Allows updates via CLI.
WC_Comments	Comments
WC_Countries	WooCommerce countries
WC_Coupon	WooCommerce coupons.
WC_Coupon_Data_Store_CPT	WC Coupon Data Store: Custom Post Type.
WC_Customer	The WooCommerce customer class handles storage of the current customer's data, such as location.
WC_Customer_Data_Store	WC Customer Data Store.
WC_Customer_Data_Store_Session	WC Customer Data Store which stores the data in session.
WC_Customer_Download	Class for customer download permissions.
WC_Customer_Download_Data_Store	WC Customer Download Data Store.
WC_Data	Abstract WC Data Class
WC_Data_Store	WC Data Store.
WC_Data_Store_WP	Shared logic for WP based data. Contains functions like meta handling for all default data stores. Your own data store doesn't need to use WC_Data_Store_WP -- you can write your own meta handling functions.
WC_DateTime	WC Wrapper for PHP DateTime.
WC_Deprecated_Action_Hooks	Handles deprecation notices and triggering of legacy action hooks.
WC_Deprecated_Filter_Hooks	Handles deprecation notices and triggering of legacy filter hooks.
WC_Deprecated_Hooks	WC_Deprecated_Hooks class maps old actions and filters to new ones. This is the base class for handling those deprecated hooks.
WC_Download_Handler	Download handler.
WC_Email	Email Class
WC_Email_Cancelled_Order	Cancelled Order Email.
WC_Email_Customer_Completed_Order	Customer Completed Order Email.
WC_Email_Customer_Invoice	Customer Invoice.
WC_Email_Customer_New_Account	Customer New Account.
WC_Email_Customer_Note	Customer Note Order Email.
WC_Email_Customer_On_Hold_Order	Customer On-hold Order Email.
WC_Email_Customer_Processing_Order	Customer Processing Order Email.
WC_Email_Customer_Refunded_Order	Customer Refunded Order Email.
WC_Email_Customer_Reset_Password	Customer Reset Password.
WC_Email_Failed_Order	Failed Order Email.
WC_Email_New_Order	New Order Email.
WC_Emails	Transactional Emails Controller
WC_Embed	Embed Class which handles any WooCommerce Products that are embedded on this site or another site.
WC_Form_Handler	Handle frontend forms.
WC_Frontend_Scripts	WC_Frontend_Scripts Class.
WC_Gateway_BACS	Bank Transfer Payment Gateway.
WC_Gateway_Cheque	Cheque Payment Gateway.
WC_Gateway_COD	Cash on Delivery Gateway.
WC_Gateway_Paypal	WC_Gateway_Paypal Class.
WC_Gateway_Paypal_API_Handler	Handles Refunds and other API requests such as capture.
WC_Gateway_Paypal_IPN_Handler	Handles responses from PayPal IPN.
WC_Gateway_Paypal_PDT_Handler	Handle PDT Responses from PayPal.
WC_Gateway_Paypal_Refund	Here for backwards compatibility.
WC_Gateway_Paypal_Request	Generates requests to send to PayPal.
WC_Gateway_Paypal_Response	Handles Responses.
WC_Gateway_Simplify_Commerce	Simplify Commerce Gateway.
WC_Geo_IP	WC_Geo_IP Class.
WC_Geo_IP_Record	Geo IP Record class.
WC_Geolocation	WC_Geolocation Class.
WC_HTTPS	WC_HTTPS class.
WC_Install	WC_Install Class.
WC_Integration	Abstract Integration Class
WC_Integrations	WooCommerce Integrations class
WC_Legacy_API
WC_Legacy_Coupon	Legacy Coupon.
WC_Legacy_Customer	Legacy Customer.
WC_Legacy_Payment_Token	Legacy Payment Tokens. Payment Tokens were introduced in 2.6.0 with create and update as methods. Major CRUD changes occurred in 3.0, so these were deprecated (save and delete still work). This legacy class is for backwards compatibility in case any code called ->read, ->update or ->create directly on the object.
WC_Legacy_Shipping_Zone	Legacy Shipping Zone.
WC_Log_Handler	Abstract WC Log Handler Class
WC_Log_Handler_DB	Handles log entries by writing to database.
WC_Log_Handler_Email	Handles log entries by sending an email.
WC_Log_Handler_File	Handles log entries by writing to a file.
WC_Log_Levels	Standard log levels
WC_Logger	Provides logging capabilities for debugging purposes.
WC_Meta_Box_Coupon_Data	WC_Meta_Box_Coupon_Data Class.
WC_Meta_Box_Order_Actions	WC_Meta_Box_Order_Actions Class.
WC_Meta_Box_Order_Data	WC_Meta_Box_Order_Data Class.
WC_Meta_Box_Order_Downloads	WC_Meta_Box_Order_Downloads Class.
WC_Meta_Box_Order_Items	WC_Meta_Box_Order_Items Class.
WC_Meta_Box_Order_Notes	WC_Meta_Box_Order_Notes Class.
WC_Meta_Box_Product_Data	WC_Meta_Box_Product_Data Class.
WC_Meta_Box_Product_Images	WC_Meta_Box_Product_Images Class.
WC_Meta_Box_Product_Reviews	WC_Meta_Box_Product_Reviews
WC_Meta_Box_Product_Short_Description	WC_Meta_Box_Product_Short_Description Class.
WC_Order	Order Class.
WC_Order_Data_Store_CPT	WC Order Data Store: Stored in CPT.
WC_Order_Factory	Order Factory Class
WC_Order_Item	Order Item
WC_Order_Item_Coupon	Order Line Item (coupon).
WC_Order_Item_Coupon_Data_Store	WC Order Item Coupon Data Store
WC_Order_Item_Data_Store	WC Order Item Data Store: Misc Order Item Data functions.
WC_Order_Item_Fee	Order Line Item (fee).
WC_Order_Item_Fee_Data_Store	WC Order Item Fee Data Store
WC_Order_Item_Meta	Order Item Meta
WC_Order_Item_Product	Order Line Item (product).
WC_Order_Item_Product_Data_Store	WC Order Item Product Data Store
WC_Order_Item_Shipping	Order Line Item (shipping).
WC_Order_Item_Shipping_Data_Store	WC Order Item Shipping Data Store
WC_Order_Item_Tax	Order Line Item (tax).
WC_Order_Item_Tax_Data_Store	WC Order Item Tax Data Store
WC_Order_Refund	Order refund. Refunds are based on orders (essentially negative orders) and contain much of the same data.
WC_Order_Refund_Data_Store_CPT	WC Order Refund Data Store: Stored in CPT.
WC_Payment_Gateway	WooCommerce Payment Gateway class.
WC_Payment_Gateway_CC	Credit Card Payment Gateway
WC_Payment_Gateway_eCheck	eCheck Payment Gateway
WC_Payment_Gateways	WooCommerce Payment Gateways class
WC_Payment_Token	WooCommerce Payment Token.
WC_Payment_Token_CC	WooCommerce Credit Card Payment Token.
WC_Payment_Token_Data_Store	WC Payment Token Data Store: Custom Table.
WC_Payment_Token_eCheck	WooCommerce eCheck Payment Token.
WC_Payment_Tokens	WooCommerce Payment Tokens.
WC_Post_Data	Post Data.
WC_Post_types	WC_Post_types Class.
WC_Product	Abstract Product Class
WC_Product_Attribute	Represents a product attribute.
WC_Product_Cat_Dropdown_Walker
WC_Product_Cat_List_Walker
WC_Product_Data_Store_CPT	WC Product Data Store: Stored in CPT.
WC_Product_Download	Represents a file which can be downloaded.
WC_Product_External	External Product Class.
WC_Product_Factory	Product Factory Class
WC_Product_Grouped	Grouped Product Class.
WC_Product_Grouped_Data_Store_CPT	WC Grouped Product Data Store: Stored in CPT.
WC_Product_Simple	Simple Product Class.
WC_Product_Variable	Variable Product Class.
WC_Product_Variable_Data_Store_CPT	WC Variable Product Data Store: Stored in CPT.
WC_Product_Variation	Product Variation Class.
WC_Product_Variation_Data_Store_CPT	WC Variation Product Data Store: Stored in CPT.
WC_Query	WC_Query Class.
WC_Register_WP_Admin_Settings	Take settings registered for WP-Admin and hooks them up to the REST API.
WC_Report_Coupon_Usage	WC_Report_Coupon_Usage
WC_Report_Customer_List	WC_Report_Customer_List.
WC_Report_Customers	WC_Report_Customers
WC_Report_Low_In_Stock	WC_Report_Low_In_Stock.
WC_Report_Most_Stocked	WC_Report_Most_Stocked.
WC_Report_Out_Of_Stock	WC_Report_Out_Of_Stock.
WC_Report_Sales_By_Category	WC_Report_Sales_By_Category
WC_Report_Sales_By_Date	WC_Report_Sales_By_Date
WC_Report_Sales_By_Product	WC_Report_Sales_By_Product
WC_Report_Stock	WC_Report_Stock.
WC_Report_Taxes_By_Code	WC_Report_Taxes_By_Code
WC_Report_Taxes_By_Date	WC_Report_Taxes_By_Date
WC_REST_Authentication
WC_REST_Controller	Abstract Rest Controller Class
WC_REST_Coupons_Controller	REST API Coupons controller class.
WC_REST_Coupons_V1_Controller	REST API Coupons controller class.
WC_REST_CRUD_Controller	WC_REST_CRUD_Controller class.
WC_REST_Customer_Downloads_Controller	REST API Customers controller class.
WC_REST_Customer_Downloads_V1_Controller	REST API Customers controller class.
WC_REST_Customers_Controller	REST API Customers controller class.
WC_REST_Customers_V1_Controller	REST API Customers controller class.
WC_REST_Order_Notes_Controller	REST API Order Notes controller class.
WC_REST_Order_Notes_V1_Controller	REST API Order Notes controller class.
WC_REST_Order_Refunds_Controller	REST API Order Refunds controller class.
WC_REST_Order_Refunds_V1_Controller	REST API Order Refunds controller class.
WC_REST_Orders_Controller	REST API Orders controller class.
WC_REST_Orders_V1_Controller	REST API Orders controller class.
WC_REST_Payment_Gateways_Controller
WC_REST_Posts_Controller	Abstract Rest Posts Controller Class
WC_REST_Product_Attribute_Terms_Controller	REST API Product Attribute Terms controller class.
WC_REST_Product_Attribute_Terms_V1_Controller	REST API Product Attribute Terms controller class.
WC_REST_Product_Attributes_Controller	REST API Product Attributes controller class.
WC_REST_Product_Attributes_V1_Controller	REST API Product Attributes controller class.
WC_REST_Product_Categories_Controller	REST API Product Categories controller class.
WC_REST_Product_Categories_V1_Controller	REST API Product Categories controller class.
WC_REST_Product_Reviews_Controller	REST API Product Reviews Controller Class.
WC_REST_Product_Reviews_V1_Controller	REST API Product Reviews Controller Class.
WC_REST_Product_Shipping_Classes_Controller	REST API Product Shipping Classes controller class.
WC_REST_Product_Shipping_Classes_V1_Controller	REST API Product Shipping Classes controller class.
WC_REST_Product_Tags_Controller	REST API Product Tags controller class.
WC_REST_Product_Tags_V1_Controller	REST API Product Tags controller class.
WC_REST_Product_Variations_Controller	REST API variations controller class.
WC_REST_Products_Controller	REST API Products controller class.
WC_REST_Products_V1_Controller	REST API Products controller class.
WC_REST_Report_Sales_Controller	REST API Report Sales controller class.
WC_REST_Report_Sales_V1_Controller	REST API Report Sales controller class.
WC_REST_Report_Top_Sellers_Controller	REST API Report Top Sellers controller class.
WC_REST_Report_Top_Sellers_V1_Controller	REST API Report Top Sellers controller class.
WC_REST_Reports_Controller	REST API Reports controller class.
WC_REST_Reports_V1_Controller	REST API Reports controller class.
WC_REST_Setting_Options_Controller	REST API Setting Options controller class.
WC_REST_Settings_Controller	REST API Settings controller class.
WC_REST_Shipping_Methods_Controller
WC_REST_Shipping_Zone_Locations_Controller	REST API Shipping Zone Locations class.
WC_REST_Shipping_Zone_Methods_Controller	REST API Shipping Zone Methods class.
WC_REST_Shipping_Zones_Controller	REST API Shipping Zones class.
WC_REST_Shipping_Zones_Controller_Base	REST API Shipping Zones base class.
WC_REST_System_Status_Controller
WC_REST_System_Status_Tools_Controller
WC_REST_Tax_Classes_Controller	REST API Tax Classes controller class.
WC_REST_Tax_Classes_V1_Controller	REST API Tax Classes controller class.
WC_REST_Taxes_Controller	REST API Taxes controller class.
WC_REST_Taxes_V1_Controller	REST API Taxes controller class.
WC_REST_Terms_Controller	Abstract Rest Terms Controller Class
WC_REST_Webhook_Deliveries_Controller	REST API Webhook Deliveries controller class.
WC_REST_Webhook_Deliveries_V1_Controller	REST API Webhook Deliveries controller class.
WC_REST_Webhooks_Controller	REST API Webhooks controller class.
WC_REST_Webhooks_V1_Controller	REST API Webhooks controller class.
WC_Session	Handle data for the current customers session
WC_Session_Handler	Handle data for the current customers session. Implements the WC_Session abstract class.
WC_Settings_Accounts	WC_Settings_Accounts.
WC_Settings_API	Abstract Settings API Class
WC_Settings_Emails	WC_Settings_Emails.
WC_Settings_General	WC_Admin_Settings_General.
WC_Settings_Integrations	WC_Settings_Integrations.
WC_Settings_Page	WC_Settings_Page.
WC_Settings_Payment_Gateways	WC_Settings_Payment_Gateways.
WC_Settings_Products	WC_Settings_Products.
WC_Settings_Rest_API	WC_Settings_Rest_API.
WC_Settings_Shipping	WC_Settings_Shipping.
WC_Settings_Tax	WC_Settings_Tax.
WC_Shipping	WC_Shipping
WC_Shipping_Flat_Rate	Flat Rate Shipping Method.
WC_Shipping_Free_Shipping	Free Shipping Method.
WC_Shipping_Legacy_Flat_Rate	Flat Rate Shipping Method.
WC_Shipping_Legacy_Free_Shipping	Free Shipping Method.
WC_Shipping_Legacy_International_Delivery	International Delivery - Based on the Flat Rate Shipping Method.
WC_Shipping_Legacy_Local_Delivery	Local Delivery Shipping Method.
WC_Shipping_Legacy_Local_Pickup	Local Pickup Shipping Method.
WC_Shipping_Local_Pickup	Local Pickup Shipping Method.
WC_Shipping_Method	WooCommerce Shipping Method Class.
WC_Shipping_Rate	WooCommerce Shipping Rate Class.
WC_Shipping_Zone	Represents a single shipping zone
WC_Shipping_Zone_Data_Store	WC Shipping Zone Data Store.
WC_Shipping_Zones	Handles storage and retrieval of shipping zones
WC_Shortcode_Cart	Cart Shortcode
WC_Shortcode_Checkout	Checkout Shortcode
WC_Shortcode_My_Account	My Account Shortcodes
WC_Shortcode_Order_Tracking	Order Tracking Shortcode
WC_Shortcodes	WC_Shortcodes class
WC_Structured_Data	Structured data's handler and generator using JSON-LD format.
WC_Tax	Performs tax calculations and loads tax rates
WC_Tax_Rate_Importer	Tax Rates importer - import tax rates and local tax rates into WooCommerce.
WC_Template_Loader	Template Loader
WC_Tracker
WC_Twenty_Seventeen	Twenty Seventeen suport.
WC_Validation	Contains Validation functions
WC_Webhook	WooCommerce Webhook class.
WC_Widget	Abstract Widget Class
WC_Widget_Cart	Shopping Cart Widget.
WC_Widget_Layered_Nav	Layered Navigation Widget.
WC_Widget_Layered_Nav_Filters	Layered Navigation Filters Widget.
WC_Widget_Price_Filter	Price Filter Widget and related functions.
WC_Widget_Product_Categories	Product Categories Widget.
WC_Widget_Product_Search	Product Search Widget.
WC_Widget_Product_Tag_Cloud	Tag Cloud Widget.
WC_Widget_Products	List products. One widget to rule them all.
WC_Widget_Rating_Filter	Rating Filter Widget and related functions.
WC_Widget_Recent_Reviews	Recent Reviews Widget.
WC_Widget_Recently_Viewed	Recent Products Widget.
WC_Widget_Top_Rated_Products	Top Rated Products Widget.

Interfaces summary

WC_Abstract_Order_Data_Store_Interface	WC Order Data Store Interface
WC_Coupon_Data_Store_Interface	WC Coupon Data Store Interface
WC_Customer_Data_Store_Interface	WC Customer Data Store Interface
WC_Customer_Download_Data_Store_Interface	WC Customer Download Data Store Interface.
WC_Log_Handler_Interface	WC Log Handler Interface
WC_Logger_Interface	WC Logger Interface
WC_Object_Data_Store_Interface	WC Data Store Interface
WC_Order_Data_Store_Interface	WC Order Data Store Interface
WC_Order_Item_Data_Store_Interface	WC Order Item Data Store Interface
WC_Order_Item_Product_Data_Store_Interface	WC Order Item Data Store Interface
WC_Order_Item_Type_Data_Store_Interface	WC Order Item Data Store Interface
WC_Order_Refund_Data_Store_Interface	WC Order Refund Data Store Interface
WC_Payment_Token_Data_Store_Interface	WC Payment Token Data Store Interface
WC_Product_Data_Store_Interface	WC Product Data Store Interface
WC_Product_Variable_Data_Store_Interface	WC Product Variable Data Store Interface
WC_Shipping_Zone_Data_Store_Interface	WC Shipping Zone Data Store Interface.

Exceptions summary

WC_Data_Exception	WC_Data_Exception class.
WC_REST_Exception	WC_REST_Exception class.

Functions summary

WC	Main instance of WooCommerce.