WooCommerce Admin UI Development
Before writing code
Fetch live docs:
- Web-search
site:developer.woocommerce.com settings api for Settings API guide
- Web-search
site:developer.wordpress.org plugins administration-menus for WordPress admin menus
- Web-search
woocommerce admin custom settings page for current patterns
Settings API
WC_Settings_API (For Gateways/Methods)
Payment gateways and shipping methods use WC_Settings_API:
- Define fields in
init_form_fields() as associative array
- Field types:
text, textarea, select, multiselect, checkbox, password, title, decimal, color
- Rendered automatically via
$this->generate_settings_html()
- Saved/loaded automatically via
get_option() / update_option()
WC_Settings_Page (Custom Settings Tabs)
Add a new tab to WooCommerce > Settings:
- Extend
WC_Settings_Page
- Set
$this->id and $this->label
- Implement
get_settings_for_default_section() — return settings array
- Register via
woocommerce_get_settings_pages filter
Settings Field Format
Each field is an array with keys:
id — option name (stored in wp_options)
title — field label
type — text, select, checkbox, textarea, number, sectionend, title
default — default value
desc — description text
options — for select/multiselect
css — inline CSS for the input
Admin Menus
Adding Sub-Menus Under WooCommerce
add_submenu_page( 'woocommerce', $page_title, $menu_title, $capability, $slug, $callback )
Top-Level Menus
add_menu_page() for standalone admin sections — less common for WC extensions.
Capability Checks
manage_woocommerce — WooCommerce admin capability
edit_shop_orders — order management
edit_products — product management
- Always check capabilities in menu and page callbacks
Product Data Panels
Adding Tabs
Filter woocommerce_product_data_tabs:
$tabs['my_tab'] = [
'label' => __( 'My Tab', 'my-plugin' ),
'target' => 'my_tab_data',
'class' => [ 'show_if_simple', 'show_if_variable' ],
'priority' => 60,
];
Adding Panel Content
Action woocommerce_product_data_panels:
- Render HTML inside a
<div id="my_tab_data" class="panel"> matching the tab target
- Use
woocommerce_wp_text_input(), woocommerce_wp_select(), etc.
Saving Panel Data
Action woocommerce_process_product_meta — receives $post_id:
- Sanitize input:
sanitize_text_field( $_POST['my_field'] )
- Save:
$product->update_meta_data( '_my_field', $value ) then $product->save()
Order Admin Customization
Meta Boxes
Add custom meta boxes to the order edit screen:
add_meta_box( $id, $title, $callback, 'woocommerce_page_wc-orders', $context, $priority )
- For HPOS: use screen ID
woocommerce_page_wc-orders (not shop_order)
- For legacy: use post type
shop_order
Order Actions
Filter woocommerce_order_actions to add custom order actions.
Bulk Actions
Filter bulk_actions-edit-shop_order (legacy) or bulk_actions-woocommerce_page_wc-orders (HPOS).
WooCommerce Admin (React-Based)
Analytics & Reports
WooCommerce Admin is a React SPA for:
- Revenue, Orders, Products, Categories, Coupons, Taxes, Downloads reports
- Dashboard with customizable widgets
- Activity panel (orders, reviews, stock)
Extending Analytics
Use @woocommerce/data and @woocommerce/components packages:
- Add custom report pages via
woocommerce_admin_reports_pages filter (PHP)
- Register custom analytics data stores
- Extend existing reports with additional columns
Admin Notices
WooCommerce Admin Notices
WC_Admin_Notices::add_custom_notice( $name, $html ) — persistent notices
wc_admin_notice() helper for one-time notices
admin_notices action for standard WordPress admin notices
Best Practices
- Use WooCommerce Settings API for gateway/method settings
- Use
WC_Settings_Page for custom settings tabs
- Always check capabilities (
manage_woocommerce, edit_products, etc.)
- Use HPOS-compatible screen IDs for order meta boxes
- Sanitize all admin form input before saving
- Use nonces for all admin form submissions
- Localize admin strings with
__() / esc_html__()
Fetch the WooCommerce Settings API docs and WordPress admin handbook for exact field types, hook names, and screen IDs before implementing.
1---2name: woo-admin3description: Build WooCommerce admin interfaces — settings pages, admin menus, product data tabs/panels, order meta boxes, WooCommerce Admin (React analytics), and reports. Use when creating admin-facing configuration or display pages.4allowed-tools: Read, Write, Edit, Bash, Grep, Glob, WebSearch, WebFetch5metadata:6 source: https://skillmd.com/skills/orcaqubits/woo-admin7---89# WooCommerce Admin UI Development1011## Before writing code1213**Fetch live docs**:141. Web-search `site:developer.woocommerce.com settings api` for Settings API guide152. Web-search `site:developer.wordpress.org plugins administration-menus` for WordPress admin menus163. Web-search `woocommerce admin custom settings page` for current patterns1718## Settings API1920### WC_Settings_API (For Gateways/Methods)2122Payment gateways and shipping methods use `WC_Settings_API`:23- Define fields in `init_form_fields()` as associative array24- Field types: `text`, `textarea`, `select`, `multiselect`, `checkbox`, `password`, `title`, `decimal`, `color`25- Rendered automatically via `$this->generate_settings_html()`26- Saved/loaded automatically via `get_option()` / `update_option()`2728### WC_Settings_Page (Custom Settings Tabs)2930Add a new tab to WooCommerce > Settings:311. Extend `WC_Settings_Page`322. Set `$this->id` and `$this->label`333. Implement `get_settings_for_default_section()` — return settings array344. Register via `woocommerce_get_settings_pages` filter3536### Settings Field Format3738Each field is an array with keys:39- `id` — option name (stored in `wp_options`)40- `title` — field label41- `type` — `text`, `select`, `checkbox`, `textarea`, `number`, `sectionend`, `title`42- `default` — default value43- `desc` — description text44- `options` — for select/multiselect45- `css` — inline CSS for the input4647## Admin Menus4849### Adding Sub-Menus Under WooCommerce5051`add_submenu_page( 'woocommerce', $page_title, $menu_title, $capability, $slug, $callback )`5253### Top-Level Menus5455`add_menu_page()` for standalone admin sections — less common for WC extensions.5657### Capability Checks5859- `manage_woocommerce` — WooCommerce admin capability60- `edit_shop_orders` — order management61- `edit_products` — product management62- Always check capabilities in menu and page callbacks6364## Product Data Panels6566### Adding Tabs6768Filter `woocommerce_product_data_tabs`:69```php70$tabs['my_tab'] = [71 'label' => __( 'My Tab', 'my-plugin' ),72 'target' => 'my_tab_data',73 'class' => [ 'show_if_simple', 'show_if_variable' ],74 'priority' => 60,75];76```7778### Adding Panel Content7980Action `woocommerce_product_data_panels`:81- Render HTML inside a `<div id="my_tab_data" class="panel">` matching the tab target82- Use `woocommerce_wp_text_input()`, `woocommerce_wp_select()`, etc.8384### Saving Panel Data8586Action `woocommerce_process_product_meta` — receives `$post_id`:87- Sanitize input: `sanitize_text_field( $_POST['my_field'] )`88- Save: `$product->update_meta_data( '_my_field', $value )` then `$product->save()`8990## Order Admin Customization9192### Meta Boxes9394Add custom meta boxes to the order edit screen:95- `add_meta_box( $id, $title, $callback, 'woocommerce_page_wc-orders', $context, $priority )`96- For HPOS: use screen ID `woocommerce_page_wc-orders` (not `shop_order`)97- For legacy: use post type `shop_order`9899### Order Actions100101Filter `woocommerce_order_actions` to add custom order actions.102103### Bulk Actions104105Filter `bulk_actions-edit-shop_order` (legacy) or `bulk_actions-woocommerce_page_wc-orders` (HPOS).106107## WooCommerce Admin (React-Based)108109### Analytics & Reports110111WooCommerce Admin is a React SPA for:112- Revenue, Orders, Products, Categories, Coupons, Taxes, Downloads reports113- Dashboard with customizable widgets114- Activity panel (orders, reviews, stock)115116### Extending Analytics117118Use `@woocommerce/data` and `@woocommerce/components` packages:119- Add custom report pages via `woocommerce_admin_reports_pages` filter (PHP)120- Register custom analytics data stores121- Extend existing reports with additional columns122123## Admin Notices124125### WooCommerce Admin Notices126127- `WC_Admin_Notices::add_custom_notice( $name, $html )` — persistent notices128- `wc_admin_notice()` helper for one-time notices129- `admin_notices` action for standard WordPress admin notices130131## Best Practices132133- Use WooCommerce Settings API for gateway/method settings134- Use `WC_Settings_Page` for custom settings tabs135- Always check capabilities (`manage_woocommerce`, `edit_products`, etc.)136- Use HPOS-compatible screen IDs for order meta boxes137- Sanitize all admin form input before saving138- Use nonces for all admin form submissions139- Localize admin strings with `__()` / `esc_html__()`140141Fetch the WooCommerce Settings API docs and WordPress admin handbook for exact field types, hook names, and screen IDs before implementing.