WooCommerce Code Reference

WooCommerce

Packages

Abstracts

Classes

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

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.

HasAlias

Allows a step to have an alias.

StepExporter

Interface StepExporter

StepProcessor

Interface StepProcessor

Email_Editor_Logger_Interface

Interface for email editor loggers.

Block_Renderer

Interface Block_Renderer

Postprocessor

Interface for postprocessors.

Preprocessor

Interface Preprocessor

HttpAwareException

Provides information for converting exceptions to HTTP responses.

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_Brands_Admin

WC_Brands_Admin class.

WC_Admin

WC_Admin class.

WC_Helper_Sanitization

WC_Helper_Sanitization Class

WC_Product_Usage_Notice

Product usage notice class.

WC_Woo_Helper_Connection

WC_Helper_Plugin Class

WC_Notes_Refund_Returns

WC_Notes_Refund_Returns.

WC_Notes_Run_Db_Update

WC_Notes_Run_Db_Update.

WC_Settings_Page

WC_Settings_Page.

WC_Settings_Payment_Gateways

WC_Settings_Payment_Gateways.

WC_Settings_Point_Of_Sale

WC_Settings_Point_Of_Sale.

BlockTemplateUtilsDuplicated

BlockTemplateUtils class used for serving block templates from Woo Blocks.

WC_Brands_Block_Templates

Utils for compatibility with WooCommerce Full Site Editor Blocks

WC_Brands_Brand_Settings_Manager

Brand settings manager.

WC_Brands_Coupons

WC_Brands_Coupons class.

WC_Brands

WC_Brands class.

WC_Emails

Emails class.

WC_Meta_Data

Meta data class.

WC_Shipping_Rate

Shipping rate 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.

WC_Product_Usage_Rule_Set

WC_Product_Usage_Rule_Set.

WC_Product_Usage

Product usagee

WC_Product_Collection_Block_Tracking

This class adds actions to track usage of the Product Collection Block.

WC_REST_WCCOM_Site_Controller

REST API WCCOM Site Base REST API Controller Astract Class.

WC_REST_WCCOM_Site_Connection_Controller

REST API WC_REST_WCCOM_Site_Connection_Controller Class.

MobileDetect

Auto-generated isXXXX() magic methods.

BuiltInExporters

Built-in exporters.

ClassExtractor

Class ClassExtractor

ImportCli

Class ImportCli

Cli

Class Cli.

ImportActivatePlugin

Class ImportActivatePlugin

ImportInstallPlugin

Class ImportInstallPlugin

Logger

Class Logger

LocalPluginResourceStorage

Class LocalPluginResourceStorage

LocalThemeResourceStorage

Class LocalThemeResourceStorage

OrgThemeResourceStorage

Class OrgThemeResourceStorage

ResourceStorages

Class ResourceStorages

CliResultFormatter

Class CliResultFormatter

JsonResultFormatter

Class JsonResultFormatter

JsonSchema

Class JsonSchema

StepProcessorResult

A class returned by StepProcessor classes containing result of the process and messages.

SetSiteOptions

Set site options step.

Step

Abstract class Step

Util

Utility functions.

Bootstrap

Bootstrap class for initializing the Email Editor functionality.

Email_Css_Inliner

Class for inlining CSS in HTML emails.

Email_Editor_Container

Main package class.

Package

Main package class.

Dependency_Check

This class is responsible checking the dependencies of the email editor.

Email_Api_Controller

Class for email API controller.

Email_Editor

Email editor class.

Email_Styles_Schema

Class for email styles schema.

Personalizer

Class for replacing personalization tags with their values in the email content.

Settings_Controller

Class managing the settings for the email editor.

Theme_Controller

E-mail editor works with own theme.json which defines settings for the editor and styles for the e-mail.

User_Theme

This class is responsible for managing and accessing theme data aka email styles created by users.

Default_Email_Editor_Logger

Default implementation of the email editor logger that writes to WordPress debug log.

Email_Editor_Logger

Email Editor Logger class.

Abstract_Pattern

Abstract class for block patterns.

Patterns

Register block patterns.

HTML_Tag_Processor

Class based on WP_HTML_Tag_Processor which is extended to replace tokens with their values in the email content.

Personalization_Tag

The class represents a personalization tag that contains all necessary information for replacing the tag with its value and displaying it in the UI.

