Home

BigCommerce for Wordpress Reference

Namespaces

\

Classes

ClassDescription
ProviderThis abstract class implements the ServiceProviderInterface from Pimple. It provides functionality for managing
callback registrations and offers a mechanism to access callbacks dynamically through the __get magic method.

Functions

FunctionDescription
is_account_pageChecks if the current page is the account page.
is_cartChecks if the current page is the cart page.
is_checkoutChecks if the current page is the checkout page.
is_productChecks if the current page is a product page.
is_product_categoryChecks if the current page is a product category page.
is_product_tagChecks if the current page is a product tag page.
is_product_taxonomyChecks if the current page is a product taxonomy page.
is_shopChecks if the current page is the shop page.
is_woocommerce_activated
wcRetrieves the WooCommerce facade instance from the container.
wc_get_cart_urlRetrieves the URL of the cart page.
wc_get_checkout_urlRetrieves the URL of the checkout page.
wc_get_image_sizeRetrieves the WooCommerce image size.
wc_get_page_idRetrieves the ID of a WooCommerce page.
wc_get_templateRetrieves and renders a WooCommerce template.
wc_get_template_htmlRetrieves the HTML content for a WooCommerce template.
wc_get_template_partRetrieves a template part for WooCommerce.
wc_locate_templateLocates a WooCommerce template.
wc_print_noticesPrints WooCommerce notices.
woocommerce_mini_cartDisplays the mini cart for WooCommerce.
woocommerce_reset_loopResets the WooCommerce loop.
wp_remove_targeted_link_rel_filtersRemoves the filters added by wp_init_targeted_link_rel_filters()
wp_unschedule_hookUnschedules all events attached to the hook.

\BigCommerce

Classes

ClassDescription
Api_Factory
Plugin

\BigCommerce\Accounts

Classes

ClassDescription
Channel_SettingsManages channel settings related to global logins, syncing customer settings,
and scheduling resyncs for updated global login configurations.
CountriesClass Countries
CustomerHandles customer-specific data and resources such as customer addresses, profiles, orders, and related functionalities.
Customer_GroupClass Customer_Group
Customer_Group_ProxyClass Customer_Group_Proxy
LoginHandles the login and lost password logic for the BigCommerce account integration with WordPress.
Nav_MenuClass Nav_Menu
Password_ResetClass Password_Reset
RegisterClass Register
Sub_NavClass Sub_Nav
User_Profile_SettingsClass User_Profile_Settings

\BigCommerce\Accounts\Roles

Classes

ClassDescription
CustomerClass Customer

Interfaces

InterfaceDescription
RoleInterface Role

\BigCommerce\Accounts\Wishlists

Classes

ClassDescription
Add_Item_ViewClass Add_Item_View
Missing_WishlistClass Missing_Wishlist
Public_WishlistThis class handles the public-facing wishlist view, including customizing the query
to show only products in the wishlist, setting the page title, customizing the
wp_title() function, and managing the “No Results” message on the wishlist page.
WishlistClass Wishlist
Wishlist_Public_ViewAbstract class for handling wishlist public view actions, including filtering main queries,
setting the page title, and modifying results when no items are found.
Wishlist_Request_ParserClass Wishlist_Request_Parser

\BigCommerce\Accounts\Wishlists\Actions

Classes

ClassDescription
Add_ItemHandles requests for adding items to a customer’s wishlist.
Create_WishlistHandles the logic for creating a new wishlist for a customer.
Delete_WishlistHandles the logic for deleting a wishlist.
Edit_WishlistHandles the logic for editing a wishlist.
Remove_ItemHandles the logic for removing an item from a customer’s wishlist.
Request_RouterClass Request_Router
Wishlist_ActionAbstract class for handling wishlist-related actions.

\BigCommerce\Amp

Classes

ClassDescription
Amp_Admin_NoticesCreates an admin notice if requirements for AMP + BC or not met.
Amp_AssetsClass Amp_Assets
Amp_CartClass Amp_Cart
Amp_Cart_Menu_ItemClass Amp_Cart_Menu_Item
Amp_Controller_FactoryClass Amp_Controller_Factory
Amp_Template_OverrideClass Amp_Template_Override
ClassicClass Classic
OverridesClass Overrides

\BigCommerce\Analytics

Classes

ClassDescription
Facebook_PixelClass Facebook_Pixel
Google_AnalyticsClass Google_Analytics
SegmentRenders the Segment analytics tracking code on the site.

\BigCommerce\Analytics\Events

Classes

ClassDescription
Add_To_CartClass Add_To_Cart
View_ProductClass View_Product

\BigCommerce\Api

Classes

