WooCommerce Code Reference

Admin

Packages

Customize
MetaBoxes
Pointers
Reports
SystemStatus
Helper
Importers
Metaboxes
Reporting
Shipping
Settings
Webhooks
Export
Logs
Notices
Functions
Templates
Classes
Features
Uninstaller

Interfaces, Classes and Traits

WC_Admin_Addons
WC_Admin_Addons Class.
WC_Admin_API_Keys_Table_List
API Keys table list class.
WC_Admin_API_Keys
WC_Admin_API_Keys.
WC_Admin_Assets
WC_Admin_Assets Class.
WC_Admin_Attributes
WC_Admin_Attributes Class.
WC_Admin_Dashboard_Setup
WC_Admin_Dashboard_Setup Class.
WC_Admin_Dashboard
WC_Admin_Dashboard Class.
WC_Admin_Duplicate_Product
WC_Admin_Duplicate_Product Class.
WC_Admin_Exporters
WC_Admin_Exporters Class.
WC_Admin_Help
WC_Admin_Help Class.
WC_Admin_Importers
WC_Admin_Importers Class.
WC_Admin_Log_Table_List
WC_Admin_Menus
WC_Admin_Menus Class.
WC_Admin_Notices
WC_Admin_Notices Class.
WC_Admin_Permalink_Settings
WC_Admin_Permalink_Settings Class.
WC_Admin_Post_Types
WC_Admin_Post_Types Class.
WC_Admin_Profile
WC_Admin_Profile Class.
WC_Admin_Settings
WC_Admin_Settings Class.
WC_Admin_Setup_Wizard
WC_Admin_Setup_Wizard class.
WC_Admin_Taxonomies
WC_Admin_Taxonomies class.
WC_Admin_Webhooks_Table_List
Webooks table list class.
WC_Admin_Webhooks
WC_Admin_Webhooks.
WC_Admin
WC_Admin class.
WC_Admin_List_Table
WC_Admin_List_Table Class.
WC_Admin_List_Table_Coupons
WC_Admin_List_Table_Coupons Class.
WC_Admin_List_Table_Orders
WC_Admin_List_Table_Orders Class.
WC_Admin_List_Table_Products
WC_Admin_List_Table_Products Class.
WC_Plugin_Updates
WC_Admin_Plugin_Updates Class.
WC_Plugins_Screen_Updates
Class WC_Plugins_Screen_Updates
WC_Updates_Screen_Updates
Class WC_Updates_Screen_Updates
WC_Settings_Accounts
WC_Settings_Accounts.
WC_Settings_Advanced
WC_Settings_Advanced.
WC_Settings_Rest_API
WC_Settings_Rest_API class.
WC_Settings_Emails
WC_Settings_Emails.
WC_Settings_General
WC_Admin_Settings_General.
WC_Settings_Integrations
WC_Settings_Integrations.
WC_Settings_Page
WC_Settings_Page.
WC_Settings_Payment_Gateways
WC_Settings_Payment_Gateways.
WC_Settings_Products
WC_Settings_Products.
WC_Settings_Shipping
WC_Settings_Shipping.
WC_Settings_Tax
WC_Settings_Tax.
CustomizeStoreWithBlocks
Customize_Store_With_Blocks.
InsightFirstProductAndPayment
Insight_First_Sale.
InsightFirstSale
Insight_First_Sale.
SetUpAdditionalPaymentTypes
Set_Up_Additional_Payment_Types
TestCheckout
Test_Checkout
WCPaymentGatewayPreInstallWCPayPromotion
A Psuedo WCPay gateway class.

Table of Contents

