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
EmailEditor
Uninstaller

Interfaces, Classes and Traits

WC_Vendor_Stringable
ClientAware
Implementing ClientAware allows graphql-php to decide if this error is safe to be shown to clients.
ProvidesExtensions
Implementing HasExtensions allows this error to provide additional data to clients.
ExecutorImplementation
PromiseAdapter
Provides a means for integration of async PHP platforms ([related docs](data-fetching.md#async-php)).
ScopedContext
When the object passed as `$contextValue` to Automattic\WooCommerce\Vendor\GraphQL execution implements this, its `clone()` method will be called before passing the context down to a field.
DefinitionNode
export type DefinitionNode = | ExecutableDefinitionNode | TypeSystemDefinitionNode | TypeSystemExtensionNode;.
ExecutableDefinitionNode
export type ExecutableDefinitionNode = | OperationDefinitionNode | FragmentDefinitionNode;.
HasSelectionSet
export type DefinitionNode = OperationDefinitionNode | FragmentDefinitionNode.
SelectionNode
export type SelectionNode = FieldNode | FragmentSpreadNode | InlineFragmentNode.
TypeDefinitionNode
export type TypeDefinitionNode = ScalarTypeDefinitionNode | ObjectTypeDefinitionNode | InterfaceTypeDefinitionNode | UnionTypeDefinitionNode | EnumTypeDefinitionNode | InputObjectTypeDefinitionNode.
TypeExtensionNode
export type TypeExtensionNode = | ScalarTypeExtensionNode | ObjectTypeExtensionNode | InterfaceTypeExtensionNode | UnionTypeExtensionNode | EnumTypeExtensionNode | InputObjectTypeExtensionNode;.
TypeNode
export type TypeNode = NamedTypeNode | ListTypeNode | NonNullTypeNode.
TypeSystemDefinitionNode
export type TypeSystemDefinitionNode = | SchemaDefinitionNode | TypeDefinitionNode | DirectiveDefinitionNode.
TypeSystemExtensionNode
export type TypeSystemExtensionNode = SchemaExtensionNode | TypeExtensionNode;.
ValueNode
export type ValueNode = VariableNode | NullValueNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | EnumValueNode | ListValueNode | ObjectValueNode.
AbstractType
CompositeType
HasFieldsType
ImplementingType
export type GraphQLImplementingType = GraphQLObjectType | GraphQLInterfaceType;.
InputType
export type InputType = | ScalarType | EnumType | InputObjectType | ListOfType<InputType> | NonNull< | ScalarType | EnumType | InputObjectType | ListOfType<InputType>, >;.
LeafType
NamedType
export type NamedType = | ScalarType | ObjectType | InterfaceType | UnionType | EnumType | InputObjectType;.
NullableType
OutputType
UnmodifiedType
WrappingType
ValidationContext
ISO3166Exception
ISO3166DataProvider
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.
Commentable
CSSElement
Represents any entity in the CSS that is encapsulated by a class.
Positionable
Represents a CSS item that may have a position in the source CSS document (line number and possibly column number).
AtRule
Renderable
ExceptionInterface
Interface for exceptions.
Stringable
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.
EmailEditorVendor_Stringable
Commentable
CSSElement
Represents any entity in the CSS that is encapsulated by a class.
Positionable
Represents a CSS item that may have a position in the source CSS document (line number and possibly column number).
AtRule
Renderable
ExceptionInterface
Interface for exceptions.
Stringable
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_Session
WC_Session
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.
WC_Autoloader
Autoloader class.
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_Session_Handler
Session handler 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_Gateway_Paypal_Buttons
Handles PayPal Buttons.
WC_Gateway_Paypal_Constants
WC_Gateway_Paypal_Constants Class.
WC_Gateway_Paypal_Helper
Helper for PayPal gateway.
WC_Gateway_Paypal_Notices
Class WC_Gateway_Paypal_Notices.
WC_Gateway_Paypal_Request
Generates requests to send to PayPal.
WC_Gateway_Paypal_Transact_Account_Manager
Handles Transact account management.
WC_Gateway_Paypal_Webhook_Handler
Handles webhook events.
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.
WC_Vendor_Attribute
WC_Vendor_PhpToken
WC_Vendor_UnhandledMatchError
WC_Vendor_ValueError
MobileDetect
Auto-generated isXXXX() magic methods.
Deferred
User-facing promise class for deferred field resolution.
CoercionError
Describes an Error found during the parse, validate, or execute phases of performing a Automattic\WooCommerce\Vendor\GraphQL operation. In addition to a message and stack trace, it also includes information about the locations in a Automattic\WooCommerce\Vendor\GraphQL document and/or execution result that correspond to the Error.
DebugFlag
Collection of flags for [error debugging](error-handling.md#debugging-tools).
Error
Describes an Error found during the parse, validate, or execute phases of performing a Automattic\WooCommerce\Vendor\GraphQL operation. In addition to a message and stack trace, it also includes information about the locations in a Automattic\WooCommerce\Vendor\GraphQL document and/or execution result that correspond to the Error.
FormattedError
This class is used for [default error formatting](error-handling.md).
InvariantViolation
Note: This exception should not inherit base Error exception as it is raised when there is an error somewhere in user-land code.
SerializationError
Thrown when failing to serialize a leaf value.
SyntaxError
Describes an Error found during the parse, validate, or execute phases of performing a Automattic\WooCommerce\Vendor\GraphQL operation. In addition to a message and stack trace, it also includes information about the locations in a Automattic\WooCommerce\Vendor\GraphQL document and/or execution result that correspond to the Error.
UserError
Caused by Automattic\WooCommerce\Vendor\GraphQL clients and can safely be displayed.
Warning
Encapsulates warnings produced by the library.
ExecutionContext
Data that must be available at all points during query execution.
ExecutionResult
Returned after [query execution](executing-queries.md).
Executor
Implements the "Evaluating requests" section of the Automattic\WooCommerce\Vendor\GraphQL specification.
AmpFutureAdapter
Allows integration with amphp/amp v3 (fiber-based futures).
AmpPromiseAdapter
ReactPromiseAdapter
SyncPromise
Synchronous promise implementation following Promises A+ spec.
SyncPromiseAdapter
Allows changing order of field resolution even in sync environments (by leveraging queue of deferreds and promises).
SyncPromiseQueue
Queue for deferred execution of SyncPromise tasks.
Promise
Convenience wrapper for promises represented by Promise Adapter.
PromiseExecutor
ReferenceExecutor
Values
GraphQL
This is the primary facade for fulfilling Automattic\WooCommerce\Vendor\GraphQL operations.
ArgumentNode
type Node = NameNode | DocumentNode | OperationDefinitionNode | VariableDefinitionNode | VariableNode | SelectionSetNode | FieldNode | ArgumentNode | FragmentSpreadNode | InlineFragmentNode | FragmentDefinitionNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | EnumValueNode | ListValueNode | ObjectValueNode | ObjectFieldNode | DirectiveNode | ListTypeNode | NonNullTypeNode.
BooleanValueNode
type Node = NameNode | DocumentNode | OperationDefinitionNode | VariableDefinitionNode | VariableNode | SelectionSetNode | FieldNode | ArgumentNode | FragmentSpreadNode | InlineFragmentNode | FragmentDefinitionNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | EnumValueNode | ListValueNode | ObjectValueNode | ObjectFieldNode | DirectiveNode | ListTypeNode | NonNullTypeNode.
DirectiveDefinitionNode
type Node = NameNode | DocumentNode | OperationDefinitionNode | VariableDefinitionNode | VariableNode | SelectionSetNode | FieldNode | ArgumentNode | FragmentSpreadNode | InlineFragmentNode | FragmentDefinitionNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | EnumValueNode | ListValueNode | ObjectValueNode | ObjectFieldNode | DirectiveNode | ListTypeNode | NonNullTypeNode.
DirectiveNode
type Node = NameNode | DocumentNode | OperationDefinitionNode | VariableDefinitionNode | VariableNode | SelectionSetNode | FieldNode | ArgumentNode | FragmentSpreadNode | InlineFragmentNode | FragmentDefinitionNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | EnumValueNode | ListValueNode | ObjectValueNode | ObjectFieldNode | DirectiveNode | ListTypeNode | NonNullTypeNode.
DocumentNode
type Node = NameNode | DocumentNode | OperationDefinitionNode | VariableDefinitionNode | VariableNode | SelectionSetNode | FieldNode | ArgumentNode | FragmentSpreadNode | InlineFragmentNode | FragmentDefinitionNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | EnumValueNode | ListValueNode | ObjectValueNode | ObjectFieldNode | DirectiveNode | ListTypeNode | NonNullTypeNode.
EnumTypeDefinitionNode
type Node = NameNode | DocumentNode | OperationDefinitionNode | VariableDefinitionNode | VariableNode | SelectionSetNode | FieldNode | ArgumentNode | FragmentSpreadNode | InlineFragmentNode | FragmentDefinitionNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | EnumValueNode | ListValueNode | ObjectValueNode | ObjectFieldNode | DirectiveNode | ListTypeNode | NonNullTypeNode.
EnumTypeExtensionNode
type Node = NameNode | DocumentNode | OperationDefinitionNode | VariableDefinitionNode | VariableNode | SelectionSetNode | FieldNode | ArgumentNode | FragmentSpreadNode | InlineFragmentNode | FragmentDefinitionNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | EnumValueNode | ListValueNode | ObjectValueNode | ObjectFieldNode | DirectiveNode | ListTypeNode | NonNullTypeNode.
EnumValueDefinitionNode
type Node = NameNode | DocumentNode | OperationDefinitionNode | VariableDefinitionNode | VariableNode | SelectionSetNode | FieldNode | ArgumentNode | FragmentSpreadNode | InlineFragmentNode | FragmentDefinitionNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | EnumValueNode | ListValueNode | ObjectValueNode | ObjectFieldNode | DirectiveNode | ListTypeNode | NonNullTypeNode.
EnumValueNode
type Node = NameNode | DocumentNode | OperationDefinitionNode | VariableDefinitionNode | VariableNode | SelectionSetNode | FieldNode | ArgumentNode | FragmentSpreadNode | InlineFragmentNode | FragmentDefinitionNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | EnumValueNode | ListValueNode | ObjectValueNode | ObjectFieldNode | DirectiveNode | ListTypeNode | NonNullTypeNode.
FieldDefinitionNode
type Node = NameNode | DocumentNode | OperationDefinitionNode | VariableDefinitionNode | VariableNode | SelectionSetNode | FieldNode | ArgumentNode | FragmentSpreadNode | InlineFragmentNode | FragmentDefinitionNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | EnumValueNode | ListValueNode | ObjectValueNode | ObjectFieldNode | DirectiveNode | ListTypeNode | NonNullTypeNode.
FieldNode
type Node = NameNode | DocumentNode | OperationDefinitionNode | VariableDefinitionNode | VariableNode | SelectionSetNode | FieldNode | ArgumentNode | FragmentSpreadNode | InlineFragmentNode | FragmentDefinitionNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | EnumValueNode | ListValueNode | ObjectValueNode | ObjectFieldNode | DirectiveNode | ListTypeNode | NonNullTypeNode.
FloatValueNode
type Node = NameNode | DocumentNode | OperationDefinitionNode | VariableDefinitionNode | VariableNode | SelectionSetNode | FieldNode | ArgumentNode | FragmentSpreadNode | InlineFragmentNode | FragmentDefinitionNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | EnumValueNode | ListValueNode | ObjectValueNode | ObjectFieldNode | DirectiveNode | ListTypeNode | NonNullTypeNode.
FragmentDefinitionNode
type Node = NameNode | DocumentNode | OperationDefinitionNode | VariableDefinitionNode | VariableNode | SelectionSetNode | FieldNode | ArgumentNode | FragmentSpreadNode | InlineFragmentNode | FragmentDefinitionNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | EnumValueNode | ListValueNode | ObjectValueNode | ObjectFieldNode | DirectiveNode | ListTypeNode | NonNullTypeNode.
FragmentSpreadNode
type Node = NameNode | DocumentNode | OperationDefinitionNode | VariableDefinitionNode | VariableNode | SelectionSetNode | FieldNode | ArgumentNode | FragmentSpreadNode | InlineFragmentNode | FragmentDefinitionNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | EnumValueNode | ListValueNode | ObjectValueNode | ObjectFieldNode | DirectiveNode | ListTypeNode | NonNullTypeNode.
InlineFragmentNode
type Node = NameNode | DocumentNode | OperationDefinitionNode | VariableDefinitionNode | VariableNode | SelectionSetNode | FieldNode | ArgumentNode | FragmentSpreadNode | InlineFragmentNode | FragmentDefinitionNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | EnumValueNode | ListValueNode | ObjectValueNode | ObjectFieldNode | DirectiveNode | ListTypeNode | NonNullTypeNode.
InputObjectTypeDefinitionNode
type Node = NameNode | DocumentNode | OperationDefinitionNode | VariableDefinitionNode | VariableNode | SelectionSetNode | FieldNode | ArgumentNode | FragmentSpreadNode | InlineFragmentNode | FragmentDefinitionNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | EnumValueNode | ListValueNode | ObjectValueNode | ObjectFieldNode | DirectiveNode | ListTypeNode | NonNullTypeNode.
InputObjectTypeExtensionNode
type Node = NameNode | DocumentNode | OperationDefinitionNode | VariableDefinitionNode | VariableNode | SelectionSetNode | FieldNode | ArgumentNode | FragmentSpreadNode | InlineFragmentNode | FragmentDefinitionNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | EnumValueNode | ListValueNode | ObjectValueNode | ObjectFieldNode | DirectiveNode | ListTypeNode | NonNullTypeNode.
InputValueDefinitionNode
type Node = NameNode | DocumentNode | OperationDefinitionNode | VariableDefinitionNode | VariableNode | SelectionSetNode | FieldNode | ArgumentNode | FragmentSpreadNode | InlineFragmentNode | FragmentDefinitionNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | EnumValueNode | ListValueNode | ObjectValueNode | ObjectFieldNode | DirectiveNode | ListTypeNode | NonNullTypeNode.
InterfaceTypeDefinitionNode
type Node = NameNode | DocumentNode | OperationDefinitionNode | VariableDefinitionNode | VariableNode | SelectionSetNode | FieldNode | ArgumentNode | FragmentSpreadNode | InlineFragmentNode | FragmentDefinitionNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | EnumValueNode | ListValueNode | ObjectValueNode | ObjectFieldNode | DirectiveNode | ListTypeNode | NonNullTypeNode.
InterfaceTypeExtensionNode
type Node = NameNode | DocumentNode | OperationDefinitionNode | VariableDefinitionNode | VariableNode | SelectionSetNode | FieldNode | ArgumentNode | FragmentSpreadNode | InlineFragmentNode | FragmentDefinitionNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | EnumValueNode | ListValueNode | ObjectValueNode | ObjectFieldNode | DirectiveNode | ListTypeNode | NonNullTypeNode.
IntValueNode
type Node = NameNode | DocumentNode | OperationDefinitionNode | VariableDefinitionNode | VariableNode | SelectionSetNode | FieldNode | ArgumentNode | FragmentSpreadNode | InlineFragmentNode | FragmentDefinitionNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | EnumValueNode | ListValueNode | ObjectValueNode | ObjectFieldNode | DirectiveNode | ListTypeNode | NonNullTypeNode.
ListTypeNode
type Node = NameNode | DocumentNode | OperationDefinitionNode | VariableDefinitionNode | VariableNode | SelectionSetNode | FieldNode | ArgumentNode | FragmentSpreadNode | InlineFragmentNode | FragmentDefinitionNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | EnumValueNode | ListValueNode | ObjectValueNode | ObjectFieldNode | DirectiveNode | ListTypeNode | NonNullTypeNode.
ListValueNode
type Node = NameNode | DocumentNode | OperationDefinitionNode | VariableDefinitionNode | VariableNode | SelectionSetNode | FieldNode | ArgumentNode | FragmentSpreadNode | InlineFragmentNode | FragmentDefinitionNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | EnumValueNode | ListValueNode | ObjectValueNode | ObjectFieldNode | DirectiveNode | ListTypeNode | NonNullTypeNode.
Location
Contains a range of UTF-8 character offsets and token references that identify the region of the source from which the AST derived.
NamedTypeNode
type Node = NameNode | DocumentNode | OperationDefinitionNode | VariableDefinitionNode | VariableNode | SelectionSetNode | FieldNode | ArgumentNode | FragmentSpreadNode | InlineFragmentNode | FragmentDefinitionNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | EnumValueNode | ListValueNode | ObjectValueNode | ObjectFieldNode | DirectiveNode | ListTypeNode | NonNullTypeNode.
NameNode
type Node = NameNode | DocumentNode | OperationDefinitionNode | VariableDefinitionNode | VariableNode | SelectionSetNode | FieldNode | ArgumentNode | FragmentSpreadNode | InlineFragmentNode | FragmentDefinitionNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | EnumValueNode | ListValueNode | ObjectValueNode | ObjectFieldNode | DirectiveNode | ListTypeNode | NonNullTypeNode.
Node
type Node = NameNode | DocumentNode | OperationDefinitionNode | VariableDefinitionNode | VariableNode | SelectionSetNode | FieldNode | ArgumentNode | FragmentSpreadNode | InlineFragmentNode | FragmentDefinitionNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | EnumValueNode | ListValueNode | ObjectValueNode | ObjectFieldNode | DirectiveNode | ListTypeNode | NonNullTypeNode.
NodeKind
Holds constants of possible AST nodes.
NonNullTypeNode
type Node = NameNode | DocumentNode | OperationDefinitionNode | VariableDefinitionNode | VariableNode | SelectionSetNode | FieldNode | ArgumentNode | FragmentSpreadNode | InlineFragmentNode | FragmentDefinitionNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | EnumValueNode | ListValueNode | ObjectValueNode | ObjectFieldNode | DirectiveNode | ListTypeNode | NonNullTypeNode.
NullValueNode
type Node = NameNode | DocumentNode | OperationDefinitionNode | VariableDefinitionNode | VariableNode | SelectionSetNode | FieldNode | ArgumentNode | FragmentSpreadNode | InlineFragmentNode | FragmentDefinitionNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | EnumValueNode | ListValueNode | ObjectValueNode | ObjectFieldNode | DirectiveNode | ListTypeNode | NonNullTypeNode.
ObjectFieldNode
type Node = NameNode | DocumentNode | OperationDefinitionNode | VariableDefinitionNode | VariableNode | SelectionSetNode | FieldNode | ArgumentNode | FragmentSpreadNode | InlineFragmentNode | FragmentDefinitionNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | EnumValueNode | ListValueNode | ObjectValueNode | ObjectFieldNode | DirectiveNode | ListTypeNode | NonNullTypeNode.
ObjectTypeDefinitionNode
type Node = NameNode | DocumentNode | OperationDefinitionNode | VariableDefinitionNode | VariableNode | SelectionSetNode | FieldNode | ArgumentNode | FragmentSpreadNode | InlineFragmentNode | FragmentDefinitionNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | EnumValueNode | ListValueNode | ObjectValueNode | ObjectFieldNode | DirectiveNode | ListTypeNode | NonNullTypeNode.
ObjectTypeExtensionNode
type Node = NameNode | DocumentNode | OperationDefinitionNode | VariableDefinitionNode | VariableNode | SelectionSetNode | FieldNode | ArgumentNode | FragmentSpreadNode | InlineFragmentNode | FragmentDefinitionNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | EnumValueNode | ListValueNode | ObjectValueNode | ObjectFieldNode | DirectiveNode | ListTypeNode | NonNullTypeNode.
ObjectValueNode
type Node = NameNode | DocumentNode | OperationDefinitionNode | VariableDefinitionNode | VariableNode | SelectionSetNode | FieldNode | ArgumentNode | FragmentSpreadNode | InlineFragmentNode | FragmentDefinitionNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | EnumValueNode | ListValueNode | ObjectValueNode | ObjectFieldNode | DirectiveNode | ListTypeNode | NonNullTypeNode.
OperationDefinitionNode
type Node = NameNode | DocumentNode | OperationDefinitionNode | VariableDefinitionNode | VariableNode | SelectionSetNode | FieldNode | ArgumentNode | FragmentSpreadNode | InlineFragmentNode | FragmentDefinitionNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | EnumValueNode | ListValueNode | ObjectValueNode | ObjectFieldNode | DirectiveNode | ListTypeNode | NonNullTypeNode.
OperationTypeDefinitionNode
type Node = NameNode | DocumentNode | OperationDefinitionNode | VariableDefinitionNode | VariableNode | SelectionSetNode | FieldNode | ArgumentNode | FragmentSpreadNode | InlineFragmentNode | FragmentDefinitionNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | EnumValueNode | ListValueNode | ObjectValueNode | ObjectFieldNode | DirectiveNode | ListTypeNode | NonNullTypeNode.
ScalarTypeDefinitionNode
type Node = NameNode | DocumentNode | OperationDefinitionNode | VariableDefinitionNode | VariableNode | SelectionSetNode | FieldNode | ArgumentNode | FragmentSpreadNode | InlineFragmentNode | FragmentDefinitionNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | EnumValueNode | ListValueNode | ObjectValueNode | ObjectFieldNode | DirectiveNode | ListTypeNode | NonNullTypeNode.
ScalarTypeExtensionNode
type Node = NameNode | DocumentNode | OperationDefinitionNode | VariableDefinitionNode | VariableNode | SelectionSetNode | FieldNode | ArgumentNode | FragmentSpreadNode | InlineFragmentNode | FragmentDefinitionNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | EnumValueNode | ListValueNode | ObjectValueNode | ObjectFieldNode | DirectiveNode | ListTypeNode | NonNullTypeNode.
SchemaDefinitionNode
type Node = NameNode | DocumentNode | OperationDefinitionNode | VariableDefinitionNode | VariableNode | SelectionSetNode | FieldNode | ArgumentNode | FragmentSpreadNode | InlineFragmentNode | FragmentDefinitionNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | EnumValueNode | ListValueNode | ObjectValueNode | ObjectFieldNode | DirectiveNode | ListTypeNode | NonNullTypeNode.
SchemaExtensionNode
type Node = NameNode | DocumentNode | OperationDefinitionNode | VariableDefinitionNode | VariableNode | SelectionSetNode | FieldNode | ArgumentNode | FragmentSpreadNode | InlineFragmentNode | FragmentDefinitionNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | EnumValueNode | ListValueNode | ObjectValueNode | ObjectFieldNode | DirectiveNode | ListTypeNode | NonNullTypeNode.
SelectionSetNode
type Node = NameNode | DocumentNode | OperationDefinitionNode | VariableDefinitionNode | VariableNode | SelectionSetNode | FieldNode | ArgumentNode | FragmentSpreadNode | InlineFragmentNode | FragmentDefinitionNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | EnumValueNode | ListValueNode | ObjectValueNode | ObjectFieldNode | DirectiveNode | ListTypeNode | NonNullTypeNode.
StringValueNode
type Node = NameNode | DocumentNode | OperationDefinitionNode | VariableDefinitionNode | VariableNode | SelectionSetNode | FieldNode | ArgumentNode | FragmentSpreadNode | InlineFragmentNode | FragmentDefinitionNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | EnumValueNode | ListValueNode | ObjectValueNode | ObjectFieldNode | DirectiveNode | ListTypeNode | NonNullTypeNode.
UnionTypeDefinitionNode
type Node = NameNode | DocumentNode | OperationDefinitionNode | VariableDefinitionNode | VariableNode | SelectionSetNode | FieldNode | ArgumentNode | FragmentSpreadNode | InlineFragmentNode | FragmentDefinitionNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | EnumValueNode | ListValueNode | ObjectValueNode | ObjectFieldNode | DirectiveNode | ListTypeNode | NonNullTypeNode.
UnionTypeExtensionNode
type Node = NameNode | DocumentNode | OperationDefinitionNode | VariableDefinitionNode | VariableNode | SelectionSetNode | FieldNode | ArgumentNode | FragmentSpreadNode | InlineFragmentNode | FragmentDefinitionNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | EnumValueNode | ListValueNode | ObjectValueNode | ObjectFieldNode | DirectiveNode | ListTypeNode | NonNullTypeNode.
VariableDefinitionNode
type Node = NameNode | DocumentNode | OperationDefinitionNode | VariableDefinitionNode | VariableNode | SelectionSetNode | FieldNode | ArgumentNode | FragmentSpreadNode | InlineFragmentNode | FragmentDefinitionNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | EnumValueNode | ListValueNode | ObjectValueNode | ObjectFieldNode | DirectiveNode | ListTypeNode | NonNullTypeNode.
VariableNode
type Node = NameNode | DocumentNode | OperationDefinitionNode | VariableDefinitionNode | VariableNode | SelectionSetNode | FieldNode | ArgumentNode | FragmentSpreadNode | InlineFragmentNode | FragmentDefinitionNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | EnumValueNode | ListValueNode | ObjectValueNode | ObjectFieldNode | DirectiveNode | ListTypeNode | NonNullTypeNode.
BlockString
DirectiveLocation
Enumeration of available directive locations.
Lexer
A lexer is a stateful stream generator, it returns the next token in the Source when advanced.
Parser
Parses string containing Automattic\WooCommerce\Vendor\GraphQL query language or [schema definition language](schema-definition-language.md) to Abstract Syntax Tree.
Printer
Prints AST to string. Capable of printing Automattic\WooCommerce\Vendor\GraphQL queries and Type definition language.
Source
SourceLocation
Token
Represents a range of characters represented by a lexical token within a Source.
Visitor
Utility for efficient AST traversal and modification.
VisitorOperation
VisitorRemoveNode
VisitorSkipNode
VisitorStop
BatchedQueriesAreNotSupported
CannotParseJsonBody
CannotParseVariables
CannotReadBody
FailedToDetermineOperationType
GetMethodSupportsOnlyQueryOperation
HttpMethodNotSupported
InvalidOperationParameter
InvalidQueryIdParameter
InvalidQueryParameter
MissingContentTypeHeader
MissingQueryOrQueryIdParameter
PersistedQueriesAreNotSupported
UnexpectedContentType
Helper
Contains functionality that could be re-used by various server implementations.
OperationParams
Structure representing parsed HTTP parameters for Automattic\WooCommerce\Vendor\GraphQL operation.
RequestError
ServerConfig
Server configuration class.
StandardServer
Automattic\WooCommerce\Vendor\GraphQL server compatible with both: [express-graphql](https://github.com/graphql/express-graphql) and [Apollo Server](https://github.com/apollographql/graphql-server).
Argument
BooleanType
Scalar Type Definition.
CustomScalarType
Scalar Type Definition.
Deprecated
Description
Directive
EnumType
Registry of built-in Automattic\WooCommerce\Vendor\GraphQL types and base class for all other types.
EnumValueDefinition
FieldDefinition
FloatType
Scalar Type Definition.
IDType
Scalar Type Definition.
InputObjectField
InputObjectType
Registry of built-in Automattic\WooCommerce\Vendor\GraphQL types and base class for all other types.
InterfaceType
Registry of built-in Automattic\WooCommerce\Vendor\GraphQL types and base class for all other types.
IntType
Scalar Type Definition.
ListOfType
Registry of built-in Automattic\WooCommerce\Vendor\GraphQL types and base class for all other types.
NonNull
Registry of built-in Automattic\WooCommerce\Vendor\GraphQL types and base class for all other types.
ObjectType
Object Type Definition.
PhpEnumType
Registry of built-in Automattic\WooCommerce\Vendor\GraphQL types and base class for all other types.
QueryPlan
ResolveInfo
Structure containing information useful for field resolution process.
ScalarType
Scalar Type Definition.
StringType
Scalar Type Definition.
Type
Registry of built-in Automattic\WooCommerce\Vendor\GraphQL types and base class for all other types.
UnionType
Registry of built-in Automattic\WooCommerce\Vendor\GraphQL types and base class for all other types.
UnresolvedFieldDefinition
Introspection
Schema
Schema Definition (see [schema definition docs](schema-definition.md)).
SchemaConfig
Configuration options for schema construction.
SchemaValidationContext
TypeKind
InputObjectCircularRefs
AST
Various utilities dealing with AST.
ASTDefinitionBuilder
BreakingChangesFinder
Utility for finding breaking/dangerous changes between two schemas.
BuildClientSchema
BuildSchema
Build instance of @see \Automattic\WooCommerce\Vendor\GraphQL\Type\Schema out of schema language definition (string or parsed AST).
InterfaceImplementations
A way to track interface implementations.
LazyException
Allows lazy calculation of a complex message when the exception is used in `assert()`.
LexicalDistance
Computes the lexical distance between strings A and B.
MixedStore
Similar to PHP array, but allows any type of data to act as key (including arrays, objects, scalars).
PairSet
A way to keep track of pairs of things when the ordering of the pair does not matter. We do this by maintaining a sort of double adjacency sets.
PhpDoc
SchemaExtender
SchemaPrinter
Prints the contents of a Schema in schema definition language.
TypeComparators
TypeInfo
Utils
Value
DocumentValidator
Implements the "Validation" section of the spec.
QueryValidationContext
An instance of this class is passed as the "this" context to all validators, allowing access to commonly useful contextual information from within a validation rule.
CustomValidationRule
DisableIntrospection
ExecutableDefinitions
Executable definitions.
FieldsOnCorrectType
FragmentsOnCompositeTypes
KnownArgumentNames
Known argument names.
KnownArgumentNamesOnDirectives
Known argument names on directives.
KnownDirectives
KnownFragmentNames
KnownTypeNames
Known type names.
LoneAnonymousOperation
Lone anonymous operation.
LoneSchemaDefinition
Lone schema definition.
NoFragmentCycles
NoUndefinedVariables
A Automattic\WooCommerce\Vendor\GraphQL operation is only valid if all variables encountered, both directly and via fragment spreads, are defined by that operation.
NoUnusedFragments
NoUnusedVariables
OneOfInputObjectsRule
OneOf Input Objects validation rule.
OverlappingFieldsCanBeMerged
ReasonOrReasons is recursive, but PHPStan does not support that.
PossibleFragmentSpreads
PossibleTypeExtensions
Possible type extensions.
ProvidedRequiredArguments
ProvidedRequiredArgumentsOnDirectives
Provided required arguments on directives.
QueryComplexity
QueryDepth
QuerySecurityRule
ScalarLeafs
SingleFieldSubscription
UniqueArgumentDefinitionNames
Unique argument definition names.
UniqueArgumentNames
UniqueDirectiveNames
Unique directive names.
UniqueDirectivesPerLocation
Unique directive names per location.
UniqueEnumValueNames
UniqueFieldDefinitionNames
Unique field definition names.
UniqueFragmentNames
UniqueInputFieldNames
UniqueOperationNames
UniqueOperationTypes
Unique operation types.
UniqueTypeNames
Unique type names.
UniqueVariableNames
ValidationRule
ValuesOfCorrectType
Value literals of correct type.
VariablesAreInputTypes
VariablesInAllowedPosition
SDLValidationContext
DomainException
OutOfBoundsException
Guards
ISO3166
ISO3166DataValidator
ISO3166WithAliases
CssInliner
This class provides functions for converting CSS styles into inline style attributes in your HTML code.
AbstractHtmlProcessor
Base class for HTML processor that e.g., can remove, add or modify nodes or attributes.
CssToAttributeConverter
This HtmlProcessor can convert style HTML attributes to the corresponding other visual HTML attributes, e.g. it converts style="width: 100px" to width="100".
CssVariableEvaluator
This class can evaluate CSS custom properties that are defined and used in inline style attributes.
HtmlNormalizer
Normalizes HTML: - add a document type (HTML5) if missing - disentangle incorrectly nested tags - add HEAD and BODY elements (if they are missing) - reformat the HTML
HtmlPruner
This class can remove things from HTML.
Comment
AtRuleBlockList
A `BlockList` constructed by an unknown at-rule. `@media` rules are rendered into `AtRuleBlockList` objects.
CSSBlockList
A `CSSBlockList` is a `CSSList` whose `DeclarationBlock`s are guaranteed to contain valid declaration blocks or at-rules.
CSSList
This is the most generic container available. It can contain `DeclarationBlock`s (rule sets with a selector), `RuleSet`s as well as other `CSSList` objects.
Document
This class represents the root of a parsed CSS file. It contains all top-level CSS contents: mostly declaration blocks, but also any at-rules encountered (`Import` and `Charset`).
KeyFrame
This is the most generic container available. It can contain `DeclarationBlock`s (rule sets with a selector), `RuleSet`s as well as other `CSSList` objects.
OutputFormat
Extending this class is deprecated in version 8.8.0; it will be made `final` in version 9.0.0.
Parser
This class parses CSS from text into a data structure.
OutputException
Thrown if the CSS parser attempts to print something invalid.
SourceException
UnexpectedEOFException
Thrown if the CSS parser encounters end of file it did not expect.
UnexpectedTokenException
Thrown if the CSS parser encounters a token it did not expect.
Charset
Class representing an `@charset` rule.
CSSNamespace
`CSSNamespace` represents an `@namespace` rule.
Import
Class representing an `@import` rule.
KeyframeSelector
Class representing a single CSS selector. Selectors have to be split by the comma prior to being passed into this class.
Selector
Class representing a single CSS selector. Selectors have to be split by the comma prior to being passed into this class.
Rule
`Rule`s just have a string key (the rule) and a 'Value'.
AtRuleSet
This class represents rule sets for generic at-rules which are not covered by specific classes, i.e., not `@import`, `@charset` or `@media`.
DeclarationBlock
This class represents a `RuleSet` constrained by a `Selector`.
RuleSet
This class is a container for individual 'Rule's.
Settings
Parser settings class.
CalcFunction
Support for `-webkit-calc` and `-moz-calc` is deprecated in version 8.8.0, and will be removed in version 9.0.0.
CalcRuleValueList
This class is used to represent all multivalued rules like `font: bold 12px/3 Helvetica, Verdana, sans-serif;` (where the value would be a whitespace-separated list of the primitive value `bold`, a slash-separated list and a comma-separated list).
Color
`Color's can be input in the form #rrggbb, #rgb or schema(val1, val2, …) but are always stored as an array of ('s' => val1, 'c' => val2, 'h' => val3, …) and output in the second form.
CSSFunction
A `CSSFunction` represents a special kind of value that also contains a function name and where the values are the function’s arguments. It also handles equals-sign-separated argument lists like `filter: alpha(opacity=90);`.
CSSString
This class is a wrapper for quoted strings to distinguish them from keywords.
LineName
A `ValueList` represents a lists of `Value`s, separated by some separation character (mostly `,`, whitespace, or `/`).
PrimitiveValue
Abstract base class for specific classes of CSS values: `Size`, `Color`, `CSSString` and `URL`, and another abstract subclass `ValueList`.
RuleValueList
This class is used to represent all multivalued rules like `font: bold 12px/3 Helvetica, Verdana, sans-serif;` (where the value would be a whitespace-separated list of the primitive value `bold`, a slash-separated list and a comma-separated list).
Size
A `Size` consists of a numeric `size` value and a unit.
URL
This class represents URLs in CSS. `URL`s always output in `URL("")` notation.
Value
Abstract base class for specific classes of CSS values: `Size`, `Color`, `CSSString` and `URL`, and another abstract subclass `ValueList`.
ValueList
A `ValueList` represents a lists of `Value`s, separated by some separation character (mostly `,`, whitespace, or `/`).
CssSelectorConverter
CssSelectorConverter is the main entry point of the component and can convert CSS selectors to XPath expressions.
ExpressionErrorException
ParseException is thrown when a CSS selector syntax is not valid.
InternalErrorException
ParseException is thrown when a CSS selector syntax is not valid.
ParseException
ParseException is thrown when a CSS selector syntax is not valid.
SyntaxErrorException
ParseException is thrown when a CSS selector syntax is not valid.
Attribute
PhpToken
UnhandledMatchError
ValueError
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.
Assets_Manager
Class responsible for managing email editor assets.
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.
Site_Style_Sync_Controller
Site Style Sync Controller
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.
Html2Text_Exception
Exception thrown when HTML to text conversion fails
Html2Text
Converts HTML into plain text format suitable for email display
Renderer
Class Renderer
Blocks_Parser
Class Blocks_Parser
Content_Renderer
Class Content_Renderer
Preset_Variable_Resolver
Resolves WordPress preset variable references to their actual values.
Process_Manager
Class Process_Manager
Rendering_Context
Class Rendering_Context
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.
Audio
Audio block renderer.
Button
Renders a button block.
Buttons
Renders a buttons block.
Column
Renders a column block.
Columns
Renders a columns block.
Cover
Cover block renderer.
Embed
Embed block renderer.
Fallback
Fallback block renderer.
Gallery
Gallery 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.
Media_Text
Media-text block renderer.
Post_Content
Stateless renderer for core/post-content block.
Quote
Renders a quote block.
Social_Link
Renders a social link block.
Social_Links
Renders the social links block.
Table
Renders a table block.
Text
This renderer covers both core/paragraph, core/heading and core/site-title blocks.
Video
Video block renderer.
Dom_Document_Helper
This class should guarantee that our work with the DOMDocument is unified and safe.
Html_Processing_Helper
Helper class for HTML processing and manipulation.
Social_Links_Helper
This class should provide helper functions for the Social Links block.
Styles_Helper
This class should guarantee that our work with the DOMDocument is unified and safe.
Table_Wrapper_Helper
Helper class for generating table wrappers for email blocks.
Coupon_Code_Generator
Generates WooCommerce coupons at email send time for the coupon-code block.
Initializer
Initializes the WooCommerce blocks renderers.
Abstract_Product_Block_Renderer
Shared functionality for block renderers.
Coupon_Code
Renders the woocommerce/coupon-code block for email.
Product_Button
Renders a WooCommerce product button block for email.
Product_Collection
Renders a product collection block for email.
Product_Image
Renders a WooCommerce product image block for email.
Product_Price
Renders a WooCommerce product price block for email.
Product_Sale_Badge
Renders a WooCommerce product sale badge block for email.
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.
EmailEditorVendor_Attribute
EmailEditorVendor_PhpToken
EmailEditorVendor_UnhandledMatchError
EmailEditorVendor_ValueError
CssInliner
This class provides functions for converting CSS styles into inline style attributes in your HTML code.
AbstractHtmlProcessor
Base class for HTML processor that e.g., can remove, add or modify nodes or attributes.
CssToAttributeConverter
This HtmlProcessor can convert style HTML attributes to the corresponding other visual HTML attributes, e.g. it converts style="width: 100px" to width="100".
CssVariableEvaluator
This class can evaluate CSS custom properties that are defined and used in inline style attributes.
HtmlNormalizer
Normalizes HTML: - add a document type (HTML5) if missing - disentangle incorrectly nested tags - add HEAD and BODY elements (if they are missing) - reformat the HTML
HtmlPruner
This class can remove things from HTML.
Comment
AtRuleBlockList
A `BlockList` constructed by an unknown at-rule. `@media` rules are rendered into `AtRuleBlockList` objects.
CSSBlockList
A `CSSBlockList` is a `CSSList` whose `DeclarationBlock`s are guaranteed to contain valid declaration blocks or at-rules.
CSSList
This is the most generic container available. It can contain `DeclarationBlock`s (rule sets with a selector), `RuleSet`s as well as other `CSSList` objects.
Document
This class represents the root of a parsed CSS file. It contains all top-level CSS contents: mostly declaration blocks, but also any at-rules encountered (`Import` and `Charset`).
KeyFrame
This is the most generic container available. It can contain `DeclarationBlock`s (rule sets with a selector), `RuleSet`s as well as other `CSSList` objects.
OutputFormat
Extending this class is deprecated in version 8.8.0; it will be made `final` in version 9.0.0.
Parser
This class parses CSS from text into a data structure.
OutputException
Thrown if the CSS parser attempts to print something invalid.
SourceException
UnexpectedEOFException
Thrown if the CSS parser encounters end of file it did not expect.
UnexpectedTokenException
Thrown if the CSS parser encounters a token it did not expect.
Charset
Class representing an `@charset` rule.
CSSNamespace
`CSSNamespace` represents an `@namespace` rule.
Import
Class representing an `@import` rule.
KeyframeSelector
Class representing a single CSS selector. Selectors have to be split by the comma prior to being passed into this class.
Selector
Class representing a single CSS selector. Selectors have to be split by the comma prior to being passed into this class.
Rule
`Rule`s just have a string key (the rule) and a 'Value'.
AtRuleSet
This class represents rule sets for generic at-rules which are not covered by specific classes, i.e., not `@import`, `@charset` or `@media`.
DeclarationBlock
This class represents a `RuleSet` constrained by a `Selector`.
RuleSet
This class is a container for individual 'Rule's.
Settings
Parser settings class.
CalcFunction
Support for `-webkit-calc` and `-moz-calc` is deprecated in version 8.8.0, and will be removed in version 9.0.0.
CalcRuleValueList
This class is used to represent all multivalued rules like `font: bold 12px/3 Helvetica, Verdana, sans-serif;` (where the value would be a whitespace-separated list of the primitive value `bold`, a slash-separated list and a comma-separated list).
Color
`Color's can be input in the form #rrggbb, #rgb or schema(val1, val2, …) but are always stored as an array of ('s' => val1, 'c' => val2, 'h' => val3, …) and output in the second form.
CSSFunction
A `CSSFunction` represents a special kind of value that also contains a function name and where the values are the function’s arguments. It also handles equals-sign-separated argument lists like `filter: alpha(opacity=90);`.
CSSString
This class is a wrapper for quoted strings to distinguish them from keywords.
LineName
A `ValueList` represents a lists of `Value`s, separated by some separation character (mostly `,`, whitespace, or `/`).
PrimitiveValue
Abstract base class for specific classes of CSS values: `Size`, `Color`, `CSSString` and `URL`, and another abstract subclass `ValueList`.
RuleValueList
This class is used to represent all multivalued rules like `font: bold 12px/3 Helvetica, Verdana, sans-serif;` (where the value would be a whitespace-separated list of the primitive value `bold`, a slash-separated list and a comma-separated list).
Size
A `Size` consists of a numeric `size` value and a unit.
URL
This class represents URLs in CSS. `URL`s always output in `URL("")` notation.
Value
Abstract base class for specific classes of CSS values: `Size`, `Color`, `CSSString` and `URL`, and another abstract subclass `ValueList`.
ValueList
A `ValueList` represents a lists of `Value`s, separated by some separation character (mostly `,`, whitespace, or `/`).
CssSelectorConverter
CssSelectorConverter is the main entry point of the component and can convert CSS selectors to XPath expressions.
ExpressionErrorException
ParseException is thrown when a CSS selector syntax is not valid.
InternalErrorException
ParseException is thrown when a CSS selector syntax is not valid.
ParseException
ParseException is thrown when a CSS selector syntax is not valid.
SyntaxErrorException
ParseException is thrown when a CSS selector syntax is not valid.
Attribute
PhpToken
UnhandledMatchError
ValueError
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.
FulfillmentsDataStore
WC Order Item Product Data Store
Fulfillment
WC Order Fulfillment Class
FulfillmentException
FulfillmentException class.
FulfillmentOrderNotes
FulfillmentOrderNotes class.
FulfillmentsController
Class FulfillmentsController
FulfillmentsRenderer
FulfillmentsRenderer class.
FulfillmentsSettings
FulfillmentsSettings class.
FulfillmentsTracker
FulfillmentsTracker class.
FulfillmentUtils
Class FulfillmentUtils
AbstractShippingProvider
Abstract class for shipping providers.
ACSCourierShippingProvider
ACSCourier Shipping Provider class.
AmazonLogisticsShippingProvider
Amazon Logistics Shipping Provider implementation.
AnPostShippingProvider
AnPost Shipping Provider class.
ArasKargoShippingProvider
Aras Kargo Shipping Provider class.
AustraliaPostShippingProvider
Australia Post Shipping Provider class.
AzerpostShippingProvider
Azerpost Shipping Provider class.
BartoliniBRTShippingProvider
Bartolini (BRT) Shipping Provider class.
BelpochtaShippingProvider
Belpochta Shipping Provider class.
BpostShippingProvider
Bpost Shipping Provider class.
BulgarianPostsShippingProvider
BulgarianPosts Shipping Provider class.
CanadaPostShippingProvider
Canada Post Shipping Provider class.
CDEKShippingProvider
CDEK Shipping Provider class.
CeskaPostaShippingProvider
Česká pošta Shipping Provider class.
ChronopostShippingProvider
Chronopost Shipping Provider class.
CorreosShippingProvider
Correos Shipping Provider class.
CTTShippingProvider
CTT Shipping Provider class.
CustomShippingProvider
Custom shipping provider loaded from the wc_fulfillment_shipping_provider taxonomy.
CyprusPostShippingProvider
CyprusPost Shipping Provider class.
DeutschePostShippingProvider
Deutsche Post Shipping Provider class.
DHLShippingProvider
DHL Shipping Provider implementation.
DPDShippingProvider
DPD Shipping Provider class.
EcontShippingProvider
Econt Shipping Provider class.
EimskipShippingProvider
Eimskip Shipping Provider class.
ELTAShippingProvider
ELTA Shipping Provider class.
EvriHermesShippingProvider
Evri (Hermes) Shipping Provider class.
FanCourierShippingProvider
Fan Courier Shipping Provider class.
FastwayShippingProvider
Fastway Shipping Provider class.
FedExShippingProvider
FedEx Shipping Provider implementation.
GenikiTaxydromikiShippingProvider
Geniki Taxydromiki Shipping Provider class.
GLSShippingProvider
GLS Shipping Provider class.
HayPostShippingProvider
HayPost Shipping Provider class.
HelthjemShippingProvider
Helthjem Shipping Provider class.
HrvatskaPostaShippingProvider
Hrvatska Posta Shipping Provider class.
InPostShippingProvider
InPost Shipping Provider class.
IslandsposturShippingProvider
Islandspostur Shipping Provider class.
ItellaShippingProvider
Itella Shipping Provider class.
KazpostShippingProvider
Kazpost Shipping Provider class.
LaPosteColissimoShippingProvider
La Poste / Colissimo Shipping Provider class.
LasershipOntracShippingProvider
Lasership/OnTrac Shipping Provider class.
LatvijasPastsShippingProvider
Latvijas Pasts Shipping Provider class.
LiechtensteinischePostShippingProvider
Liechtensteinische Post Shipping Provider class.
MagyarPostaShippingProvider
Magyar Posta Shipping Provider class.
MakedonskaPostaShippingProvider
Makedonska Posta Shipping Provider class.
MaltaPostShippingProvider
MaltaPost Shipping Provider class.
MatkahuoltoShippingProvider
Matkahuolto Shipping Provider class.
MondialRelayShippingProvider
Mondial Relay Shipping Provider class.
MPLShippingProvider
MPL Shipping Provider class.
MRWShippingProvider
MRW Shipping Provider class.
NewZealandPostShippingProvider
New Zealand Post Shipping Provider class.
NovaPoshtaShippingProvider
Nova Poshta Shipping Provider class.
OmnivaShippingProvider
Omniva Shipping Provider class.
OsterreichischePostShippingProvider
Osterreichische Post Shipping Provider class.
ParcelForceShippingProvider
Parcelforce Shipping Provider class.
PocztaPolskaShippingProvider
Poczta Polska Shipping Provider class.
PostaMoldoveiShippingProvider
Posta Moldovei Shipping Provider class.
PostaRomanaShippingProvider
Posta Romana Shipping Provider class.
PosteItalianeShippingProvider
Poste Italiane Shipping Provider class.
PostenNorgeBringShippingProvider
Posten Norge / Bring Shipping Provider class.
PosteSanMarinoShippingProvider
Poste San Marino Shipping Provider class.
PostLuxembourgShippingProvider
POST Luxembourg Shipping Provider class.
PostNLShippingProvider
PostNL Shipping Provider class.
PostNordShippingProvider
PostNord Shipping Provider class.
PurolatorShippingProvider
Purolator Shipping Provider class.
RoyalMailShippingProvider
Royal Mail Shipping Provider class.
RussianPostShippingProvider
Russian Post Shipping Provider class.
SDAShippingProvider
SDA Shipping Provider class.
SeurShippingProvider
SEUR Shipping Provider class.
SlovenskaPostaShippingProvider
Slovenska Posta Shipping Provider class.
SpeeDeeDeliveryShippingProvider
Spee-Dee Delivery Shipping Provider class.
StarTrackShippingProvider
StarTrack Shipping Provider class.
SwissPostShippingProvider
Swiss Post Shipping Provider class.
TollShippingProvider
Toll Shipping Provider class.
UkrposhtaShippingProvider
Ukrposhta Shipping Provider class.
UPSShippingProvider
UPS Shipping Provider class.
UrgentCargusShippingProvider
Urgent Cargus Shipping Provider class.
USPSShippingProvider
USPS Shipping Provider implementation.
YurticiKargoShippingProvider
Yurtici Kargo Shipping Provider class.
ZasilkovnaShippingProvider
Zasilkovna Shipping Provider 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
ApiException
Exception for API errors with error codes and extensions.
ArrayOf
Declares the element type for an array-typed property or return value.
ConnectionOf
Marks a query's return type as a Relay-style connection of the given node type.
Deprecated
Marks a field or enum value as deprecated in the GraphQL schema.
Description
Provides a human-readable description for the annotated element.
Ignore
Tells the builder to skip the annotated element entirely.
Name
Overrides the GraphQL name derived from the PHP class or property name.
Parameter
Declares an explicit GraphQL argument for a query or mutation.
ParameterDescription
Adds a description to a query/mutation argument without overriding its type.
PublicAccess
Marks a query or mutation as publicly accessible without authentication.
RequiredCapability
Declares a WordPress capability required to execute a query or mutation.
ReturnType
Declares the GraphQL return type of execute() when it returns an interface.
ScalarType
Overrides the GraphQL type for a property with a custom scalar.
Unroll
Expands a class's properties into individual flat GraphQL arguments.
AuthorizationException
Thrown from an authorize() method to deny access with a custom error message.
Container
Resolver container for code-API command classes.
CreateCouponInput
Input type for creating a coupon.
UpdateCouponInput
Input type for updating a coupon.
BaseProductInput
Shared fields for product creation and update input types.
CreateProductInput
Input type for creating a product.
DimensionsInput
Input type for product dimensions.
ProductFilterInput
Input type for filtering products.
UpdateProductInput
Input type for updating a product.
CreateCoupon
Mutation to create a new coupon.
DeleteCoupon
Mutation to delete a coupon.
UpdateCoupon
Mutation to update an existing coupon.
CreateProduct
Mutation to create a new product.
DeleteProduct
Mutation to delete a product.
UpdateProduct
Mutation to update an existing product.
Connection
Represents a Relay-style paginated connection.
Edge
Represents an edge in a Relay-style connection.
IdCursorFilter
WP_Query ID-cursor pagination helper.
PageInfo
Pagination metadata for a connection.
PaginationParams
Standard pagination parameters for connection queries.
GetCoupon
ListCoupons
GetProduct
Query to retrieve a single product by ID.
ListProducts
Query to list products with cursor-based pagination.
DateTime
Custom scalar for ISO 8601 date/time values.
Coupon
Output type representing a WooCommerce coupon.
DeleteCouponResult
Result of a coupon deletion operation.
ExternalProduct
Output type representing an external/affiliate product.
ProductAttribute
Output type representing a product attribute definition.
ProductDimensions
Output type representing product physical dimensions.
ProductImage
Output type representing a product image.
ProductReview
Output type representing a product review.
ProductVariation
Output type representing a product variation.
SelectedAttribute
Output type representing a single attribute selection on a variation.
SimpleProduct
Output type representing a simple WooCommerce product.
VariableProduct
Output type representing a variable product with variations.
CouponMapper
Maps a WC_Coupon to the Coupon DTO.
ProductMapper
Maps a WC_Product to the appropriate product DTO.
ProductRepository
Repository for product persistence operations.
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
AddToCartForm 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.
VariationDescription
VariationDescription class.
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.
CategoryDescription
CategoryDescription block: renders the current term description using context.
CategoryTitle
CategoryTitle block: renders the current term title using context.
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.
CouponCode
CouponCode block for displaying coupon codes in emails.
CustomerAccount
CustomerAccount class.
EmailContent
EmailContent 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.
NextPreviousButtons
NextPreviousButtons 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.
PaymentMethodIcons
PaymentMethodIcons 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
ProductDescription 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.
ProductFilterTaxonomy
Product Filter: Taxonomy Block.
ProductGallery
ProductGallery class.
ProductGalleryLargeImage
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.
ProductsStore
Shared store that hydrates the `woocommerce/products` Interactivity API store with product and variation data in Store API format.
PickupLocation
Local Pickup Shipping Method.
BlocksSharedState
Manages the registration of interactivity config and state that is commonly shared by WooCommerce blocks.
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.
DefaultCustomerAddress
Enum class for the possible values of the 'woocommerce_default_customer_address' option.
FeaturePluginCompatibility
Enum class for feature plugin compatibility.
OrderInternalStatus
Enum class for all the internal order statuses.
OrderItemType
Enum class for all the order item types.
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.
TaxBasedOn
Enum class for the possible values of the `woocommerce_tax_based_on` option, which determines which address is used to calculate tax.
AddressRequirements
Class AddressRequirements
Buttons
Handles PayPal Buttons.
Constants
PayPal Gateway Constants.
Helper
PayPal Helper Class
Notices
PayPal Notices Class
Request
PayPal Request Class
TransactAccountManager
PayPal TransactAccountManager Class
WebhookHandler
Class WebhookHandler file.
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.
AgenticCheckoutSession
AgenticCheckoutSession class.
CheckoutSessions
CheckoutSessions class.
CheckoutSessionsComplete
CheckoutSessionsComplete class.
CheckoutSessionsUpdate
CheckoutSessionsUpdate class.
OrderMetaKey
Order meta keys used in Agentic Checkout.
SessionKey
Session keys used in Agentic Checkout.
Error
Error class.
Message
Base class for error and info messages.
MessageError
MessageError class.
MessageInfo
MessageInfo class.
Messages
Class Messages
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.
AgenticCheckoutUtils
AgenticCheckoutUtils 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.
CallbackUtil
Utility class for working with WordPress hooks and callbacks.
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.
MetaDataUtil
Utility methods for handling meta data in REST API requests.
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.
HasFieldsTypeImplementation
ImplementingTypeImplementation
NamedTypeImplementation
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.
TracksProvidedFields
Trait for input types to track which fields were explicitly provided in the GraphQL request.
ObjectWithId
Interface trait for objects that have a numeric ID.
Product
Interface trait for WooCommerce products.
RequiresManageWoocommerce
Trait that grants the manage_woocommerce capability requirement.
EnableBlockJsonAssetsTrait
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
ProductLinksTrait
ProductLinksTrait

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.
wc_interactivity_api_load_product()  : array<string|int, mixed>
Load a product into the interactivity API state.
wc_interactivity_api_load_purchasable_child_products()  : array<string|int, mixed>
Load all purchasable child products of a parent product into the interactivity API state.
wc_interactivity_api_load_variations()  : array<string|int, mixed>
Load all variations of a variable product into the interactivity API state.
fdiv()  : float
preg_last_error_msg()  : string
str_contains()  : bool
str_starts_with()  : bool
str_ends_with()  : bool
get_debug_type()  : string
get_resource_id()  : int
fdiv()  : float
preg_last_error_msg()  : string
str_contains()  : bool
str_starts_with()  : bool
str_ends_with()  : bool
get_debug_type()  : string
get_resource_id()  : int
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.

Functions

wc_get_brand_thumbnail_url()

Helper function :: wc_get_brand_thumbnail_url function.

wc_get_brand_thumbnail_url(int $brand_id[, string $size = 'full' ]) : string
Parameters
$brand_id : int

Brand ID.

$size : string = 'full'

Thumbnail image size.

wc_get_brand_thumbnail_image()

Helper function :: wc_get_brand_thumbnail_image function.

wc_get_brand_thumbnail_image(object $brand[, string $size = '' ]) : string
Parameters
$brand : object

Brand term.

$size : string = ''

Thumbnail image size.

Tags
since
9.4.0

wc_get_brands()

Retrieves product's brands.

wc_get_brands(int $post_id[, string $sep = ', ' ][, string $before = '' ][, string $after = '' ]) : array<string|int, mixed>
Parameters
$post_id : int

Post ID (default: 0).

$sep : string = ', '

Seperator (default: ').

$before : string = ''

Before item (default: '').

$after : string = ''

After item (default: '').

get_brand_thumbnail_url()

Polyfill for get_brand_thumbnail_image.

get_brand_thumbnail_url(int $brand_id[, string $size = 'full' ]) : string
Parameters
$brand_id : int

Brand ID.

$size : string = 'full'

Thumbnail image size.

get_brand_thumbnail_image()

Polyfill for get_brand_thumbnail_image.

get_brand_thumbnail_image(object $brand[, string $size = '' ]) : string
Parameters
$brand : object

Brand term.

$size : string = ''

Thumbnail image size.

get_brands()

Polyfill for get_brands.

get_brands(int $post_id[, string $sep = ', ' ][, string $before = '' ][, string $after = '' ]) : array<string|int, mixed>
Parameters
$post_id : int

Post ID (default: 0).

$sep : string = ', '

Seperator (default: ').

$before : string = ''

Before item (default: '').

$after : string = ''

After item (default: '').

wc_interactivity_api_load_product()

Load a product into the interactivity API state.

wc_interactivity_api_load_product(string $consent_statement, int $product_id) : array<string|int, mixed>

This is an experimental API and may change in future versions.

Parameters
$consent_statement : string

The consent statement acknowledging this is an experimental API.

$product_id : int

The product ID to load.

Tags
see

plugins/woocommerce/client/blocks/assets/js/base/stores/woocommerce/README.md

throws
InvalidArgumentException

If consent statement doesn't match.

wc_interactivity_api_load_purchasable_child_products()

Load all purchasable child products of a parent product into the interactivity API state.

wc_interactivity_api_load_purchasable_child_products(string $consent_statement, int $parent_id) : array<string|int, mixed>

This is an experimental API and may change in future versions.

Parameters
$consent_statement : string

The consent statement acknowledging this is an experimental API.

$parent_id : int

The parent product ID.

Tags
see

plugins/woocommerce/client/blocks/assets/js/base/stores/woocommerce/README.md

throws
InvalidArgumentException

If consent statement doesn't match.

wc_interactivity_api_load_variations()

Load all variations of a variable product into the interactivity API state.

wc_interactivity_api_load_variations(string $consent_statement, int $parent_id) : array<string|int, mixed>

This is an experimental API and may change in future versions.

Parameters
$consent_statement : string

The consent statement acknowledging this is an experimental API.

$parent_id : int

The parent product ID.

Tags
see

plugins/woocommerce/client/blocks/assets/js/base/stores/woocommerce/README.md

throws
InvalidArgumentException

If consent statement doesn't match.

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.

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