ClassDescription
Api_Config_RenewalClass Api_Config_Renewal
Api_Scopes_ValidatorValidates the API scopes for several resources, ensuring that the correct permissions
are in place during the onboarding process. This includes validating scopes for
customers, orders, and payment methods.
Banners_ApiClass Banners_Api
Base_ClientBase API client class that extends the ApiClient and manages the configuration
of the API client. This class is designed to handle the configuration for
API communication and can be extended for specific API clients.
Caching_ClientImplements a short-term caching mechanism around API requests to reduce redundant calls,
particularly useful for operations like cart handling. The cache is invalidated after
any write operation to ensure data consistency.
ConfigurationExtends the base Configuration class to provide additional
functionality, such as filtering default headers for BigCommerce API requests.
ConfigurationRequiredExceptionA specific exception type that extends ApiException to signal
that a required configuration is missing when making API requests.
Currencies_ApiHandles retrieval of currencies from the BigCommerce v2 API.
Customer_ApiProvides methods for interacting with BigCommerce customers via the v2 API.
Marketing_ApiProvides methods for interacting with marketing-related resources in BigCommerce,
including gift certificates.
Null_ClientA placeholder API client that disables API calls.
Payments_ApiProvides methods for interacting with the Payments API in BigCommerce.
Request_HeadersProvides functionality for adding custom headers to API requests, including plugin-specific
information like WordPress version, plugin version, and PHP version.
Shipping_ApiHandles API v2 requests for shipping data, including zones and shipping methods.
Store_ApiHandle retrieving information about the store from APIv2.
Tax_Class_ApiHandle tax data requests.
Webhooks_ApiCreates an adapter class for the BC v2 API webhook endpoint.
v2ApiAdapterProvides an adapter for interacting with the BigCommerce API. This class includes methods for
retrieving collections and resources, as well as creating, updating, and deleting resources.

Traits

TraitDescription
Api_Data_SanitizerTrait Api_Data_Sanitizer

\BigCommerce\Assets\Admin

Classes

ClassDescription
JS_ConfigHandles the configuration for JavaScript assets in the BigCommerce admin.
JS_LocalizationClass JS_Localization
ScriptsHandles the enqueueing and registration of admin scripts and Gutenberg-specific scripts.
StylesHandles the enqueueing and registration of admin and Gutenberg-specific CSS styles.

\BigCommerce\Assets\Theme

Classes

ClassDescription
Image_SizesClass Image_Sizes
JS_ConfigHandles the configuration for JavaScript data, which includes store settings,
product messages, channel data, and other theme-specific data required for the frontend.
JS_LocalizationHandles the localization of JavaScript strings for the theme. This class generates an array of text
strings used in JavaScript, which can be filtered and sanitized before being passed to the frontend.
ScriptsManages the enqueuing of JavaScript files for the theme. It handles the inclusion of asset files,
conditional script loading based on page type, and localization of JavaScript data.
StylesManages the enqueuing of CSS stylesheets for the theme. This includes handling the inclusion of
asset files and applying any filters to the stylesheet before it is enqueued. It also checks the
theme settings to conditionally load the styles based on user preferences.

\BigCommerce\Banners

Classes

ClassDescription
BannersHandles the management and display of banners on various pages of the BigCommerce WordPress theme. It
provides methods to configure JavaScript settings, fetch banners from the API, and filter banners based
on the current page context, visibility, and date range.

\BigCommerce\CLI

Classes

ClassDescription
CommandThis is an abstract base class for creating custom WP-CLI commands in the BigCommerce CLI namespace.
Import_ProductsHandles the import process for products from BigCommerce.
Reset_PluginResets various options in WordPress to bring the site back to the beginning of the BigCommerce account onboarding flow.
Update_Country_CacheUpdates the country and state cache in a JSON file located at assets/data/countries.json.

\BigCommerce\CLI\Documentation

Classes

ClassDescription
Build_DocsRegister build docs command and related functionality
Data_ImporterExtends WP_Parser’s Importer class to modify the import behavior for class methods and hooks.
Import_DocsClass Import_Docs

\BigCommerce\CLI\Resources

Classes

ClassDescription
Build_ResourcesClass Build_Resources
ResourceClass Resource
Resource_GroupRepresents a group of resources, which are categorized by a label.

\BigCommerce\Cache

Classes

ClassDescription
Cache_HandlerCache_Handler class

\BigCommerce\Cart

Classes