Personalization_Tags_Registry

Registry for personalization tags.

Renderer

Class Renderer

Blocks_Parser

Class Blocks_Parser

Blocks_Registry

Class Blocks_Registry

Content_Renderer

Class Content_Renderer

Process_Manager

Class Process_Manager

Flex_Layout_Renderer

This class provides functionality to render inner blocks of a block that supports reduced flex layout.

Border_Style_Postprocessor

Postprocessor that handles border-style declarations to ensure consistent rendering across email clients.

Highlighting_Postprocessor

This postprocessor replaces <mark> tags with <span> tags because mark tags are not supported across all email clients

Variables_Postprocessor

In some case the blocks HTML contains CSS variables.

Blocks_Width_Preprocessor

This class sets the width of the blocks based on the layout width or column count.

Cleanup_Preprocessor

Class Cleanup_Preprocessor

Quote_Preprocessor

Class Quote_Preprocessor

Spacing_Preprocessor

This preprocessor is responsible for setting default spacing values for blocks.

Typography_Preprocessor

This preprocessor is responsible for setting default typography values for blocks.

Template

The class represents a template

Templates_Registry

Registry for email templates.

Templates

Templates class.

Exception

Frames all exceptions ("$e instanceof Automattic\WooCommerce\EmailEditor\Exception").

RuntimeException

USE: Generic runtime error. When possible, use a more specific exception instead.

UnexpectedValueException

USE: When wrong data VALUE is received.

AccessDeniedException

USE: When an action is forbidden for given actor (although generally valid).

NotFoundException

USE: When the main resource we're interested in doesn't exist.

ConflictException

USE: When the main action produces conflict (i.e. duplicate key).

InvalidStateException

USE: An application state that should not occur. Can be subclassed for feature-specific exceptions.

NewsletterProcessingException

Frames all exceptions ("$e instanceof Automattic\WooCommerce\EmailEditor\Exception").

Initializer

Initializes the core blocks renderers.

Abstract_Block_Renderer

Shared functionality for block renderers.

Button

Renders a button block.

Buttons

Renders a buttons block.

Column

Renders a column block.

Columns

Renders a columns block.

Fallback

Fallback block renderer.

Group

Renders a group block.

Image

Renders an image block.

List_Block

Renders a list block.

List_Item

Renders a list item block.

Quote

Renders a quote block.

Social_Link

Renders a social link block.

Social_Links

Renders the social links block.

Text

This renderer covers both core/paragraph and core/heading blocks

Dom_Document_Helper

This class should guarantee that our work with the DOMDocument is unified and safe.

Social_Links_Helper

This class should provide helper functions for the Social Links block.

Builder

Builder for creating schema objects.

Schema

Represents abastract schema.

Validation_Exception

Exception thrown when validation fails.

Validator

Validates and sanitizes values based on a schema.

Any_Of_Schema

Represents a schema that allows a value to match any of the given schemas.

Array_Schema

Represents a schema for an array.

Boolean_Schema

Represents a schema for a boolean.

Integer_Schema

Represents a schema for an integer.

Null_Schema

Represents a schema for a null.

Number_Schema

Represents a schema for a number.

Object_Schema

Represents a schema for an object.

One_Of_Schema

Represents a schema that allows a value to match one of the given schemas.

String_Schema

Represents a schema for a string.

Experiments

Data controller.

Options

Options Controller.

Cache

REST API Reports Cache class.

DataStore

API\Reports\Categories\DataStore.

Query

API\Reports\Categories\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

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

GenericController

{@see WC_REST_Reports_Controller WC REST API Reports Controller} extended to be shared as a generic base for all Analytics reports controllers.

GenericQuery

A generic class for a report-specific query to be used in Analytics.

GenericStatsController

Generic base for all stats controllers.

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 This query takes no arguments, so we do not inherit from GenericQuery.

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.

Settings

Settings Controller.

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.

ExportWCCoreProfilerOptions

ExportWCCoreProfilerOptions class

ExportWCPaymentGateways

ExportWCPaymentGateways class

Init

Class Init

SettingOptions

Handles getting options from WooCommerce settings pages.

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.

MiscRecommendationsDataSourcePoller

Specs data source poller class for misc recommendations.

RemovedDeprecated

Handle calls to deprecated methods.

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

