2018-04-17 23:51:48 +00:00
< ? php
2018-05-11 17:07:53 +00:00
/**
* Returns true if we are on a JS powered admin page .
*/
2018-07-10 12:48:06 +00:00
function wc_admin_is_admin_page () {
2018-05-11 17:07:53 +00:00
global $hook_suffix ;
2018-07-10 12:48:06 +00:00
if ( in_array ( $hook_suffix , array ( 'woocommerce_page_wc-admin' ) ) ) {
2018-05-11 17:07:53 +00:00
return true ;
}
return false ;
}
2018-06-26 14:49:42 +00:00
/**
* Returns true if we are on a " classic " ( non JS app ) powered admin page .
* `wc_get_screen_ids` will also return IDs for extensions that have properly registered themselves .
*/
2018-07-10 12:48:06 +00:00
function wc_admin_is_embed_enabled_wc_page () {
$screen_id = wc_admin_get_current_screen_id ();
2018-06-26 14:49:42 +00:00
if ( ! $screen_id ) {
return false ;
}
2018-07-10 12:48:06 +00:00
$screens = wc_admin_get_embed_enabled_screen_ids ();
2018-06-26 14:49:42 +00:00
if ( in_array ( $screen_id , $screens ) ) {
return true ;
}
return false ;
}
2018-04-17 23:51:48 +00:00
/**
2018-08-20 21:24:17 +00:00
* Add a single page to a given parent top - level - item .
*
* @ param array $options {
* Array describing the menu item .
*
* @ type string $title Menu title
* @ type string $parent Parent path or menu ID
* @ type string $path Path for this page , full path in app context ; ex / analytics / report
* }
2018-04-17 23:51:48 +00:00
*/
2018-08-20 21:24:17 +00:00
function wc_admin_register_page ( $options ) {
$defaults = array (
'parent' => '/analytics' ,
);
$options = wp_parse_args ( $options , $defaults );
add_submenu_page (
'/' === $options [ 'parent' ][ 0 ] ? " wc-admin# { $options [ 'parent' ] } " : $options [ 'parent' ],
$options [ 'title' ],
$options [ 'title' ],
'manage_options' ,
" wc-admin# { $options [ 'path' ] } " ,
'wc_admin_page'
);
}
/**
* Register menu pages for the Dashboard and Analytics sections .
*/
function wc_admin_register_pages () {
2018-05-22 19:59:32 +00:00
global $menu , $submenu ;
add_submenu_page (
'woocommerce' ,
2018-07-10 12:48:06 +00:00
__ ( 'WooCommerce Dashboard' , 'wc-admin' ),
__ ( 'Dashboard' , 'wc-admin' ),
2018-04-17 23:51:48 +00:00
'manage_options' ,
2018-07-10 12:48:06 +00:00
'wc-admin' ,
'wc_admin_page'
2018-04-17 23:51:48 +00:00
);
2018-05-15 15:06:15 +00:00
add_menu_page (
2018-07-10 12:48:06 +00:00
__ ( 'WooCommerce Analytics' , 'wc-admin' ),
__ ( 'Analytics' , 'wc-admin' ),
2018-05-15 15:06:15 +00:00
'manage_options' ,
2018-07-10 12:48:06 +00:00
'wc-admin#/analytics' ,
'wc_admin_page' ,
2018-05-15 15:06:15 +00:00
'dashicons-chart-bar' ,
2018-08-20 21:24:17 +00:00
56 // After WooCommerce & Product menu items.
2018-07-12 01:43:33 +00:00
);
2018-10-22 16:20:14 +00:00
wc_admin_register_page (
array (
'title' => __ ( 'Revenue' , 'wc-admin' ),
'parent' => '/analytics' ,
'path' => '/analytics/revenue' ,
)
);
2018-08-20 21:24:17 +00:00
2018-10-22 16:20:14 +00:00
wc_admin_register_page (
array (
'title' => __ ( 'Products' , 'wc-admin' ),
'parent' => '/analytics' ,
'path' => '/analytics/products' ,
)
);
2018-08-20 21:24:17 +00:00
2018-10-22 16:20:14 +00:00
wc_admin_register_page (
array (
'title' => __ ( 'Orders' , 'wc-admin' ),
'parent' => '/analytics' ,
'path' => '/analytics/orders' ,
)
);
2018-09-17 02:26:34 +00:00
2018-10-22 16:20:14 +00:00
wc_admin_register_page (
array (
'title' => __ ( 'Coupons' , 'wc-admin' ),
'parent' => '/analytics' ,
'path' => '/analytics/coupons' ,
)
);
2018-09-24 15:36:35 +00:00
if ( defined ( 'WP_DEBUG' ) && WP_DEBUG && defined ( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
2018-10-22 16:20:14 +00:00
wc_admin_register_page (
array (
'title' => 'DevDocs' ,
'parent' => 'woocommerce' , // Exposed on the main menu for now.
'path' => '/devdocs' ,
)
);
2018-09-24 15:36:35 +00:00
}
2018-04-17 23:51:48 +00:00
}
2018-07-10 12:48:06 +00:00
add_action ( 'admin_menu' , 'wc_admin_register_pages' );
2018-04-17 23:51:48 +00:00
2018-05-22 19:59:32 +00:00
/**
* This method is temporary while this is a feature plugin . As a part of core ,
* we can integrate this better with wc - admin - menus .
*
* It makes dashboard the top level link for 'WooCommerce' and renames the first Analytics menu item .
*/
2018-07-10 12:48:06 +00:00
function wc_admin_link_structure () {
2018-05-22 19:59:32 +00:00
global $submenu ;
2018-08-20 21:24:17 +00:00
// User does not have capabilites to see the submenu.
2018-06-08 17:11:24 +00:00
if ( ! current_user_can ( 'manage_woocommerce' ) ) {
return ;
}
2018-05-22 19:59:32 +00:00
2018-07-10 12:48:06 +00:00
$wc_admin_key = null ;
2018-05-22 19:59:32 +00:00
foreach ( $submenu [ 'woocommerce' ] as $submenu_key => $submenu_item ) {
2018-07-10 12:48:06 +00:00
if ( 'wc-admin' === $submenu_item [ 2 ] ) {
$wc_admin_key = $submenu_key ;
2018-05-22 19:59:32 +00:00
break ;
}
}
2018-07-10 12:48:06 +00:00
if ( ! $wc_admin_key ) {
2018-05-22 19:59:32 +00:00
return ;
}
2018-08-20 21:24:17 +00:00
$menu = $submenu [ 'woocommerce' ][ $wc_admin_key ];
2018-05-22 19:59:32 +00:00
2018-08-20 21:24:17 +00:00
// Move menu item to top of array.
unset ( $submenu [ 'woocommerce' ][ $wc_admin_key ] );
2018-07-10 12:48:06 +00:00
array_unshift ( $submenu [ 'woocommerce' ], $menu );
2018-08-20 21:24:17 +00:00
// Rename "Analytics" to Overview (otherwise this reads Analytics > Analytics).
2018-07-10 12:48:06 +00:00
$submenu [ 'wc-admin#/analytics' ][ 0 ][ 0 ] = __ ( 'Overview' , 'wc-admin' );
2018-05-22 19:59:32 +00:00
}
2018-08-20 21:24:17 +00:00
// priority is 20 to run after https://github.com/woocommerce/woocommerce/blob/a55ae325306fc2179149ba9b97e66f32f84fdd9c/includes/admin/class-wc-admin-menus.php#L165.
2018-07-10 12:48:06 +00:00
add_action ( 'admin_head' , 'wc_admin_link_structure' , 20 );
2018-05-22 19:59:32 +00:00
2018-04-17 23:51:48 +00:00
/**
2018-07-10 12:48:06 +00:00
* Load the assets on the admin pages
2018-04-17 23:51:48 +00:00
*/
2018-08-20 21:24:17 +00:00
function wc_admin_enqueue_script () {
2018-07-10 12:48:06 +00:00
if ( ! wc_admin_is_admin_page () && ! wc_admin_is_embed_enabled_wc_page () ) {
2018-04-17 23:51:48 +00:00
return ;
}
2018-07-10 12:48:06 +00:00
wp_enqueue_script ( WC_ADMIN_APP );
wp_enqueue_style ( WC_ADMIN_APP );
2018-04-17 23:51:48 +00:00
}
2018-07-10 12:48:06 +00:00
add_action ( 'admin_enqueue_scripts' , 'wc_admin_enqueue_script' );
2018-04-17 23:51:48 +00:00
2018-07-10 12:48:06 +00:00
function wc_admin_admin_body_class ( $admin_body_class = '' ) {
2018-05-10 18:35:55 +00:00
global $hook_suffix ;
2018-07-10 12:48:06 +00:00
if ( ! wc_admin_is_admin_page () && ! wc_admin_is_embed_enabled_wc_page () ) {
2018-05-10 18:35:55 +00:00
return $admin_body_class ;
}
2018-10-22 16:20:14 +00:00
$classes = explode ( ' ' , trim ( $admin_body_class ) );
2018-05-10 18:35:55 +00:00
$classes [] = 'woocommerce-page' ;
2018-07-10 12:48:06 +00:00
if ( wc_admin_is_embed_enabled_wc_page () ) {
2018-06-26 14:49:42 +00:00
$classes [] = 'woocommerce-embed-page' ;
}
2018-05-10 18:35:55 +00:00
$admin_body_class = implode ( ' ' , array_unique ( $classes ) );
return " $admin_body_class " ;
}
2018-07-10 12:48:06 +00:00
add_filter ( 'admin_body_class' , 'wc_admin_admin_body_class' );
2018-05-10 18:35:55 +00:00
2018-07-10 12:48:06 +00:00
function wc_admin_admin_before_notices () {
if ( ! wc_admin_is_admin_page () && ! wc_admin_is_embed_enabled_wc_page () ) {
2018-05-11 17:07:53 +00:00
return ;
}
2018-06-26 14:49:42 +00:00
echo '<div class="woocommerce-layout__notice-list-hide" id="wp__notice-list">' ;
echo '<div class="wp-header-end" id="woocommerce-layout__notice-catcher"></div>' ; // https://github.com/WordPress/WordPress/blob/f6a37e7d39e2534d05b9e542045174498edfe536/wp-admin/js/common.js#L737
2018-05-11 17:07:53 +00:00
}
2018-07-10 12:48:06 +00:00
add_action ( 'admin_notices' , 'wc_admin_admin_before_notices' , 0 );
2018-05-11 17:07:53 +00:00
2018-07-10 12:48:06 +00:00
function wc_admin_admin_after_notices () {
if ( ! wc_admin_is_admin_page () && ! wc_admin_is_embed_enabled_wc_page () ) {
2018-05-11 17:07:53 +00:00
return ;
}
echo '</div>' ;
}
2018-07-10 12:48:06 +00:00
add_action ( 'admin_notices' , 'wc_admin_admin_after_notices' , PHP_INT_MAX );
2018-05-11 17:07:53 +00:00
2018-05-24 16:03:03 +00:00
// TODO Can we do some URL rewriting so we can figure out which page they are on server side?
2018-07-10 12:48:06 +00:00
function wc_admin_admin_title ( $admin_title ) {
if ( ! wc_admin_is_admin_page () && ! wc_admin_is_embed_enabled_wc_page () ) {
2018-05-24 16:03:03 +00:00
return $admin_title ;
}
2018-06-26 14:49:42 +00:00
2018-07-10 12:48:06 +00:00
if ( wc_admin_is_embed_enabled_wc_page () ) {
$sections = wc_admin_get_embed_breadcrumbs ();
2018-06-26 14:49:42 +00:00
$sections = is_array ( $sections ) ? $sections : array ( $sections );
$pieces = array ();
foreach ( $sections as $section ) {
2018-10-22 16:20:14 +00:00
$pieces [] = is_array ( $section ) ? $section [ 1 ] : $section ;
2018-06-26 14:49:42 +00:00
}
$pieces = array_reverse ( $pieces );
2018-10-22 16:20:14 +00:00
$title = implode ( ' ‹ ' , $pieces );
2018-06-26 14:49:42 +00:00
} else {
2018-07-10 12:48:06 +00:00
$title = __ ( 'Dashboard' , 'wc-admin' );
2018-06-26 14:49:42 +00:00
}
2018-07-10 12:48:06 +00:00
return sprintf ( __ ( '%1$s ‹ %2$s — WooCommerce' , 'wc-admin' ), $title , get_bloginfo ( 'name' ) );
2018-05-24 16:03:03 +00:00
}
2018-10-22 16:20:14 +00:00
add_filter ( 'admin_title' , 'wc_admin_admin_title' );
2018-05-24 16:03:03 +00:00
2018-04-17 23:51:48 +00:00
/**
* Set up a div for the app to render into .
*/
2018-10-22 16:20:14 +00:00
function wc_admin_page () {
2018-04-17 23:51:48 +00:00
?>
< div class = " wrap " >
< div id = " root " ></ div >
</ div >
2018-10-22 16:20:14 +00:00
< ? php
2018-04-17 23:51:48 +00:00
}
2018-06-26 14:49:42 +00:00
/**
* Set up a div for the header embed to render into .
* The initial contents here are meant as a place loader for when the PHP page initialy loads .
* TODO Icon Placeholders for the ActivityPanel , when we implement the new designs .
*/
function woocommerce_embed_page_header () {
2018-07-10 12:48:06 +00:00
if ( ! wc_admin_is_embed_enabled_wc_page () ) {
2018-06-26 14:49:42 +00:00
return ;
}
2018-07-10 12:48:06 +00:00
$sections = wc_admin_get_embed_breadcrumbs ();
2018-06-26 14:49:42 +00:00
$sections = is_array ( $sections ) ? $sections : array ( $sections );
$breadcrumbs = '' ;
foreach ( $sections as $section ) {
2018-10-22 16:20:14 +00:00
$piece = is_array ( $section ) ? '<a href="' . esc_url ( admin_url ( $section [ 0 ] ) ) . '">' . $section [ 1 ] . '</a>' : $section ;
2018-06-26 14:49:42 +00:00
$breadcrumbs .= '<span>' . $piece . '</span>' ;
}
?>
< div id = " woocommerce-embedded-root " >
2018-06-28 13:52:45 +00:00
< div class = " woocommerce-layout " >
2018-06-29 15:20:08 +00:00
< div class = " woocommerce-layout__header is-embed-loading " >
2018-06-28 13:52:45 +00:00
< h1 class = " woocommerce-layout__header-breadcrumbs " >
2018-07-10 12:48:06 +00:00
< span >< a href = " <?php echo esc_url( admin_url( 'admin.php?page=wc-admin#/' ) ); ?> " > WooCommerce </ a ></ span >
2018-07-13 19:19:54 +00:00
< ? php echo $breadcrumbs ; ?>
2018-06-26 14:49:42 +00:00
</ h1 >
</ div >
</ div >
2018-06-29 15:20:08 +00:00
< div class = " woocommerce-layout__primary is-embed-loading " id = " woocommerce-layout__primary " >
2018-06-26 14:49:42 +00:00
< div id = " woocommerce-layout__notice-list " class = " woocommerce-layout__notice-list " ></ div >
</ div >
</ div >
< ? php
}
add_action ( 'in_admin_header' , 'woocommerce_embed_page_header' );