ClassDescription
Add_To_CartHandles requests from the Add to Cart button for products
Buy_NowHandles requests from the Buy Now button for products.
Cache_ControlClass Cache_Control
CartHandles cart operations such as adding line items, managing cookies, and interacting with the BigCommerce API.
Cart_MapperMaps a cart from the API to a standard format usable by the
REST API and other templates.
Cart_Menu_ItemThe Cart_Menu_Item class is responsible for modifying WordPress navigation menu items
to display cart-related information. It specifically adds a cart item count to the menu
item representing the cart page and ensures the proper display of this count based on
various conditions like checkout settings and the status of the mini-cart.
Cart_RecoveryThe Cart_Recovery class is responsible for handling the recovery of abandoned carts.
CheckoutHandles requests during checkout from the Buy Now button for products.
Item_CounterProvides functionality to count the number of items in a BigCommerce cart.
Mini_CartManages the configuration and display logic for the mini-cart widget in BigCommerce.

\BigCommerce\Checkout

Classes

ClassDescription
Customer_LoginHandles customer login logic during the checkout process.
Requirements_NoticeShows a notice if the required configuration for checkout is not complete

\BigCommerce\Compatibility

Classes

ClassDescription
Template_CompatibilityProvides compatibility functionality to override WooCommerce page templates.

Interfaces

InterfaceDescription
Spam_CheckerDefines the contract for a spam checker, which can be used to determine whether a given content is considered spam.

\BigCommerce\Compatibility\Akismet

Classes

ClassDescription
AkismetThis class implements the Spam_Checker interface and uses the Akismet API to determine if a submission is considered spam.

\BigCommerce\Compatibility\Matomo

Classes

ClassDescription
MatomoThis class integrates BigCommerce with Matomo (formerly Piwik), a web analytics platform. It provides functionality for
modifying the JavaScript configuration for tracking user interactions with custom variables in Matomo.

\BigCommerce\Compatibility\Themes

Classes

ClassDescription
Null_ThemeA placeholder class for themes that do not require any compatibility layer.
ThemeBase class for themes, providing functionality for rendering templates and checking version compatibility.
Theme_FactoryFactory class for creating theme instances based on template name and version.

\BigCommerce\Compatibility\Themes\Flatsome

Classes

ClassDescription
FlatsomeThis class defines the compatibility layer for the Flatsome theme in the BigCommerce ecosystem.

\BigCommerce\Compatibility\Themes\Flatsome\Templates

Classes

ClassDescription
Account_LinksThis class is responsible for generating the account links for the user’s account page in the Flatsome theme.

\BigCommerce\Compatibility\WooCommerce

Classes

ClassDescription
CartThis class handles the interaction between the WooCommerce cart and BigCommerce’s cart API.
FacadeThis class acts as a facade for the WooCommerce cart, providing a simplified interface for interacting with the BigCommerce cart.

\BigCommerce\Container

Classes

ClassDescription
AccountsClass Accounts
AmpThis class integrates AMP (Accelerated Mobile Pages) functionality into the BigCommerce platform.
AnalyticsHandles the registration and configuration of analytics services and events for BigCommerce.
ApiManages the registration and configuration of the BigCommerce API client and related services.
AssetsProvides asset management for the BigCommerce plugin, including scripts, styles,
configuration, and localization for both the admin and frontend.
BannersThis class is responsible for managing the banners service within the dependency injection container.
CartCart service provider for managing cart-related functionality.
CheckoutHandles the registration of checkout-related services and actions.
CliProvides CLI services for the BigCommerce plugin.
CompatibilityProvides integration with various third-party services and themes, including WooCommerce, Matomo, and Akismet.
CurrencyCurrency container provider class.
EditorLoads behavior relevant to the admin post editor, including rendering custom buttons,
templates, and Gutenberg blocks within the WordPress admin interface. It also handles
the integration of the Gutenberg editor with BigCommerce blocks and assets.
FormsForms class handles various form actions within BigCommerce, such as registration, address updates, product reviews, and more.
Gift_CertificatesThis class provides functionality for registering and handling the gift certificates sub-navigation
in the BigCommerce environment. It extends the Provider class and implements a registration method
to add a sub-navigation to the content.
GraphQLThis class provides functionality for registering GraphQL-related services, such as various
query objects and a GraphQL requestor processor, in the BigCommerce container. The register
method configures these services to be accessed globally through the container.
ImageThis class provides functionality for registering image-related services and hooks related to
image import and CDN management within the BigCommerce container. It includes hooks that
determine if image import is allowed and modify image HTML to load images from a CDN if applicable.
ImportThis class handles the import process for BigCommerce data. It includes functionality
to manage cron jobs, process various import tasks, handle batch sizes, and trigger
different import-related actions.
LogThis class is responsible for setting up logging functionality in the BigCommerce container.
MerchantHandles merchant-related onboarding and account management for BigCommerce integration.
Nav_MenuProvides dependencies and behaviors for navigation menus.
PagesProvides page-related services and ensures required pages exist for BigCommerce integration.
Post_MetaThis class provides methods to handle post metadata related tasks in the container. It extends the Provider class
and registers dependencies related to post metadata processing within the container.
Post_TypesHandles the management of custom post types, particularly for products in the WordPress admin interface.
ProxyThis class registers the proxy container that adds a Wordpress proxy layer on top of the BigCommerce API.
RestProvides RESTful controllers and endpoints for BigCommerce integration.
ReviewsProvides functionality for managing reviews in the BigCommerce container.
RewritesHandles rewrite rules and flushing mechanisms for the BigCommerce container.
SchemaManages the registration of database schema-related services and roles.
SettingsProvides various screens and settings for BigCommerce.
ShortcodesRegisters shortcodes for various storefront features.
TaxonomiesThis class is responsible for managing and registering taxonomies for BigCommerce integration. It defines constants for various taxonomies and handles their configuration and filtering via WordPress hooks.
TemplatesHandles template overrides and body class modifications
within the BigCommerce integration. It registers various filters to modify the template paths and
the body class dynamically based on the context, such as product pages, archives, taxonomies, and search results.
Theme_CustomizerRegisters theme customizer panels, sections, and styles in WordPress.
UtilClass Util
WebhooksProvider for handling BigCommerce webhooks.
WidgetsRegisters and manages widgets for the application.