ExperimentalShippingRecommendation

Shipping Task

ExtendStore

ExtendStore Task

GetMobileApp

Get Mobile App Task

LaunchYourStore

Launch Your Store Task

Marketing

Marketing Task

Payments

Payments Task

Products

Products Task

ReviewShippingOptions

Review Shipping Options Task

Shipping

Shipping 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.

Init

Loads assets related to the product block editor.

Init

Contains backend logic for the Settings feature.

Transformer

Transforms WooCommerce settings data into a structured format with logical groupings.

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_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.

RemoteInboxNotificationsDataSourcePoller

Specs data source poller class.

RemoteInboxNotificationsEngine

Remote Inbox Notifications engine.

SpecRunner

Runs a single spec.

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.

ContextPluginsRuleProcessor

Rule processor for context_plugins rules.

EvaluateAndGetStatus

Evaluates the spec and returns a status.

EvaluateOverrides

Evaluates `overrides` property in the spec and returns the evaluated spec.

FailRuleProcessor

Rule processor that fails.

GetRuleProcessor

Class encapsulating getting the processor for a given rule type.

GetRuleProcessorForContext

A custom GetRuleProcessor class to support context_vars and context_plugins rule types.

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.

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.

AccordionGroup

AccordionGroup class.

AccordionHeader

AccordionHeader class.

AccordionItem

AccordionItem class.

AccordionPanel

AccordionPanel class.

ActiveFilters

ActiveFilters class.

AddToCartForm

CatalogSorting class.

AddToCartWithOptions

AddToCartWithOptions class.

GroupedProductItem

Block type for grouped product selector item in add to cart with options.

GroupedProductItemLabel

Block type for the label of grouped product selector items in Add to Cart + Options.

GroupedProductItemSelector

Block type for the CTA of grouped product selector items in add to cart with options.

GroupedProductSelector

Block type for grouped product selector in add to cart with options.

QuantitySelector

Block type for quantity selector in add to cart with options.

Utils

Utility methods used for the Add to Cart + Options block.

VariationSelector

Block type for variation selector in add to cart with options.

VariationSelectorAttribute

Block type for variation selector item in add to cart with options.

VariationSelectorAttributeName

Block type for variation selector attribute name in add to cart with options.

VariationSelectorAttributeOptions

Block type for variation selector attribute options in add to cart with options.

AllProducts

AllProducts class.

AllReviews

AllReviews class.

AttributeFilter

AttributeFilter class.

Breadcrumbs

Breadcrumbs class.

CartAcceptedPaymentMethodsBlock

CartAcceptedPaymentMethodsBlock class.

CartCrossSellsBlock

CartCrossSellsBlock class.

CartCrossSellsProductsBlock

CartCrossSellsProductsBlock class.

CartExpressPaymentBlock

CartExpressPaymentBlock class.

CartItemsBlock

CartItemsBlock class.

CartLineItemsBlock

CartLineItemsBlock class.

CartLink

CartLink 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.

CreateAccount

CreateAccount 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.

Controller

Controller class.

HandlerRegistry

HandlerRegistry class.

NoResults

NoResults class.

QueryBuilder

QueryBuilder class.

Renderer

Renderer class.

Utils

Utility methods used for the Product Collection block.

ProductDescription

BlockifiedProductDetails class.

ProductDetails

ProductDetails class.

ProductFilterActive

Product Filter: Active Block.

ProductFilterAttribute

Product Filter: Attribute Block.

ProductFilterCheckboxList

Product Filter: Checkbox List Block.

ProductFilterChips

Product Filter: Chips Block.

ProductFilterClearButton

Product Filter: Clear Button Block.

ProductFilterPrice

Product Filter: Price Block.

ProductFilterPriceSlider

ProductFilterPriceSlider class.

ProductFilterRemovableChips

Product Filter: Removable Chips Block.

ProductFilters

ProductFilters class.

ProductFilterStatus

Product Filter: Status Block.

ProductGallery

ProductGallery class.

ProductGalleryLargeImage

ProductGalleryLargeImage class.

ProductGalleryLargeImageNextPrevious

ProductGalleryLargeImage class.

ProductGalleryThumbnails

ProductGalleryThumbnails class.

ProductImage

ProductImage class.

ProductImageGallery

ProductImageGallery class.

ProductMeta

ProductMeta 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.

