wc_admin_get_core_pages_to_connect()
Returns core WC pages to connect to WC-Admin.
wc_admin_get_core_pages_to_connect(
)
: array
Admin
Packages
Interfaces, Classes and Traits
- WC_Admin_API_Keys_Table_List
- API Keys table list class.
- WC_Admin_API_Keys
- WC_Admin_API_Keys.
- WC_Admin_Menus
- WC_Admin_Menus Class.
- WC_Admin_Notices
- WC_Admin_Notices Class.
- WC_Admin_Webhooks_Table_List
- Webooks table list class.
- WC_Admin_Webhooks
- WC_Admin_Webhooks.
- WC_Admin_Notes_Customize_Store_With_Blocks
- WC_Admin_Notes_Customize_Store_With_Blocks.
- WC_Admin_Notes_Facebook_Marketing_Expert
- WC_Admin_Notes_Facebook_Marketing_Expert
- WC_Admin_Notes_Insight_First_Sale
- WC_Admin_Notes_Insight_First_Sale.
- WC_Admin_Notes_Set_Up_Additional_Payment_Types
- WC_Admin_Notes_Set_Up_Additional_Payment_Types
Table of Contents
| wc_admin_get_core_pages_to_connect() | Returns core WC pages to connect to WC-Admin. | |
|---|---|---|
| wc_admin_filter_core_page_breadcrumbs() | Filter breadcrumbs for core pages that aren't explicitly connected. | |
| wc_admin_connect_core_pages() | Render the WC-Admin header bar on all WooCommerce core pages. | |
| wc_admin_connect_page() | Connect an existing page to WooCommerce Admin. | |
| wc_admin_register_page() | Register JS-powered WooCommerce Admin Page. | |
| wc_admin_is_connected_page() | Is this page connected to WooCommerce Admin? Passthrough to PageController::is_connected_page(). | |
| wc_admin_is_registered_page() | Is this a WooCommerce Admin Page? Passthrough to PageController::is_registered_page(). | |
| wc_admin_get_breadcrumbs() | Get breadcrumbs for WooCommerce Admin Page navigation. | |
| wc_admin_update_0201_order_status_index() | Update order stats `status` index length. | |
| wc_admin_update_0201_db_version() | Update DB Version. | |
| wc_admin_update_0230_rename_gross_total() | Rename "gross_total" to "total_sales". | |
| wc_admin_update_0230_db_version() | Update DB Version. | |
| wc_admin_update_0251_remove_unsnooze_action() | Remove the note unsnoozing scheduled action. | |
| wc_admin_update_0251_db_version() | Update DB Version. | |
| wc_admin_update_110_remove_facebook_note() | Remove Facebook Extension note. | |
| wc_admin_update_110_db_version() | Update DB Version. | |
| wc_admin_update_130_remove_dismiss_action_from_tracking_opt_in_note() | Remove Dismiss action from tracking opt-in admin note. | |
| wc_admin_update_130_db_version() | Update DB Version. | |
| wc_admin_update_140_change_deactivate_plugin_note_type() | Change the deactivate plugin note type to 'info'. | |
| wc_admin_update_140_db_version() | Update DB Version. | |
| 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_check_build_files() | 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(
$breadcrumbs :
array
)
: array
Parameters
- $breadcrumbs : array
Breadcrumb pieces.
Return values
array —Filtered breadcrumb pieces.
wc_admin_connect_core_pages()
Render the WC-Admin header bar on all WooCommerce core pages.
wc_admin_connect_core_pages(
$is_connected :
bool
, $current_page :
bool
)
: bool
Parameters
- $is_connected : bool
Whether the current page is connected.
- $current_page : bool
The current page, if connected.
Return values
bool —Whether to connect the page.
wc_admin_connect_page()
Connect an existing page to WooCommerce Admin.
wc_admin_connect_page(
$options :
array
)
: mixed
Passthrough to PageController::connect_page().
Parameters
- $options : array
Options for PageController::connect_page().
Return values
mixedwc_admin_register_page()
Register JS-powered WooCommerce Admin Page.
wc_admin_register_page(
$options :
array
)
: mixed
Passthrough to PageController::register_page().
Parameters
- $options : array
Options for PageController::register_page().
Return values
mixedwc_admin_is_connected_page()
Is this page connected to WooCommerce Admin? Passthrough to PageController::is_connected_page().
wc_admin_is_connected_page(
)
: bool
Return values
bool —True if the page is connected to WooCommerce Admin.
wc_admin_is_registered_page()
Is this a WooCommerce Admin Page? Passthrough to PageController::is_registered_page().
wc_admin_is_registered_page(
)
: bool
Return values
bool —True if the page is a WooCommerce Admin page.
wc_admin_get_breadcrumbs()
Get breadcrumbs for WooCommerce Admin Page navigation.
wc_admin_get_breadcrumbs(
)
: array
Passthrough to PageController::get_breadcrumbs().
Return values
array —Navigation pieces (breadcrumbs).
wc_admin_update_0201_order_status_index()
Update order stats `status` index length.
wc_admin_update_0201_order_status_index(
)
: mixed
See: https://github.com/woocommerce/woocommerce-admin/issues/2969.
Return values
mixedwc_admin_update_0201_db_version()
Update DB Version.
wc_admin_update_0201_db_version(
)
: mixed
Return values
mixedwc_admin_update_0230_rename_gross_total()
Rename "gross_total" to "total_sales".
wc_admin_update_0230_rename_gross_total(
)
: mixed
See: https://github.com/woocommerce/woocommerce-admin/issues/3175
Return values
mixedwc_admin_update_0230_db_version()
Update DB Version.
wc_admin_update_0230_db_version(
)
: mixed
Return values
mixedwc_admin_update_0251_remove_unsnooze_action()
Remove the note unsnoozing scheduled action.
wc_admin_update_0251_remove_unsnooze_action(
)
: mixed
Return values
mixedwc_admin_update_0251_db_version()
Update DB Version.
wc_admin_update_0251_db_version(
)
: mixed
Return values
mixedwc_admin_update_110_remove_facebook_note()
Remove Facebook Extension note.
wc_admin_update_110_remove_facebook_note(
)
: mixed
Return values
mixedwc_admin_update_110_db_version()
Update DB Version.
wc_admin_update_110_db_version(
)
: mixed
Return values
mixedwc_admin_update_130_remove_dismiss_action_from_tracking_opt_in_note()
Remove Dismiss action from tracking opt-in admin note.
wc_admin_update_130_remove_dismiss_action_from_tracking_opt_in_note(
)
: mixed
Return values
mixedwc_admin_update_130_db_version()
Update DB Version.
wc_admin_update_130_db_version(
)
: mixed
Return values
mixedwc_admin_update_140_change_deactivate_plugin_note_type()
Change the deactivate plugin note type to 'info'.
wc_admin_update_140_change_deactivate_plugin_note_type(
)
: mixed
Return values
mixedwc_admin_update_140_db_version()
Update DB Version.
wc_admin_update_140_db_version(
)
: mixed
Return values
mixedwoocommerce_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.
Return values
bool —True means the current version is a development version.
woocommerce_admin_check_build_files()
Returns true if build file exists.
woocommerce_admin_check_build_files(
)
: bool