\BigCommerce\Currency

Classes

ClassDescription
Configurable_FormatterClass for configuring and formatting currency values.
CurrencyHandles currency operations, including fetching and setting currency codes and managing channel-aware currencies.
Formatter_FactoryFactory class to create and manage currency formatters.
Intl_FormatterFormatter class for currency values using PHP’s intl extension.
USD_FormatterFormatter class for currency values specifically in USD.

Traits

TraitDescription
With_CurrencyProvides currency formatting functionality for classes.

Interfaces

InterfaceDescription
Currency_FormatterInterface for formatting numeric values into currency strings.

\BigCommerce\Customizer

Classes

ClassDescription
StylesThis class handles the customization of CSS styles for BigCommerce components.

\BigCommerce\Customizer\Controls

Classes

ClassDescription
Multiple_CheckboxesClass Multiple_Checkboxes

\BigCommerce\Customizer\Panels

Classes

ClassDescription
PrimaryClass Primary

\BigCommerce\Customizer\Sections

Classes

ClassDescription
BannersRepresents the Customizer section for managing banner settings in the BigCommerce store.
ButtonsA customizer section that handles button label settings for various BigCommerce buttons in the WordPress Customizer.
CartHandles the customization options for the Cart section in the WordPress Customizer.
CheckoutHandles the customization options for the Checkout section in the WordPress Customizer.
ColorsHandles the customization constants for colors and themes in the BigCommerce plugin.
Product_ArchiveCustomizer settings and controls for the Product Archive section.
Product_CategoryHandles the customization of product category settings and controls.
Product_SingleHandles settings and constants related to the single product page in the BigCommerce integration.

\BigCommerce\Editor

Classes

ClassDescription
Add_Products_ButtonA class to render the “Add Products” button in the editor.
Editor_Dialog_TemplateA class that handles rendering the editor dialog template with product filtering options.

\BigCommerce\Editor\Gutenberg

Classes

ClassDescription
Migrate_BlocksHandles the migration of shortcodes to Gutenberg blocks in the editor. When a post is loaded in the
Gutenberg editor, this class manages the transition from legacy shortcodes to dynamic blocks
specific to the BigCommerce platform.

\BigCommerce\Editor\Gutenberg\Blocks

Classes

ClassDescription
Account_ProfileA block to display the current user’s account profile.
Address_ListA block to display the current user’s addresses.
CartA block to display the current user’s cart.
CheckoutA block to display the checkout form.
Gift_Certificate_BalanceA block to display the gift certificate balance form.
Gift_Certificate_FormA block to display the gift certificate form.
Gutenberg_BlockA base class for creating Gutenberg blocks in BigCommerce.
Login_FormA block to display the login form.
Order_HistoryA block to display the current user’s order history.
Product_ComponentsA block to display a given product’s components.
Product_ReviewsA block to display a given product’s reviews.
ProductsA block to add one or more products into the post content.
Registration_FormA block to display the registration form.
Shortcode_BlockA Gutenberg Block that acts as a wrapper for a shortcode.
WishlistA block to display the wishlist.

\BigCommerce\Exceptions

Classes