wc_admin_get_core_pages_to_connect()  : array<string|int, mixed>
Returns core WC pages to connect to WC-Admin.
wc_admin_filter_core_page_breadcrumbs()  : array<string|int, mixed>
Filter breadcrumbs for core pages that aren't explicitly connected.
wc_admin_connect_core_pages()  : bool
Render the WC-Admin header bar on all WooCommerce core pages.
wc_admin_connect_page()  : mixed
Connect an existing page to WooCommerce Admin.
wc_admin_register_page()  : mixed
Register JS-powered WooCommerce Admin Page.
wc_admin_is_connected_page()  : bool
Is this page connected to WooCommerce Admin? Passthrough to PageController::is_connected_page().
wc_admin_is_registered_page()  : bool
Is this a WooCommerce Admin Page? Passthrough to PageController::is_registered_page().
wc_admin_get_breadcrumbs()  : array<string|int, mixed>
Get breadcrumbs for WooCommerce Admin Page navigation.
wc_admin_update_0201_order_status_index()  : mixed
Update order stats `status` index length.
wc_admin_update_0201_db_version()  : mixed
Update DB Version.
wc_admin_update_0230_rename_gross_total()  : mixed
Rename "gross_total" to "total_sales".
wc_admin_update_0230_db_version()  : mixed
Update DB Version.
wc_admin_update_0251_remove_unsnooze_action()  : mixed
Remove the note unsnoozing scheduled action.
wc_admin_update_0251_db_version()  : mixed
Update DB Version.
wc_admin_update_110_remove_facebook_note()  : mixed
Remove Facebook Extension note.
wc_admin_update_110_db_version()  : mixed
Update DB Version.
wc_admin_update_130_remove_dismiss_action_from_tracking_opt_in_note()  : mixed
Remove Dismiss action from tracking opt-in admin note.
wc_admin_update_130_db_version()  : mixed
Update DB Version.
wc_admin_update_140_change_deactivate_plugin_note_type()  : mixed
Change the deactivate plugin note type to 'info'.
wc_admin_update_140_db_version()  : mixed
Update DB Version.
wc_admin_update_160_remove_facebook_note()  : mixed
Remove Facebook Experts note.
wc_admin_update_160_db_version()  : mixed
Update DB Version.
wc_admin_update_170_homescreen_layout()  : mixed
Set "two column" homescreen layout as default for existing stores.
wc_admin_update_170_db_version()  : mixed
Update DB Version.
wc_admin_update_270_delete_report_downloads()  : mixed
Delete the preexisting export files.
wc_admin_update_270_db_version()  : mixed
Update DB Version.
wc_admin_update_271_update_task_list_options()  : mixed
Update the old task list options.
wc_admin_update_271_db_version()  : mixed
Update DB Version.
wc_admin_update_280_order_status()  : mixed
Update order stats `status`.
wc_admin_update_280_db_version()  : mixed
Update DB Version.
wc_admin_update_290_update_apperance_task_option()  : mixed
Update the old task list options.
wc_admin_update_290_delete_default_homepage_layout_option()  : mixed
Delete the old woocommerce_default_homepage_layout option.
wc_admin_update_290_db_version()  : mixed
Update DB Version.
wc_admin_update_300_update_is_read_from_last_read()  : mixed
Use woocommerce_admin_activity_panel_inbox_last_read from the user meta to set wc_admin_notes.is_read col.
wc_admin_update_300_db_version()  : mixed
Update DB Version.
woocommerce_admin_is_development_version()  : bool
Returns whether the current version is a development version Note this relies on composer.json version, not plugin version.
woocommerce_admin_check_build_files()  : bool
Returns true if build file exists.

Functions

wc_admin_filter_core_page_breadcrumbs()

Filter breadcrumbs for core pages that aren't explicitly connected.

wc_admin_filter_core_page_breadcrumbs(array<string|int, mixed> $breadcrumbs) : array<string|int, mixed>
Parameters
$breadcrumbs : array<string|int, mixed>

Breadcrumb pieces.

wc_admin_connect_core_pages()

Render the WC-Admin header bar on all WooCommerce core pages.

wc_admin_connect_core_pages(bool $is_connected, bool $current_page) : bool
Parameters
$is_connected : bool

Whether the current page is connected.

$current_page : bool

The current page, if connected.

wc_admin_connect_page()

Connect an existing page to WooCommerce Admin.

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

Passthrough to PageController::connect_page().

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

Options for PageController::connect_page().

wc_admin_register_page()

Register JS-powered WooCommerce Admin Page.

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

Passthrough to PageController::register_page().

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

Options for PageController::register_page().

woocommerce_admin_is_development_version()

Returns whether the current version is a development version Note this relies on composer.json version, not plugin version.

woocommerce_admin_is_development_version() : bool

Development installs of the plugin don't have a version defined in composer json.