WooCommerce Code Reference

WooCommerce

Packages

Classes
Abstracts
Admin
Helper
Views
Templates
Reports
Blocks
RestApi
CLI
l10n
Webhooks
DataStores
Emails
Export
Gateways
PayPal
Import
Integrations
Interfaces
Interface
LogHandlers
PaymentTokens
Utilities
Shipping
Shortcodes
Tracks
Traits
Functions
WCCom
WCCOM
Widgets
Uninstaller

Interfaces, Classes and Traits

ArgumentResolverInterface
ClassNameInterface
RawArgumentInterface
ContainerAwareInterface
DefinitionAggregateInterface
DefinitionInterface
InflectorAggregateInterface
InflectorInterface
BootableServiceProviderInterface
ServiceProviderAggregateInterface
ServiceProviderInterface
ContainerExceptionInterface
Base interface representing a generic exception in a container.
ContainerInterface
Describes the interface of a container that exposes methods to read its entries.
NotFoundExceptionInterface
No entry was found in the container.
DataStoreInterface
WooCommerce Reports data store interface.
ExportableInterface
WooCommerce Reports exportable controller interface.
BlockContainerInterface
Interface for block containers.
BlockInterface
Interface for block configuration used to specify blocks in BlockTemplate.
BlockTemplateInterface
Interface for block-based template.
ContainerInterface
Interface for block containers.
DateTimeProviderInterface
DateTime Provider Interface.
GroupInterface
Interface for group containers, which contain sections and blocks.
ProductFormTemplateInterface
Interface for block containers.
SectionInterface
Interface for section containers, which contain sub-sections and blocks.
SubsectionInterface
Interface for subsection containers, which contain sub-sections and blocks.
MarketingChannelInterface
MarketingChannelInterface interface
PluginsInstallLogger
A logger used in PluginsHelper::install_plugins to log the installation progress.
PluginsProviderInterface
Plugins Provider Interface
RuleProcessorInterface
Rule processor interface
RuleProcessorInterface
Rule processor interface
IntegrationInterface
Integration.Interface
PaymentMethodTypeInterface
Integration.Interface
CacheEngine
Interface for cache engines used by objects inheriting from ObjectCache.
FormatterInterface
FormatterInterface.
RouteInterface
RouteInterface.
WC_Notes_Refund_Returns
WC_Notes_Refund_Returns.
WC_Notes_Run_Db_Update
WC_Notes_Run_Db_Update.
WC_Meta_Data
Meta data class.
WooCommerce
Main WooCommerce Class.
WC_CLI_COM_Command
Allows to interact with extensions from WCCOM marketplace via CLI.
WC_CLI_COM_Extension_Command
Allows to interact with extensions from WCCOM marketplace via CLI.
WC_CLI_REST_Command
Main Command for WooCommerce 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_Tracker_Command
Allows access to tracker snapshot for transparency and debugging.
WC_CLI_Update_Command
Allows updates via CLI.
WC_Customizer_Control_Cropping
WC_Customizer_Control_Cropping class.
WC_Shop_Customizer
WC_Shop_Customizer class.
MobileDetect
Auto-generated isXXXX() magic methods.
ClassName
ClassNameWithOptionalValue
RawArgument
Container
Definition
DefinitionAggregate
ContainerException
NotFoundException
Inflector
InflectorAggregate
ReflectionContainer
AbstractServiceProvider
ServiceProviderAggregate
Experiments
Data controller.
Options
Options Controller.
Cache
REST API Reports Cache class.
DataStore
API\Reports\Categories\DataStore.
Query
API\Reports\Query
DataStore
API\Reports\Coupons\DataStore.
Query
API\Reports\Coupons\Query
DataStore
API\Reports\Coupons\Stats\DataStore.
Query
API\Reports\Coupons\Stats\Query
Segmenter
Date & time interval and numeric range handling class for Reporting API.
DataStore
Admin\API\Reports\Customers\DataStore.
Query
API\Reports\Customers\Query
DataStore
API\Reports\Customers\Stats\DataStore.
Query
API\Reports\Customers\Stats\Query
DataStore
Admin\API\Reports\DataStore: Common parent for custom report data stores.
DataStore
API\Reports\Downloads\DataStore.
Query
API\Reports\Downloads\Query
DataStore
API\Reports\Downloads\Stats\DataStore.
Query
API\Reports\Downloads\Stats\Query
DataStore
API\Reports\Orders\DataStore.
Query
API\Reports\Orders\Query
DataStore
API\Reports\Orders\Stats\DataStore.
Query
API\Reports\Orders\Stats\Query
Segmenter
Date & time interval and numeric range handling class for Reporting API.
ParameterException
API\Reports\ParameterException class.
DataStore
API\Reports\Products\DataStore.
Query
API\Reports\Products\Query
DataStore
API\Reports\Products\Stats\DataStore.
Query
API\Reports\Products\Stats\Query
Segmenter
Date & time interval and numeric range handling class for Reporting API.
Query
Admin\API\Reports\Query
Query
API\Reports\Revenue\Query
Segmenter
Date & time interval and numeric range handling class for Reporting API.
SqlQuery
Admin\API\Reports\SqlQuery: Common parent for manipulating SQL query clauses.
DataStore
API\Reports\Stock\Stats\DataStore.
Query
API\Reports\Stock\Stats\Query
DataStore
API\Reports\Taxes\DataStore.
Query
API\Reports\Taxes\Query
DataStore
API\Reports\Taxes\Stats\DataStore.
Query
API\Reports\Taxes\Stats\Query
Segmenter
Date & time interval and numeric range handling class for Reporting API.
TimeInterval
Date & time interval and numeric range handling class for Reporting API.
DataStore
API\Reports\Variations\DataStore.
Query
API\Reports\Variations\Query
DataStore
API\Reports\Variations\Stats\DataStore.
Query
API\Reports\Variations\Stats\Query
Segmenter
Date & time interval and numeric range handling class for Reporting API.
Package
Main package class.
DataSourcePoller
Specs data source poller class.
CurrentDateTimeProvider
Current DateTime Provider.
DeprecatedClassFacade
A facade to allow deprecating an entire class.
FeaturePlugin
Feature plugin main class.
Init
Loads assets related to the async category field for the product editor.
Features
Features Class.
LaunchYourStore
Takes care of Launch Your Store related actions.
DefaultMarketingRecommendations
Default Marketing Recommendations
Init
Marketing Recommendations engine.
MarketingRecommendationsDataSourcePoller
Specs data source poller class for marketing recommendations.
Onboarding
Contains backend logic for the onboarding profile and checklist feature.
DeprecatedExtendedTask
DeprecatedExtendedTask class.
DeprecatedOptions
DeprecatedOptions class.
Init
Contains the logic for completing onboarding tasks.
Task
Task class.
TaskList
Task List class.
TaskLists
Task Lists class.
TaskListSection
Task List section class.
AdditionalPayments
Payments Task
Appearance
Appearance Task
CustomizeStore
Customize Your Store Task
ExperimentalShippingRecommendation
Shipping Task
GetMobileApp
Get Mobile App Task
LaunchYourStore
Launch Your Store Task
Marketing
Marketing Task
Payments
Payments Task
Products
Products Task
Purchase
Purchase Task
ReviewShippingOptions
Review Shipping Options Task
Shipping
Shipping Task
StoreConnect
Connect store to WooCommerce.com Task
StoreCreation
Store Details Task
StoreDetails
Store Details Task
Tax
Tax Task
TourInAppMarketplace
Tour In-App Marketplace task
WooCommercePayments
WooCommercePayments Task
DefaultPaymentGateways
Default Payment Gateways
EvaluateSuggestion
Evaluates the spec and returns the evaluated suggestion.
Init
Remote Payment Methods engine.
PaymentGatewaysController
PaymentGateway class
PaymentGatewaySuggestionsDataSourcePoller
Specs data source poller class for payment gateway suggestions.
BlockRegistry
Product block registration and style registration functionality.
BlockTemplateUtils
Utils for block templates.
Init
Loads assets related to the product block editor.
ProductFormsController
Handle retrieval of product forms.
ProductTemplate
The Product Template that represents the relation between the Product and the LayoutTemplate (ProductFormTemplateInterface)
RedirectionController
Handle redirecting to the old or new editor based on features and support.
Tracks
Add tracks for the product block editor.
DefaultShippingPartners
Default Shipping Partners
ShippingPartnerSuggestions
Class ShippingPartnerSuggestions
ShippingPartnerSuggestionsDataSourcePoller
Specs data source poller class for shipping partner suggestions.
TransientNotices
Shows print shipping label banner on edit order page.
Loader
Loader Class.
InstalledExtensions
Installed Marketing Extensions class.
MarketingCampaign
MarketingCampaign class
MarketingCampaignType
MarketingCampaignType class
MarketingChannels
MarketingChannels repository class
Price
Price class
DataStore
WC Admin Note Data Store (Custom Tables)
WC_Admin_Note
WC_Admin_Note.
WC_Admin_Notes
WC_Admin_Notes.
WC_Admin_Notes_Coupon_Page_Moved
WC_Admin_Notes_Coupon_Page_Moved.
WC_Admin_Notes_Customize_Store_With_Blocks
WC_Admin_Notes_Customize_Store_With_Blocks.
WC_Admin_Notes_Edit_Products_On_The_Move
WC_Admin_Notes_Edit_Products_On_The_Move.
WC_Admin_Notes_EU_VAT_Number
WC_Admin_Notes_EU_VAT_Number.
WC_Admin_Notes_Facebook_Marketing_Expert
WC_Admin_Notes_Facebook_Marketing_Expert.
WC_Admin_Notes_First_Product
WC_Admin_Notes_First_Product.
WC_Admin_Notes_Giving_Feedback_Notes
WC_Admin_Notes_Giving_Feedback_Notes.
WC_Admin_Notes_Install_JP_And_WCS_Plugins
WC_Admin_Notes_Install_JP_And_WCS_Plugins.
WC_Admin_Notes_Launch_Checklist
WC_Admin_Notes_Launch_Checklist.
WC_Admin_Notes_Migrate_From_Shopify
WC_Admin_Notes_Migrate_From_Shopify.
WC_Admin_Notes_Mobile_App
WC_Admin_Notes_Mobile_App.
WC_Admin_Notes_New_Sales_Record
WC_Admin_Notes_New_Sales_Record.
WC_Admin_Notes_Onboarding_Email_Marketing
WC_Admin_Notes_Onboarding_Email_Marketing.
WC_Admin_Notes_Onboarding_Payments
WC_Admin_Notes_Onboarding_Payments.
WC_Admin_Notes_Online_Clothing_Store
WC_Admin_Notes_Online_Clothing_Store.
WC_Admin_Notes_Order_Milestones
WC_Admin_Notes_Order_Milestones.
WC_Admin_Notes_Performance_On_Mobile
WC_Admin_Notes_Performance_On_Mobile.
WC_Admin_Notes_Personalize_Store
WC_Admin_Notes_Personalize_Store.
WC_Admin_Notes_Real_Time_Order_Alerts
WC_Admin_Notes_Real_Time_Order_Alerts.
WC_Admin_Notes_Selling_Online_Courses
WC_Admin_Notes_Selling_Online_Courses.
WC_Admin_Notes_Tracking_Opt_In
WC_Admin_Notes_Tracking_Opt_In.
WC_Admin_Notes_Woo_Subscriptions_Notes
WC_Admin_Notes_Woo_Subscriptions_Notes.
WC_Admin_Notes_WooCommerce_Payments
WC_Admin_Notes_WooCommerce_Payments.
WC_Admin_Notes_WooCommerce_Subscriptions
WC_Admin_Notes_WooCommerce_Subscriptions.
Note
Note class.
Notes
Admin Notes class.
NotesUnavailableException
Notes\NotesUnavailableException class.
Order
WC_Order subclass.
OrderRefund
WC_Order_Refund subclass.
ThemeUpgrader
Admin\Overrides\ThemeUpgrader Class.
ThemeUpgraderSkin
Admin\Overrides\ThemeUpgraderSkin Class.
PageController
PageController
PluginsHelper
Class PluginsHelper
PluginsInstaller
Class PluginsInstaller
AsyncPluginsInstallLogger
A logger to log plugin installation progress in real time to an option.
PluginsProvider
Plugins Provider.
BaseLocationCountryRuleProcessor
Rule processor that performs a comparison operation against the base location - country.
BaseLocationStateRuleProcessor
Rule processor that performs a comparison operation against the base location - state.
ComparisonOperation
Compare two operands using the specified operation.
EvaluateAndGetStatus
Evaluates the spec and returns a status.
FailRuleProcessor
Rule processor that fails.
GetRuleProcessor
Class encapsulating getting the processor for a given rule type.
NoteStatusRuleProcessor
Rule processor that compares against the status of another note.
NotRuleProcessor
Rule processor that negates the rules in the rule's operand.
OnboardingProfileRuleProcessor
Rule processor that performs a comparison operation against a value in the onboarding profile.
OptionRuleProcessor
Rule processor that performs a comparison operation against an option value.
OrderCountRuleProcessor
Rule processor for publishing based on the number of orders.
OrdersProvider
Provider for order-related queries and operations.
OrRuleProcessor
Rule processor that performs an OR operation on the rule's left and right operands.
PassRuleProcessor
Rule processor that passes.
PluginsActivatedRuleProcessor
Rule processor for sending when the provided plugins are activated.
PluginVersionRuleProcessor
Rule processor for sending when the provided plugin is activated and matches the specified version.
ProductCountRuleProcessor
Rule processor that performs a comparison operation against the number of products.
PublishAfterTimeRuleProcessor
Rule processor for sending after a specified date/time.
PublishBeforeTimeRuleProcessor
Rule processor for sending before a specified date/time.
RemoteInboxNotificationsDataSourcePoller
Specs data source poller class.
RemoteInboxNotificationsEngine
Remote Inbox Notifications engine.
RuleEvaluator
Evaluate the given rules as an AND operation - return false early if a rule evaluates to false.
SpecRunner
Runs a single spec.
StoredStateRuleProcessor
Rule processor that performs a comparison operation against a value in the stored state object.
StoredStateSetupForProducts
Handles stored state setup for products.
TotalPaymentsVolumeProcessor
Rule processor that passes when a store's payments volume exceeds a provided amount.
WCAdminActiveForProvider
WCAdminActiveForProvider class
WCAdminActiveForRuleProcessor
Rule processor for publishing if wc-admin has been active for at least the given number of seconds.
WooCommerceAdminUpdatedRuleProcessor
Rule processor for sending when WooCommerce Admin has been updated.
DataSourcePoller
Specs data source poller class.
RemoteSpecsEngine
RemoteSpecsEngine class.
BaseLocationCountryRuleProcessor
Rule processor that performs a comparison operation against the base location - country.
BaseLocationStateRuleProcessor
Rule processor that performs a comparison operation against the base location - state.
ComparisonOperation
Compare two operands using the specified operation.
EvaluateAndGetStatus
Evaluates the spec and returns a status.
FailRuleProcessor
Rule processor that fails.
GetRuleProcessor
Class encapsulating getting the processor for a given rule type.
NoteStatusRuleProcessor
Rule processor that compares against the status of another note.
NotRuleProcessor
Rule processor that negates the rules in the rule's operand.
OnboardingProfileRuleProcessor
Rule processor that performs a comparison operation against a value in the onboarding profile.
OptionRuleProcessor
Rule processor that performs a comparison operation against an option value.
OrderCountRuleProcessor
Rule processor for publishing based on the number of orders.
OrdersProvider
Provider for order-related queries and operations.
OrRuleProcessor
Rule processor that performs an OR operation on the rule's left and right operands.
PassRuleProcessor
Rule processor that passes.
PluginsActivatedRuleProcessor
Rule processor for sending when the provided plugins are activated.
PluginVersionRuleProcessor
Rule processor for sending when the provided plugin is activated and matches the specified version.
ProductCountRuleProcessor
Rule processor that performs a comparison operation against the number of products.
PublishAfterTimeRuleProcessor
Rule processor for sending after a specified date/time.
PublishBeforeTimeRuleProcessor
Rule processor for sending before a specified date/time.
RuleEvaluator
Evaluate the given rules as an AND operation - return false early if a rule evaluates to false.
StoredStateRuleProcessor
Rule processor that performs a comparison operation against a value in the stored state object.
StoredStateSetupForProducts
Handles stored state setup for products.
TotalPaymentsVolumeProcessor
Rule processor that passes when a store's payments volume exceeds a provided amount.
WCAdminActiveForProvider
WCAdminActiveForProvider class
WCAdminActiveForRuleProcessor
Rule processor for publishing if wc-admin has been active for at least the given number of seconds.
WooCommerceAdminUpdatedRuleProcessor
Rule processor for sending when WooCommerce Admin has been updated.
ReportCSVEmail
ReportCSVEmail Class.
ReportCSVExporter
ReportCSVExporter Class.
ReportExporter
ReportExporter Class.
ReportsSync
ReportsSync Class.
WCAdminHelper
Class WCAdminHelper
Autoloader
Autoloader class.
Configuration
Class Configuration
Connection
Class Connection
ContentProcessor
ContentProcessor class.
PatternsHelper
Patterns Helper class.
UpdatePatterns
Pattern Images class.
UpdateProducts
Pattern Images class.
Api
The Api class provides an interface to various asset registration helpers.
AssetDataRegistry
Class instance for registering data used on the current view session by assets.
AbstractBlock
AbstractBlock class.
AbstractDynamicBlock
AbstractDynamicBlock class.
AbstractInnerBlock
AbstractInnerBlock class.
AbstractProductGrid
AbstractProductGrid class.
ActiveFilters
ActiveFilters class.
AddToCartForm
CatalogSorting class.
AllProducts
AllProducts class.
AllReviews
AllReviews class.
AttributeFilter
AttributeFilter class.
Breadcrumbs
CatalogSorting class.
CartAcceptedPaymentMethodsBlock
CartAcceptedPaymentMethodsBlock class.
CartCrossSellsBlock
CartCrossSellsBlock class.
CartCrossSellsProductsBlock
CartCrossSellsProductsBlock class.
CartExpressPaymentBlock
CartExpressPaymentBlock class.
CartItemsBlock
CartItemsBlock class.
CartLineItemsBlock
CartLineItemsBlock class.
CartOrderSummaryBlock
CartOrderSummaryBlock class.
CartOrderSummaryCouponFormBlock
CartOrderSummaryCouponFormBlock class.
CartOrderSummaryDiscountBlock
CartOrderSummaryDiscountBlock class.
CartOrderSummaryFeeBlock
CartOrderSummaryFeeBlock class.
CartOrderSummaryHeadingBlock
CartOrderSummaryHeadingBlock class.
CartOrderSummaryShippingBlock
CartOrderSummaryShippingBlock class.
CartOrderSummarySubtotalBlock
CartOrderSummarySubtotalBlock class.
CartOrderSummaryTaxesBlock
CartOrderSummaryTaxesBlock class.
CartOrderSummaryTotalsBlock
CartOrderSummaryTotalsBlock class.
CartTotalsBlock
CartTotalsBlock class.
CatalogSorting
CatalogSorting class.
CheckoutActionsBlock
CheckoutActionsBlock class.
CheckoutAdditionalInformationBlock
CheckoutAdditionalInformationBlock class.
CheckoutBillingAddressBlock
CheckoutBillingAddressBlock class.
CheckoutContactInformationBlock
CheckoutContactInformationBlock class.
CheckoutExpressPaymentBlock
CheckoutExpressPaymentBlock class.
CheckoutFieldsBlock
CheckoutFieldsBlock class.
CheckoutOrderNoteBlock
CheckoutOrderNoteBlock class.
CheckoutOrderSummaryBlock
CheckoutOrderSummaryBlock class.
CheckoutOrderSummaryCartItemsBlock
CheckoutOrderSummaryCartItemsBlock class.
CheckoutOrderSummaryCouponFormBlock
CheckoutOrderSummaryCouponFormBlock class.
CheckoutOrderSummaryDiscountBlock
CheckoutOrderSummaryDiscountBlock class.
CheckoutOrderSummaryFeeBlock
CheckoutOrderSummaryFeeBlock class.
CheckoutOrderSummaryShippingBlock
CheckoutOrderSummaryShippingBlock class.
CheckoutOrderSummarySubtotalBlock
CheckoutOrderSummarySubtotalBlock class.
CheckoutOrderSummaryTaxesBlock
CheckoutOrderSummaryTaxesBlock class.
CheckoutOrderSummaryTotalsBlock
CheckoutOrderSummaryTotalsBlock class.
CheckoutPaymentBlock
CheckoutPaymentBlock class.
CheckoutPickupOptionsBlock
CheckoutPickupOptionsBlock class.
CheckoutShippingAddressBlock
CheckoutShippingAddressBlock class.
CheckoutShippingMethodBlock
CheckoutShippingMethodBlock class.
CheckoutShippingMethodsBlock
CheckoutShippingMethodsBlock class.
CheckoutTermsBlock
CheckoutTermsBlock class.
CheckoutTotalsBlock
CheckoutTotalsBlock class.
ComingSoon
ComingSoon class.
CustomerAccount
CustomerAccount class.
EmptyCartBlock
EmptyCartBlock class.
EmptyMiniCartContentsBlock
EmptyMiniCartContentsBlock class.
FeaturedCategory
FeaturedCategory class.
FeaturedItem
FeaturedItem class.
FeaturedProduct
FeaturedProduct class.
FilledCartBlock
FilledCartBlock class.
FilledMiniCartContentsBlock
FilledMiniCartContentsBlock class.
FilterWrapper
FilterWrapper class.
HandpickedProducts
HandpickedProducts class.
MiniCartCartButtonBlock
MiniCartCartButtonBlock class.
MiniCartCheckoutButtonBlock
MiniCartCheckoutButtonBlock class.
MiniCartFooterBlock
MiniCartFooterBlock class.
MiniCartItemsBlock
MiniCartItemsBlock class.
MiniCartProductsTableBlock
MiniCartProductsTableBlock class.
MiniCartShoppingButtonBlock
MiniCartShoppingButtonBlock class.
MiniCartTitleBlock
MiniCartTitleBlock class.
MiniCartTitleItemsCounterBlock
MiniCartTitleItemsCounterBlock class.
MiniCartTitleLabelBlock
MiniCartTitleLabelBlock class.
AbstractOrderConfirmationBlock
AbstractOrderConfirmationBlock class.
AdditionalFields
AdditionalFields class.
AdditionalFieldsWrapper
AdditionalFieldsWrapper class.
AdditionalInformation
AdditionalInformation class.
BillingAddress
BillingAddress class.
BillingWrapper
BillingWrapper class.
Downloads
Downloads class.
DownloadsWrapper
DownloadsWrapper class.
ShippingAddress
ShippingAddress class.
ShippingWrapper
ShippingWrapper class.
Status
Status class.
Summary
Summary class.
Totals
Totals class.
TotalsWrapper
TotalsWrapper class.
PriceFilter
PriceFilter class.
ProceedToCheckoutBlock
ProceedToCheckoutBlock class.
ProductAverageRating
ProductAverageRating class.
ProductBestSellers
ProductBestSellers class.
ProductButton
ProductButton class.
ProductCategories
ProductCategories class.
ProductCategory
ProductCategory class.
ProductCollection
ProductCollection class.
ProductCollectionNoResults
ProductCollectionNoResults class.
ProductDetails
ProductDetails class.
ProductFilter
Product Filter Block.
ProductFilterActive
Product Filter: Active Block.
ProductFilterAttribute
Product Filter: Attribute Block.
ProductFilterClearButton
Product Filter: Clear Button Block.
ProductFilterPrice
Product Filter: Price Block.
ProductFilters
ProductFilters class.
ProductFiltersOverlay
ProductFiltersOverlay class.
ProductFilterStockStatus
Product Filter: Stock Status Block.
ProductGallery
ProductGallery class.
ProductGalleryLargeImage
ProductGalleryLargeImage class.
ProductGalleryLargeImageNextPrevious
ProductGalleryLargeImage class.
ProductGalleryPager
ProductGalleryPager class.
ProductGalleryThumbnails
ProductGalleryThumbnails class.
ProductImage
ProductImage class.
ProductImageGallery
ProductImageGallery class.
ProductNew
ProductNew class.
ProductOnSale
ProductOnSale class.
ProductPrice
ProductPrice class.
ProductQuery
ProductQuery class.
ProductRating
ProductRating class.
ProductRatingCounter
ProductRatingCounter class.
ProductRatingStars
ProductRatingStars class.
ProductResultsCount
ProductResultsCount class.
ProductReviews
ProductReviews class.
ProductSaleBadge
ProductSaleBadge class.
ProductsByAttribute
ProductsByAttribute class.
ProductSearch
ProductSearch class.
ProductSKU
ProductSKU class.
ProductStockIndicator
ProductStockIndicator class.
ProductSummary
ProductSummary class.
ProductTag
ProductTag class.
ProductTemplate
ProductTemplate class.
ProductTitle
ProductTitle class.
ProductTopRated
ProductTopRated class.
RatingFilter
PriceFilter class.
RelatedProducts
RelatedProducts class.
ReviewsByCategory
ReviewsByCategory class.
ReviewsByProduct
ReviewsByProduct class.
SingleProduct
SingleProduct class.
StockFilter
AttributeFilter class.
StoreNotices
StoreNotices class.
Bootstrap
Takes care of bootstrapping the plugin.
Package
Main package class.
CheckoutFields
Service class managing checkout fields and its related extensibility points.
CheckoutFieldsAdmin
Service class managing checkout fields and its related extensibility points in the admin area.
CheckoutFieldsFrontend
Service class managing checkout fields and its related extensibility points on the frontend.
CreateAccount
Service class implementing new create account emails used for order processing via the Block Based Checkout.
CustomerNewAccount
Customer New Account.
GoogleAnalytics
Service class to integrate Blocks with the Google Analytics extension,
Hydration
Service class that handles hydration of API data for blocks.
ReviewCheckoutTask
Review the cart/checkout Task
TasksController
Onboarding Tasks Controller
IntegrationRegistry
Class used for tracking registered integrations with various Block types.
WC_Interactivity_Initial_State
Manages the initial state of the Interactivity API store in the server and its serialization so it can be restored in the browser upon hydration.
Migration
Takes care of the migrations.
Options
Contains all the option names used by the plugin.
Package
Main package class.
AIPatterns
AIPatterns class.
PatternRegistry
PatternRegistry class.
PTKClient
PatternsToolkit class.
PTKPatternsStore
PTKPatterns class.
Api
The Api class provides an interface to payment method registration.
AbstractPaymentMethodType
AbstractPaymentMethodType class.
BankTransfer
Bank Transfer (BACS) payment method integration
CashOnDelivery
Cash on Delivery (COD) payment method integration
Cheque
Cheque payment method integration
PayPal
PayPal Standard payment method integration
PaymentMethodRegistry
Class used for interacting with payment method types.
QueryFilters
Process the query data for filtering purposes.
AbstractDependencyType
An abstract class for dependency types.
Container
A simple Dependency Injection Container
FactoryType
Definition for the FactoryType dependency type.
SharedType
A definition for the SharedType dependency type.
PickupLocation
Local Pickup Shipping Method.
BlocksWpQuery
BlocksWpQuery query.
BlockTemplateUtils
Utility methods used for serving block templates from WooCommerce Blocks.
CartCheckoutUtils
Class containing utility methods for dealing with the Cart and Checkout blocks.
MiniCartUtils
Utility methods used for the Mini Cart block.
ProductCollectionUtils
Utility methods used for the Product Collection block.
ProductGalleryUtils
Utility methods used for the Product Gallery block.
StyleAttributesUtils
StyleAttributesUtils class used for getting class and style from attributes.
Utils
Utils class
OrderCache
A class to cache order objects.
OrderCacheController
A class to control the usage of the orders cache.
CacheException
Exception thrown by classes derived from ObjectCache.
ObjectCache
Base class for caching objects (or associative arrays) that have a unique identifier.
WPCacheEngine
Implementation of CacheEngine that uses the built-in WordPress cache.
ReserveStock
Stock Reservation class.
ReserveStockException
ReserveStockException class.
Container
PSR11 compliant dependency injection container for WooCommerce.
CLIRunner
CLI tool for migrating order data to/from custom table.
PostToOrderTableMigrator
Helper class to migrate records from the WordPress post table to the custom order table (and only that table - PostsToOrdersMigrationController is used for fully migrating orders).
MigrationHelper
Helper class to assist with migration related operations.
LayoutTemplateRegistry
Layout template registry.
Packages
Packages class.
ActionsProxy
Proxy for interacting with WordPress actions and filters.
LegacyProxy
Proxy class to access legacy WooCommerce functionality.
Authentication
Authentication class.
InvalidStockLevelsInCartException
InvalidStockLevelsInCartException class.
NotPurchasableException
NotPurchasableException class.
OutOfStockException
OutOfStockException class.
PartialOutOfStockException
PartialOutOfStockException class.
RouteException
RouteException class.
StockAvailabilityException
StockAvailabilityException class.
TooManyInCartException
TooManyInCartException class.
CurrencyFormatter
Currency Formatter.
DefaultFormatter
Default Formatter.
MoneyFormatter
Money Formatter.
Formatters
Formatters class.
Legacy
Legacy class.
PaymentContext
PaymentContext class.
PaymentResult
PaymentResult class.
AbstractCartRoute
Abstract Cart Route
AbstractRoute
AbstractRoute class.
AbstractTermsRoute
AbstractTermsRoute class.
Images
Patterns class.
Batch
Batch Route class.
Cart
Cart class.
CartAddItem
CartAddItem class.
CartApplyCoupon
CartApplyCoupon class.
CartCoupons
CartCoupons class.
CartCouponsByCode
CartCouponsByCode class.
CartExtensions
CartExtensions class.
CartItems
CartItems class.
CartItemsByKey
CartItemsByKey class.
CartRemoveCoupon
CartRemoveCoupon class.
CartRemoveItem
CartRemoveItem class.
CartSelectShippingRate
CartSelectShippingRate class.
CartUpdateCustomer
CartUpdateCustomer class.
CartUpdateItem
CartUpdateItem class.
Checkout
Checkout class.
CheckoutOrder
CheckoutOrder class.
Order
Order class.
Patterns
Patterns class.
ProductAttributes
ProductAttributes class.
ProductAttributesById
ProductAttributesById class.
ProductAttributeTerms
ProductAttributeTerms class.
ProductCategories
ProductCategories class.
ProductCategoriesById
ProductCategoriesById class.
ProductCollectionData
ProductCollectionData route.
ProductReviews
ProductReviews class.
Products
Products class.
ProductsById
ProductsById class.
ProductsBySlug
ProductsBySlug class.
ProductTags
ProductTags class.
RoutesController
RoutesController class.
SchemaController
SchemaController class.
ExtendSchema
Provides utility functions to extend Store API schemas.
AbstractAddressSchema
AddressSchema class.
AbstractSchema
AbstractSchema class.
BatchSchema
BatchSchema class.
BillingAddressSchema
BillingAddressSchema class.
CartCouponSchema
CartCouponSchema class.
CartExtensionsSchema
Class CartExtensionsSchema
CartFeeSchema
CartFeeSchema class.
CartItemSchema
CartItemSchema class.
CartSchema
CartSchema class.
CartShippingRateSchema
CartShippingRateSchema class.
CheckoutOrderSchema
CheckoutOrderSchema class.
CheckoutSchema
CheckoutSchema class.
ErrorSchema
ErrorSchema class.
ImageAttachmentSchema
ImageAttachmentSchema class.
ItemSchema
ItemSchema class.
OrderCouponSchema
OrderCouponSchema class.
OrderFeeSchema
OrderFeeSchema class.
OrderItemSchema
OrderItemSchema class.
OrderSchema
OrderSchema class.
PatternsSchema
OrderSchema class.
ProductAttributeSchema
ProductAttributeSchema class.
ProductCategorySchema
ProductCategorySchema class.
ProductCollectionDataSchema
ProductCollectionDataSchema class.
ProductReviewSchema
ProductReviewSchema class.
ProductSchema
ProductSchema class.
ShippingAddressSchema
ShippingAddressSchema class.
TermSchema
TermSchema class.
SessionHandler
SessionHandler class
StoreApi
StoreApi Main Class.
ArrayUtils
ArrayUtils class used for custom functions to operate on arrays
CartController
Woo Cart Controller class.
JsonWebToken
JsonWebToken class.
LocalPickupUtils
Util class for local pickup related functionality, this contains methods that need to be accessed from places besides the ShippingController, i.e. the OrderController.
NoticeHandler
NoticeHandler class.
OrderController
OrderController class.
Pagination
Pagination class.
ProductQuery
Product Query class.
ProductQueryFilters
Product Query filters class.
QuantityLimits
QuantityLimits class.
RateLimits
RateLimits class.
SanitizationUtils
SanitizationUtils class.
ValidationUtils
ValidationUtils class.
ArrayUtil
A class of utilities for dealing with arrays.
DiscountsUtil
The DiscountsUtil class provides utilities to assist discounts calculation and validation.
FeaturesUtil
Class with methods that allow to retrieve information about the existing WooCommerce features, also has methods for WooCommerce plugins to declare (in)compatibility with the features.
I18nUtil
A class of utilities for dealing with internationalization.
LoggingUtil
A class of utilities for dealing with logging.
NumberUtil
A class of utilities for dealing with numbers.
OrderUtil
A class of utilities for dealing with orders.
PluginUtil
A class of utilities for dealing with plugins.
RestApiUtil
Utility methods related to the REST API.
StringUtil
A class of utilities for dealing with strings.
TimeUtil
Class with date and time utilities.
ArgumentResolverTrait
ContainerAwareTrait
ExportableTraits
ExportableTraits class.
TaskTraits
TaskTraits class.
NoteTraits
NoteTraits class.
OrderTraits
OrderTraits class.
SchedulerTraits
SchedulerTraits class.
BlockHooksTrait
BlockHooksTrait
CacheNameSpaceTrait
Implements namespacing algorithm to simulate grouping and namespacing for wp_cache, memcache and other caching engines that don't support grouping natively.
CheckoutTrait
CheckoutTrait
DraftOrderTrait
DraftOrderTrait
OrderAuthorizationTrait
OrderAuthorizationTrait
ProductItemTrait
ProductItemTrait