ClassDescription
Channel_Not_Found_ExceptionException thrown when a channel cannot be found in the system.
Component_Not_Found_ExceptionException thrown when a component cannot be found in the system.
No_Task_Found_ExceptionException thrown when a task cannot be found in the system.
Product_Not_Found_ExceptionException thrown when a product cannot be found in the system.

\BigCommerce\Forms

Classes

ClassDescription
Delete_Address_HandlerHandles the deletion of a customer’s address from their account.
Error_HandlerHandles form error management, including storing and retrieving errors for redirection.
Form_RedirectHandles redirection after a form submission.
MessagesHandles rendering of messages (success or error) above forms or within form submissions.
Product_Review_Handler
Purchase_Gift_Certificate_HandlerHandles the submission and processing of gift certificate purchase forms.
Registration_HandlerHandles user registration requests and form submissions for account creation.
Success_HandlerHandles the success of form submissions by storing a success message, form submission data,
and optionally redirecting the user to a specified URL or reloading the current page.
Switch_Currency_HandlerHandles the logic for switching currencies in the BigCommerce cart and triggers success/error actions.
Update_Address_HandlerHandles the updating and creation of customer addresses.
Update_Profile_HandlerHandles the profile update form submission process.

Interfaces

InterfaceDescription
Form_HandlerInterface for handling form submissions.

\BigCommerce\Functions

Functions

FunctionDescription
product_post_reviewsRender reviews section for a product by post ID
product_reviewsRender reviews section for a product by BigCommerce ID

\BigCommerce\Gift_Certificates

Classes

ClassDescription
Sub_NavThis class is responsible for adding a sub-navigation menu to the gift certificate and balance check pages.

\BigCommerce\GraphQL

Classes

ClassDescription
BaseGQLHandles interactions with the BigCommerce GraphQL API, including token management, making authenticated requests, and handling store-related information.
Customer_QueryHandles customer-related GraphQL queries and fragments.
GraphQL_ProcessorThis class is responsible for handling GraphQL requests in the BigCommerce API context.
Product_QueryHandle product query data and fragments.
Reviews_QueryThis class is responsible for constructing GraphQL queries related to product reviews.
Terms_QueryThis class is responsible for constructing GraphQL queries related to terms,
including categories and brands. It provides methods to fetch term details
such as name, ID, and default image.

\BigCommerce\Import

Classes

ClassDescription
Cache_CleanupClass Cache_Cleanup
Image_ImporterClass Image_Importer
Import_Type
Task_Definition
Task_ManagerClass Task_Manager

Traits

TraitDescription
No_Cache_OptionsTrait No_Cache_Options

Interfaces

InterfaceDescription
Import_Strategy

\BigCommerce\Import\Importers\Products

Classes

ClassDescription
Product_BuilderResponsible for constructing product-related data structures
during the import process for BigCommerce products.
Product_CreatorHandles the creation and saving of BigCommerce products into WordPress.
Product_IgnorerStrategy for skipping a product during the import process.
Product_ImporterHandles the import of a product from BigCommerce to WordPress.
Product_RemoverHandles the removal of products from WordPress by matching them with their
corresponding BigCommerce product IDs and channel terms.
Product_SaverHandles storing a product in the database, including saving product details,
taxonomy terms, images, and sending notifications after the product has been imported.
Product_Strategy_FactoryFactory class for determining the appropriate import strategy for a product.
Product_UpdaterHandles updating of products during the import process. It extends the Product_Saver class and overrides
the send_notifications method to send notifications when a product is updated.

\BigCommerce\Import\Importers\Terms

Classes

ClassDescription
Term_CreatorClass Term_Creator
Term_IgnorerHandles the logic for skipping the import of a term in the BigCommerce import process. This class implements
the Import_Strategy interface and provides a method for processing a term that should be ignored.
Term_SaverProvides functionality for saving terms into WordPress, including term data, term metadata,
and term images. This class implements the Import_Strategy interface, allowing it to be used
within an import process. It contains methods for handling terms in BigCommerce and saving them
in WordPress.
Term_Strategy_FactoryA factory class that determines the appropriate strategy for handling term imports,
such as creating, updating, or ignoring a term based on its existing data in WordPress.
Term_UpdaterThis class is responsible for updating an existing term in WordPress with data from BigCommerce.

\BigCommerce\Import\Mappers

Classes

ClassDescription
Brand_MapperThis class is responsible for mapping the BigCommerce brand data to a WordPress term.
Product_Category_MapperThis class is responsible for mapping the BigCommerce product category data to a WordPress term.
Term_MapperThis abstract class provides the base functionality for mapping BigCommerce terms to WordPress terms.

\BigCommerce\Import\Processors

Classes