ProductSaleBadge

ProductSaleBadge class.

ProductsByAttribute

ProductsByAttribute class.

ProductSearch

ProductSearch class.

ProductSKU

ProductSKU class.

ProductSpecifications

ProductSpecifications 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.

ProductReviewAuthorName

ProductReviewAuthorName class.

ProductReviewContent

ProductReviewContent class.

ProductReviewDate

ProductReviewDate class.

ProductReviewForm

ProductReviewForm class.

ProductReviewRating

ProductReviewRating class.

ProductReviews

ProductReviews class.

ProductReviewsPagination

ProductReviewsPagination class.

ProductReviewsPaginationNext

ProductReviewsPaginationNext class.

ProductReviewsPaginationNumbers

ProductReviewsPaginationNumbers class.

ProductReviewsPaginationPrevious

ProductReviewsPaginationPrevious class.

ProductReviewsTitle

ProductReviewsTitle class.

ProductReviewTemplate

ProductReviewTemplate 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.

DocumentObject

DocumentObject class.

Validation

Service class validating checkout field schema.

CheckoutLink

Checkout Link class.

CreateAccount

Service class implementing new create account emails used for order processing via the Block Based Checkout.

CustomerNewAccount

Customer New Account. Previously used for blocks, but now replaced by the core email.

GoogleAnalytics

Service class to integrate Blocks with the Google Analytics extension,

Hydration

Service class that handles hydration of API data for blocks.

IntegrationRegistry

Class used for tracking registered integrations with various Block types.

Options

Contains all the option names used by the plugin.

Package

Main package 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.

ProductAvailabilityUtils

Utility functions for product availability.

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.

OrderCountCache

A class to cache counts for various order statuses.

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.

CatalogVisibility

Enum class for all the catalog visibility values.

OrderInternalStatus

Enum class for all the internal order statuses.

OrderStatus

Enum class for all the order statuses.

PaymentGatewayFeature

Enum class for all the payment gateway feature's values.

ProductStatus

Enum class for all the product statuses.

ProductStockStatus

Enum class for all the product stock statuses.

ProductTaxStatus

Enum class for all the product tax statuses.

ProductType

Enum class for all the product types.

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.

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.

ProductBrands

ProductBrands class.

ProductBrandsById

ProductBrandsById 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.

ProductBrandSchema

ProductBrandSchema 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.

CartTokenUtils

Cart token utility functions.

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.

PaymentUtils

PaymentUtils

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.

ShippingUtil

The ShippingUtil class provides utilities for working with shipping and shipping packages.

StringUtil

A class of utilities for dealing with strings.

TimeUtil

Class with date and time utilities.

UsePluginHelpers

UsePubSub

UseWPFunctions

Trait UseWPFunctions

ExportableTraits

ExportableTraits class.

FilteredGetDataTrait

Trait to call filters on `get_data` methods for data stores.

OrderAwareControllerTrait

Trait to contain shared methods for reports Controllers that use order and orders statuses.

StatsDataStoreTrait

Trait to contain *stats-specific methods for data stores.

TaskTraits

TaskTraits class.

NoteTraits

NoteTraits class.

OrderTraits

OrderTraits class.

SchedulerTraits

SchedulerTraits class.

EnableBlockJsonAssetsTrait

BlockHooksTrait

BlockHooksTrait

BlocksSharedState

Manages the registration of interactivity config and state that is commonly shared by WooCommerce blocks.

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

woocommerce_legacy_reports_init()  : mixed

Initialize the WooCommerce legacy reports.

wc_admin_get_feature_config()  : mixed

wc_get_brand_thumbnail_url()  : string

Helper function :: wc_get_brand_thumbnail_url function.

wc_get_brand_thumbnail_image()  : string

Helper function :: wc_get_brand_thumbnail_image function.

wc_get_brands()  : array<string|int, mixed>

Retrieves product's brands.

get_brand_thumbnail_url()  : string

Polyfill for get_brand_thumbnail_image.

get_brand_thumbnail_image()  : string

Polyfill for get_brand_thumbnail_image.

get_brands()  : array<string|int, mixed>

Polyfill for get_brands.

woocommerce_register_additional_checkout_field()  : mixed

Register a checkout field.

__experimental_woocommerce_blocks_register_checkout_field()  : mixed

Register a checkout field.

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.