Table of Contents

wc_admin_get_feature_config()  : mixed
woocommerce_register_additional_checkout_field()  : mixed
Register a checkout field.
__experimental_woocommerce_blocks_register_checkout_field()  : mixed
Register a checkout field.
woocommerce_interactivity_add_client_side_navigation_meta_tag()  : mixed
Print client-side navigation meta tag (hard-coded for now).
wc_initial_state()  : array<string|int, mixed>
Merge data into the state with the given namespace.
woocommerce_interactivity_move_interactive_scripts_to_the_footer()  : mixed
Move interactive scripts to the footer. This is a temporary measure to make it work with `wc_store` and it should be replaced with deferred scripts or modules.
woocommerce_interactivity_register_runtime()  : mixed
Register the Interactivity API runtime and make it available to be enqueued as a dependency in interactive blocks.
woocommerce_store_api_register_endpoint_data()  : mixed
Register endpoint data under a specified namespace.
woocommerce_store_api_register_update_callback()  : mixed
Add callback functions that can be executed by the cart/extensions endpoint.
woocommerce_store_api_register_payment_requirements()  : mixed
Registers and validates payment requirements callbacks.
woocommerce_store_api_get_formatter()  : FormatterInterface
Returns a formatter instance.
WC()  : WooCommerce
Returns the main instance of WC.
wc_get_container()  : Container
Returns the WooCommerce object container.