ClassDescription
Brand_ImportThis class handles the import process for BigCommerce brands. It extends the base Term_Import class
and provides the specific functionality for importing and updating brand terms in WordPress.
Brand_PurgeThis class handles the process of purging (deleting) BigCommerce brand terms from WordPress.
Category_ImportAbstract class for processing term imports.
Category_PurgeThis class handles the process of purging product categories. It extends the
Term_Purge class and uses the CategoriesTrees trait to manage category trees.
Channel_InitializerInitializes a channel by linking it to the full product catalog.
CleanupHandles the cleanup process for BigCommerce imports, including purging product and user transients,
cleaning up queued tasks, and flushing cache related to products and customer groups.
CurrenciesThis class handles fetching, processing, and storing currency information from BigCommerce.
Default_Customer_GroupHandles operations related to the default customer group for BigCommerce integrations.
Deleted_Product_Marker
Error_Handler
Headless
Headless_Product_Processor
Image_Resizer
Listing_Fetcher
ProductCleanupPurge BC products
Product_Data_Fetcher
Queue_Runner
Start_Import
Store_Settings
Storefront_Processor
Term_ImportAbstract class for processing term imports.
Term_PurgeClass Term_Purge

Traits

TraitDescription
CategoriesTreesThis trait provides methods for working with BigCommerce category trees.

Interfaces

InterfaceDescription
Import_Processor

\BigCommerce\Import\Runner

Classes

ClassDescription
AsyncProcessing_RunnerHandles asynchronous processing for BigCommerce import operations.
CLI_RunnerCLI Runner for BigCommerce imports.
Cron_MonitorClass Cron_Monitor
Cron_RunnerHandles the scheduling and execution of BigCommerce import processes via WordPress cron.
Cron_SchedulerHandles scheduling of import tasks using WordPress cron system.
LockManages a lock mechanism for the BigCommerce import process using WordPress options.
Lock_MonitorClass Lock_Monitor
StatusManages the import process status tracking and logging system for BigCommerce imports.

\BigCommerce\Logging

Classes

ClassDescription
Error_LogClass Log

\BigCommerce\Manager

Classes

ClassDescription
Channel_Update_Task
Manager

Interfaces

InterfaceDescription
Task

\BigCommerce\Merchant

Classes

ClassDescription
Account_Status
Connect_Account
Create_Account
Onboarding_Api
Setup_StatusClass Setup_Status

\BigCommerce\Merchant\Models

Classes

ClassDescription
Account_ContactClass Account_Contact
Connect_Account_Request
Create_Account_Request
Customer_Login_Request

\BigCommerce\Meta_Boxes

Classes

ClassDescription
Meta_Box
Post_Meta_Box

\BigCommerce\Nav_Menu

Classes

ClassDescription
Dynamic_Menu_Items
Nav_Items_CustomizerResponsible for adding the BigCommerce nav items
into the theme customizer
Nav_Items_Meta_BoxResponsible for handling the BigCommerce menu items
in the nav menu admin

\BigCommerce\Pages

Classes

ClassDescription
Account_Page
Address_Page
Cart_Page
Check_Balance_Page
Checkout_Complete_Page
Checkout_Page
Gift_Certificate_Page
Login_Page
Orders_Page
Registration_Page
Required_Page
Shipping_Returns_Page
Wishlist_Page

\BigCommerce\Post_Types

Classes

ClassDescription
Post_Type_Config

\BigCommerce\Post_Types\Product

Classes

ClassDescription
Admin_ListHandles extra columns for the BigCommerce Products post type
Admin_UI
Channel_IndicatorClass Channel_Indicator
Channel_SyncClass Channel_Sync
Config
Deletion
Product
QueryHandles custom BigCommerce product queries in WordPress.
Query_Mapper
Reset_ListingClass Reset_Listing
SeoClass Seo
Single_Product_SyncClass Single_Product_Sync
Store_Links
Unique_Slug_FilterClass Unique_Slug_Filter
Unsupported_Products
WPGraph_Config
WPGraph_Product

\BigCommerce\Post_Types\Queue_Task

Classes

ClassDescription
Config
Queue_Task

\BigCommerce\Post_Types\Sync_Log

Classes

ClassDescription
Config
Sync_Log

\BigCommerce\Proxy

Classes

ClassDescription
AMP_Cart_ControllerAMP_Cart_Controller class
Proxy_CacheProxy_Cache class
Proxy_ControllerProxy_Controller class

\BigCommerce\Rest

Classes

ClassDescription
Cart_Controller
Coupon_Code_Controller
Orders_Shortcode_Controller
Pricing_Controller
Product_Component_Shortcode_Controller
Products_ControllerClass Products_Controller
Rest_Controller
Reviews_Listing_Controller
Shipping_Controller
Shortcode_ControllerClass Products_Controller
Storefront_Controller
Terms_Controller

