WC_Admin_Menus
in package
WC_Admin_Menus Class.
Table of Contents
- HIDE_CSS_CLASS = 'hide-if-js'
- The CSS classes used to hide the submenu items in navigation.
- __construct() : mixed
- Hook in tabs.
- add_nav_menu_meta_boxes() : mixed
- Add custom nav meta box.
- addons_menu() : mixed
- Addons menu item.
- addons_my_subscriptions() : void
- Registers the wc-addons page within the WooCommerce menu.
- 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.
- can_view_woocommerce_menu_item() : mixed
- Check if the user can access the top-level WooCommerce item.
- custom_menu_order() : bool
- Custom menu order.
- hide_submenu_element() : mixed
- Apply the hide-if-js CSS class to a submenu item.
- hide_submenu_page() : false|array<string|int, mixed>
- Hide the submenu page based on slug and return the item that was hidden.
- maybe_add_new_product_management_experience() : mixed
- Maybe add new management product experience.
- 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.
- orders_menu() : void
- Link to the order admin list table from the main WooCommerce menu.
- 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.
Constants
HIDE_CSS_CLASS
The CSS classes used to hide the submenu items in navigation.
public
string
HIDE_CSS_CLASS
= 'hide-if-js'
Methods
__construct()
Hook in tabs.
public
__construct() : mixed
Return values
mixed —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 —addons_menu()
Addons menu item.
public
addons_menu() : mixed
Return values
mixed —addons_my_subscriptions()
Registers the wc-addons page within the WooCommerce menu.
public
addons_my_subscriptions() : void
Temporary measure till we convert the whole page to React.
Return values
void —addons_page()
Init the addons page.
public
addons_page() : mixed
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
Return values
mixed —admin_menu()
Add menu items.
public
admin_menu() : mixed
Return values
mixed —attributes_page()
Init the attributes page.
public
attributes_page() : mixed
Return values
mixed —can_view_woocommerce_menu_item()
Check if the user can access the top-level WooCommerce item.
public
static can_view_woocommerce_menu_item() : mixed
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 —hide_submenu_element()
Apply the hide-if-js CSS class to a submenu item.
public
hide_submenu_element(int $index, string $parent_slug, array<string|int, mixed> $item) : mixed
Borrowed from Jetpack's Base_Admin_Menu class.
Parameters
- $index : int
-
The position of a submenu item in the submenu array.
- $parent_slug : string
-
The parent slug.
- $item : array<string|int, mixed>
-
The submenu item.
Return values
mixed —hide_submenu_page()
Hide the submenu page based on slug and return the item that was hidden.
public
hide_submenu_page(string $menu_slug, string $submenu_slug) : false|array<string|int, mixed>
Borrowed from Jetpack's Base_Admin_Menu class.
Instead of actually removing the submenu item, a safer approach is to hide it and filter it in the API response. In this manner we'll avoid breaking third-party plugins depending on items that no longer exist.
A false|array value is returned to be consistent with remove_submenu_page() function
Parameters
- $menu_slug : string
-
The parent menu slug.
- $submenu_slug : string
-
The submenu slug that should be hidden.
Return values
false|array<string|int, mixed> —maybe_add_new_product_management_experience()
Maybe add new management product experience.
public
maybe_add_new_product_management_experience() : mixed
Return values
mixed —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> —menu_order_count()
Adds the order processing count to the menu.
public
menu_order_count() : mixed
Return values
mixed —nav_menu_links()
Output menu links.
public
nav_menu_links() : mixed
Return values
mixed —orders_menu()
Link to the order admin list table from the main WooCommerce menu.
public
orders_menu() : void
Return values
void —reports_menu()
Add menu item.
public
reports_menu() : mixed
Return values
mixed —reports_page()
Init the reports page.
public
reports_page() : mixed
Return values
mixed —save_settings()
Handle saving of settings.
public
save_settings() : void
Return values
void —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_menu()
Add menu item.
public
settings_menu() : mixed
Return values
mixed —settings_page()
Init the settings page.
public
settings_page() : mixed
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 —status_menu()
Add menu item.
public
status_menu() : mixed
Return values
mixed —status_page()
Init the status page.
public
status_page() : mixed