Functions

woocommerce_register_additional_checkout_field()

Register a checkout field.

woocommerce_register_additional_checkout_field(array<string|int, mixed> $options) : mixed
Parameters
$options : array<string|int, mixed>

Field arguments. See CheckoutFields::register_checkout_field() for details.

Tags
throws
Exception

If field registration fails.

__experimental_woocommerce_blocks_register_checkout_field()

Register a checkout field.

__experimental_woocommerce_blocks_register_checkout_field(array<string|int, mixed> $options) : mixed
Parameters
$options : array<string|int, mixed>

Field arguments. See CheckoutFields::register_checkout_field() for details.

Tags
throws
Exception

If field registration fails.

deprecated
5.6.0

Use woocommerce_register_additional_checkout_field() instead.

wc_initial_state()

Merge data into the state with the given namespace.

wc_initial_state(string $namespace[, array<string|int, mixed> $data = null ]) : array<string|int, mixed>
Parameters
$namespace : string

Namespace.

$data : array<string|int, mixed> = null

State to merge.

Move interactive scripts to the footer. This is a temporary measure to make it work with `wc_store` and it should be replaced with deferred scripts or modules.

woocommerce_interactivity_move_interactive_scripts_to_the_footer() : mixed

woocommerce_interactivity_register_runtime()