\BigCommerce\Reviews

Classes

ClassDescription
Product_Update_ListenerClass Product_Update_Listener
Review_Builder
Review_CacheClass Review_Cache
Review_Fetcher

\BigCommerce\Rewrites

Classes

ClassDescription
Action_Endpoint
FlusherHandles flushing and scheduling of WordPress rewrite rules for the BigCommerce plugin.

\BigCommerce\Schema

Classes

ClassDescription
Queue_TableClass Queue_Table
Reviews_TableClass Reviews_Table
Schema
Table_MakerClass Table_Maker
User_Roles

\BigCommerce\Settings

Classes

ClassDescription
Abort_Import
Connection_Status
Flush_Cache
Import_Now
Import_StatusClass Import_Status
Onboarding_Progress
Onboarding_Videos
Site_URL_Sync
Start_OverClass Start_Over

\BigCommerce\Settings\Screens

Classes

ClassDescription
Abstract_ScreenAbstract base class for managing plugin settings screens.
Api_Credentials_ScreenAbstract base class for managing plugin settings screens.
Connect_Channel_ScreenAbstract base class for managing plugin settings screens.
Create_Account_ScreenAbstract base class for managing plugin settings screens.
Nav_Menu_ScreenAbstract base class for managing plugin settings screens.
Onboarding_Complete_ScreenAbstract base class for managing plugin settings screens.
Onboarding_ScreenAbstract base class for managing plugin settings screens.
Pending_Account_ScreenAbstract base class for managing plugin settings screens.
Resources_ScreenAbstract base class for managing plugin settings screens.
Settings_ScreenAbstract base class for managing plugin settings screens.
Store_Type_ScreenClass Store_Type_Screen
Welcome_ScreenAbstract base class for managing plugin settings screens.

\BigCommerce\Settings\Sections

Classes

ClassDescription
Account_Settings
Analytics
Api_Credentials
Cart
Channel_Select
ChannelsClass Channels
Currency
Gift_Certificates
Import
Nav_Menu_Options
New_Account_Section
Next_StepsClass Next_Steps
Onboarding_Import_Settings
Reviews
Settings_Section
Troubleshooting_DiagnosticsClass Troubleshooting_Diagnostics
UnitsClass Units
WishlistsClass Wishlists

Traits

TraitDescription
Images
ImportType
Webhooks
WithPages

\BigCommerce\Shortcodes

Classes

ClassDescription
Account_Profile
Address_List
Cart
Checkout
Gift_Certificate_Balance
Gift_Certificate_Form
Login_Form
Order_HistoryProvides a shortcode to display the order history for logged-in users.
Product_Components
Product_Reviews
Products
Registration_Form
Wishlist

Interfaces

InterfaceDescription
Shortcode

\BigCommerce\Taxonomies

Classes

ClassDescription
Taxonomy_Config

\BigCommerce\Taxonomies\Availability

Classes

ClassDescription
Availability
Config

\BigCommerce\Taxonomies\Brand

Classes

ClassDescription
Brand
Config

\BigCommerce\Taxonomies\Channel

Classes

ClassDescription
Admin_Products_FilterClass Admin_Products_Filter
BC_Status
Channel
Channel_ConnectorClass Channel_Connector
Channel_SynchronizerClass Channel_Synchronizer
Config
Connections
Currency_Filter
Query_FilterClass Query_Filter
RoutesClass Routes

\BigCommerce\Taxonomies\Condition

Classes

ClassDescription
Condition
Config

\BigCommerce\Taxonomies\Flag

Classes

ClassDescription
Config
Flag

\BigCommerce\Taxonomies\Product_Category

Classes

ClassDescription
Config
Group_Filtered_Terms
Product_Category
Query_Filter

\BigCommerce\Taxonomies\Product_Type

Classes

ClassDescription
Config
Product_Type

\BigCommerce\Templates

Classes

