WooCommerce Code Reference

WC_Admin_Menus
in package

WC_Admin_Menus Class.

Table of Contents

__construct()  : mixed
Hook in tabs.
add_nav_menu_meta_boxes()  : mixed
Add custom nav meta box.
addons_menu()  : mixed
Addons menu item.
addons_page()  : mixed
Init the addons page.
admin_bar_menus()  : mixed
Add the "Visit Store" link in admin bar main menu.
admin_menu()  : mixed
Add menu items.
attributes_page()  : mixed
Init the attributes page.
custom_menu_order()  : bool
Custom menu order.
menu_highlight()  : mixed
Highlights the correct top level admin menu item for post type add screens.
menu_order()  : array<string|int, mixed>
Reorder the WC menu items in admin.
menu_order_count()  : mixed
Adds the order processing count to the menu.
nav_menu_links()  : mixed
Output menu links.
reports_menu()  : mixed
Add menu item.
reports_page()  : mixed
Init the reports page.
save_settings()  : void
Handle saving of settings.
set_screen_option()  : mixed
Validate screen options on update.
settings_menu()  : mixed
Add menu item.
settings_page()  : mixed
Init the settings page.
settings_page_init()  : mixed
Loads gateways and shipping methods into memory for use within settings.
status_menu()  : mixed
Add menu item.
status_page()  : mixed
Init the status page.
update_menu_highlight()  : string
Highlight the My Subscriptions menu item when on that page
update_my_subscriptions_title()  : string
Update the My Subscriptions document title when on that page.

Methods

add_nav_menu_meta_boxes()

Add custom nav meta box.

public add_nav_menu_meta_boxes() : mixed

Adapted from http://www.johnmorrisonline.com/how-to-add-a-fully-functional-custom-meta-box-to-wordpress-navigation-menus/.

Return values
mixed —

admin_bar_menus()

Add the "Visit Store" link in admin bar main menu.

public admin_bar_menus(WP_Admin_Bar $wp_admin_bar) : mixed
Parameters
$wp_admin_bar : WP_Admin_Bar

Admin bar instance.

Tags
since
2.4.0
Return values
mixed —

custom_menu_order()

Custom menu order.

public custom_menu_order(bool $enabled) : bool
Parameters
$enabled : bool

Whether custom menu ordering is already enabled.

Return values
bool —

menu_highlight()

Highlights the correct top level admin menu item for post type add screens.

public menu_highlight() : mixed
Return values
mixed —

menu_order()

Reorder the WC menu items in admin.

public menu_order(int $menu_order) : array<string|int, mixed>
Parameters
$menu_order : int

Menu order.

Return values
array<string|int, mixed> —

set_screen_option()

Validate screen options on update.

public set_screen_option(bool|int $status, string $option, int $value) : mixed
Parameters
$status : bool|int

Screen option value. Default false to skip.

$option : string

The option name.

$value : int

The number of rows to use.

Return values
mixed —

settings_page_init()

Loads gateways and shipping methods into memory for use within settings.

public settings_page_init() : mixed
Return values
mixed —

update_menu_highlight()

Highlight the My Subscriptions menu item when on that page

public update_menu_highlight(string $submenu_file, string $parent_file) : string
Parameters
$submenu_file : string

The submenu file.

$parent_file : string

currently opened page.

Return values
string —

update_my_subscriptions_title()

Update the My Subscriptions document title when on that page.

public update_my_subscriptions_title(string $admin_title) : string

We want to maintain existing page URL but add it as a separate page, which requires updating it manually.

Parameters
$admin_title : string

existing page title.

Return values
string —