Register the Interactivity API runtime and make it available to be enqueued as a dependency in interactive blocks.

woocommerce_interactivity_register_runtime() : mixed

woocommerce_store_api_register_endpoint_data()

Register endpoint data under a specified namespace.

woocommerce_store_api_register_endpoint_data(array<string|int, mixed> $args) : mixed
Parameters
$args : array<string|int, mixed>

Args to pass to register_endpoint_data.

Tags
see
ExtendSchema::register_endpoint_data()
returns

boolean|\WP_Error True on success, WP_Error on fail.

woocommerce_store_api_register_update_callback()

Add callback functions that can be executed by the cart/extensions endpoint.

woocommerce_store_api_register_update_callback(array<string|int, mixed> $args) : mixed
Parameters
$args : array<string|int, mixed>

Args to pass to register_update_callback.

Tags
see
ExtendSchema::register_update_callback()
returns

boolean|\WP_Error True on success, WP_Error on fail.

woocommerce_store_api_register_payment_requirements()

Registers and validates payment requirements callbacks.

woocommerce_store_api_register_payment_requirements(array<string|int, mixed> $args) : mixed
Parameters
$args : array<string|int, mixed>

Args to pass to register_payment_requirements.

Tags
see
ExtendSchema::register_payment_requirements()
returns

boolean|\WP_Error True on success, WP_Error on fail.

wc_get_container()

Returns the WooCommerce object container.

wc_get_container() : Container

Code in the includes directory should use the container to get instances of classes in the src directory.

Tags
since
4.4.0