ClassDescription
Address_Actions
Address_Delete
Address_Form
Address_Formatted
Address_List
Address_New
Amp_Cart_ActionsAmp_Cart_Actions class
Amp_Cart_ItemsAmp_Cart_Items class
Amp_Cart_SummaryAmp_Cart_Summary class
Body_Classes
Cart
Cart_Action_Checkout
Cart_Action_View
Cart_Actions
Cart_Coupon_Code
Cart_Empty
Cart_Error_Message
Cart_Footer
Cart_Header
Cart_Items
Cart_Summary
Controller
Controller_Factory
Currency_Switcher_Form
Fallback_Image
Form_Controller
Gift_Certificate_Balance_Form
Gift_Certificate_Balance_Page
Gift_Certificate_Balance_Response
Gift_Certificate_Form
Gift_Certificate_Page
Gift_Certificate_Redemption_Instructions
Inventory_Level
Linked_Product_Featured_Image
Login_Form
Lost_Password_Form
Message
Message_Group
Mini_Cart
Mini_Cart_Actions
Mini_Cart_Footer
Mini_Cart_Header
Mini_Cart_Items
Mini_Cart_Summary
No_Results
Order_Details
Order_History
Order_Not_Found
Order_Product
Order_Shipment
Order_Summary
Orders_Shortcode_Pagination
Page_Wrapper
Product_Archive
Product_Brand
Product_Card
Product_Card_Preview
Product_Condition
Product_Description
Product_Featured_Image
Product_Form
Product_Form_PreviewA specialized version of the product form that disables purchase functionality.
Product_Gallery
Product_Hidden_Price
Product_Not_Available
Product_Options
Product_Price
Product_Quick_View
Product_Rating
Product_Reviews
Product_Shortcode_Grid
Product_Shortcode_Pagination
Product_Shortcode_Single
Product_Shortcode_Single_Preview
Product_Single
Product_Sku
Product_Specs
Product_Title
Profile_Form
Quick_View_Image
Refinement_Box
Refinery
Registration_Form
Related_Product
Related_Products_Grid
Review_Form
Review_List
Review_List_Pagination
Review_Single
Search_Box
Shipping_Info_Button
Shipping_Methods
Shipping_Zones_Dropdown
Sub_Nav_Links
Template
Template_OverrideClass Template_Override
View_Product_Button
Wishlist_Add_Item
Wishlist_Create
Wishlist_Delete
Wishlist_Detail
Wishlist_Detail_Breadcrumb
Wishlist_Detail_Header
Wishlist_Detail_Share
Wishlist_Edit
Wishlist_List
Wishlist_List_Row
Wishlist_New_Button
Wishlist_New_LinkClass Wishlist_New_Link
Wishlist_Not_Available
Wishlist_ProductClass Wishlist_Product

Traits

TraitDescription
CDN_Images
Product_TemplateTrait

\BigCommerce\Templates\Option_Types

Classes

ClassDescription
Option_Checkbox
Option_Date
Option_Dropdown
Option_Number
Option_Product_List
Option_Product_List_With_Images
Option_Radios
Option_Rectangles
Option_Swatch
Option_Text
Option_Textarea
Option_Type

\BigCommerce\Util

Classes

ClassDescription
Cart_Item_Iterator
Kses

\BigCommerce\Webhooks

Classes

ClassDescription
Checkout_Complete_WebhookClass Checkout Complete Webhook
StatusClass Status
WebhookSets up a webhook in the BigCommerce API to send event-based requests to the WP site.
Webhook_Cron_TasksClass Webhook_Cron_Tasks
Webhook_ListenerClass Webhook_Listener
Webhook_VersioningClass Webhook_Versioning

Traits

TraitDescription
WebhookTrait

\BigCommerce\Webhooks\Customer

Classes

ClassDescription
Customer_Channel_UpdaterAbstract class for handling BigCommerce customer webhook operations.
Customer_Channel_WebhookClass Customer_Channel_Webhook
Customer_Create_WebhookClass Customer_Create_Webhook
Customer_CreatorAbstract class for handling BigCommerce customer webhook operations.
Customer_Delete_WebhookClass Product_Delete_Webhook
Customer_DeleterAbstract class for handling BigCommerce customer webhook operations.
Customer_SaverAbstract class for handling BigCommerce customer webhook operations.
Customer_Update_WebhookClass Customer_Update_Webhook
Customer_UpdaterAbstract class for handling BigCommerce customer webhook operations.

\BigCommerce\Webhooks\Product

Classes

ClassDescription
Channel_Updater
Channels_Assign
Channels_Currency_Update
Channels_Management_WebhookClass Channels_Management_Webhook
Channels_Manager
Channels_UnAssign
Product_Create_WebhookClass Product_Create_Webhook
Product_CreatorHandles the creation of a new product from BigCommerce via webhooks.
Product_Delete_WebhookClass Product_Delete_Webhook
Product_Inventory_Update_WebhookClass Product_Inventory_Update_Webhook
Product_Update_WebhookClass Product_Update_Webhook
Product_UpdaterClass Product_Updater

\BigCommerce\Widgets

Classes

ClassDescription
Currency_Switcher_WidgetClass Currency_Switcher_Widget
Mini_Cart_WidgetClass Product_Category_Widget
Product_Category_WidgetClass Product_Category_Widget

Automatically generated on 2025-01-21