WC_Admin_Dashboard

WC_Admin_Dashboard Class.

Defined (1)

The class is defined in the following location(s).

/includes/admin/class-wc-admin-dashboard.php  
  1. class WC_Admin_Dashboard { 
  2.  
  3.     /** 
  4.      * Hook in tabs. 
  5.      */ 
  6.     public function __construct() { 
  7.         // Only hook in admin parts if the user has admin access 
  8.         if ( current_user_can( 'view_woocommerce_reports' ) || current_user_can( 'manage_woocommerce' ) || current_user_can( 'publish_shop_orders' ) ) { 
  9.             add_action( 'wp_dashboard_setup', array( $this, 'init' ) ); 
  10.         } 
  11.     } 
  12.  
  13.     /** 
  14.      * Init dashboard widgets. 
  15.      */ 
  16.     public function init() { 
  17.         if ( current_user_can( 'publish_shop_orders' ) ) { 
  18.             wp_add_dashboard_widget( 'woocommerce_dashboard_recent_reviews', __( 'WooCommerce recent reviews', 'woocommerce' ), array( $this, 'recent_reviews' ) ); 
  19.         } 
  20.         wp_add_dashboard_widget( 'woocommerce_dashboard_status', __( 'WooCommerce status', 'woocommerce' ), array( $this, 'status_widget' ) ); 
  21.     } 
  22.  
  23.     /** 
  24.      * Get top seller from DB. 
  25.      * @return object 
  26.      */ 
  27.     private function get_top_seller() { 
  28.         global $wpdb; 
  29.  
  30.         $query = array(); 
  31.         $query['fields'] = "SELECT SUM( order_item_meta.meta_value ) as qty, order_item_meta_2.meta_value as product_id 
  32.             FROM {$wpdb->posts} as posts"; 
  33.         $query['join'] = "INNER JOIN {$wpdb->prefix}woocommerce_order_items AS order_items ON posts.ID = order_id "; 
  34.         $query['join']   .= "INNER JOIN {$wpdb->prefix}woocommerce_order_itemmeta AS order_item_meta ON order_items.order_item_id = order_item_meta.order_item_id "; 
  35.         $query['join']   .= "INNER JOIN {$wpdb->prefix}woocommerce_order_itemmeta AS order_item_meta_2 ON order_items.order_item_id = order_item_meta_2.order_item_id "; 
  36.         $query['where'] = "WHERE posts.post_type IN ( '" . implode( "', '", wc_get_order_types( 'order-count' ) ) . "' ) "; 
  37.         $query['where']  .= "AND posts.post_status IN ( 'wc-" . implode( "', 'wc-", apply_filters( 'woocommerce_reports_order_statuses', array( 'completed', 'processing', 'on-hold' ) ) ) . "' ) "; 
  38.         $query['where']  .= "AND order_item_meta.meta_key = '_qty' "; 
  39.         $query['where']  .= "AND order_item_meta_2.meta_key = '_product_id' "; 
  40.         $query['where']  .= "AND posts.post_date >= '" . date( 'Y-m-01', current_time( 'timestamp' ) ) . "' "; 
  41.         $query['where']  .= "AND posts.post_date <= '" . date( 'Y-m-d H:i:s', current_time( 'timestamp' ) ) . "' "; 
  42.         $query['groupby'] = "GROUP BY product_id"; 
  43.         $query['orderby'] = "ORDER BY qty DESC"; 
  44.         $query['limits'] = "LIMIT 1"; 
  45.  
  46.         return $wpdb->get_row( implode( ' ', apply_filters( 'woocommerce_dashboard_status_widget_top_seller_query', $query ) ) ); 
  47.     } 
  48.  
  49.     /** 
  50.      * Get sales report data. 
  51.      * @return object 
  52.      */ 
  53.     private function get_sales_report_data() { 
  54.         include_once( dirname( __FILE__ ) . '/reports/class-wc-report-sales-by-date.php' ); 
  55.  
  56.         $sales_by_date = new WC_Report_Sales_By_Date(); 
  57.         $sales_by_date->start_date = strtotime( date( 'Y-m-01', current_time( 'timestamp' ) ) ); 
  58.         $sales_by_date->end_date = current_time( 'timestamp' ); 
  59.         $sales_by_date->chart_groupby = 'day'; 
  60.         $sales_by_date->group_by_query = 'YEAR(posts.post_date), MONTH(posts.post_date), DAY(posts.post_date)'; 
  61.  
  62.         return $sales_by_date->get_report_data(); 
  63.     } 
  64.  
  65.     /** 
  66.      * Show status widget. 
  67.      */ 
  68.     public function status_widget() { 
  69.         include_once( dirname( __FILE__ ) . '/reports/class-wc-admin-report.php' ); 
  70.  
  71.         $reports = new WC_Admin_Report(); 
  72.  
  73.         echo '<ul class="wc_status_list">'; 
  74.  
  75.         if ( current_user_can( 'view_woocommerce_reports' ) && ( $report_data = $this->get_sales_report_data() ) ) { 
  76.             ?> 
  77.             <li class="sales-this-month"> 
  78.                 <a href="<?php echo admin_url( 'admin.php?page=wc-reports&tab=orders&range=month' ); ?>"> 
  79.                     <?php echo $reports->sales_sparkline( '', max( 7, date( 'd', current_time( 'timestamp' ) ) ) ); ?> 
  80.                     <?php 
  81.                         /** translators: %s: net sales */ 
  82.                         printf( 
  83.                             __( '%s net sales this month', 'woocommerce' ),  
  84.                             '<strong>' . wc_price( $report_data->net_sales ) . '</strong>' 
  85.  ); 
  86.                     ?> 
  87.                 </a> 
  88.             </li> 
  89.             <?php 
  90.         } 
  91.  
  92.         if ( current_user_can( 'view_woocommerce_reports' ) && ( $top_seller = $this->get_top_seller() ) && $top_seller->qty ) { 
  93.             ?> 
  94.             <li class="best-seller-this-month"> 
  95.                 <a href="<?php echo admin_url( 'admin.php?page=wc-reports&tab=orders&report=sales_by_product&range=month&product_ids=' . $top_seller->product_id ); ?>"> 
  96.                     <?php echo $reports->sales_sparkline( $top_seller->product_id, max( 7, date( 'd', current_time( 'timestamp' ) ) ), 'count' ); ?> 
  97.                     <?php 
  98.                         /** translators: 1: top seller product title 2: top seller quantity */ 
  99.                         printf( 
  100.                             __( '%1$s top seller this month (sold %2$d)', 'woocommerce' ),  
  101.                             '<strong>' . get_the_title( $top_seller->product_id ) . '</strong>',  
  102.                             $top_seller->qty 
  103.  ); 
  104.                     ?> 
  105.                 </a> 
  106.             </li> 
  107.             <?php 
  108.         } 
  109.  
  110.         $this->status_widget_order_rows(); 
  111.         $this->status_widget_stock_rows(); 
  112.  
  113.         do_action( 'woocommerce_after_dashboard_status_widget', $reports ); 
  114.         echo '</ul>'; 
  115.     } 
  116.  
  117.     /** 
  118.      * Show order data is status widget. 
  119.      */ 
  120.     private function status_widget_order_rows() { 
  121.         if ( ! current_user_can( 'edit_shop_orders' ) ) { 
  122.             return; 
  123.         } 
  124.         $on_hold_count = 0; 
  125.         $processing_count = 0; 
  126.  
  127.         foreach ( wc_get_order_types( 'order-count' ) as $type ) { 
  128.             $counts = (array) wp_count_posts( $type ); 
  129.             $on_hold_count    += isset( $counts['wc-on-hold'] ) ? $counts['wc-on-hold'] : 0; 
  130.             $processing_count += isset( $counts['wc-processing'] ) ? $counts['wc-processing'] : 0; 
  131.         } 
  132.         ?> 
  133.         <li class="processing-orders"> 
  134.             <a href="<?php echo admin_url( 'edit.php?post_status=wc-processing&post_type=shop_order' ); ?>"> 
  135.                 <?php 
  136.                     /** translators: %s: order count */ 
  137.                     printf( 
  138.                         _n( '<strong>%s order</strong> awaiting processing', '<strong>%s orders</strong> awaiting processing', $processing_count, 'woocommerce' ),  
  139.                         $processing_count 
  140.  ); 
  141.                 ?> 
  142.             </a> 
  143.         </li> 
  144.         <li class="on-hold-orders"> 
  145.             <a href="<?php echo admin_url( 'edit.php?post_status=wc-on-hold&post_type=shop_order' ); ?>"> 
  146.                 <?php 
  147.                     /** translators: %s: order count */ 
  148.                     printf( 
  149.                         _n( '<strong>%s order</strong> on-hold', '<strong>%s orders</strong> on-hold', $on_hold_count, 'woocommerce' ),  
  150.                         $on_hold_count 
  151.  ); 
  152.                 ?> 
  153.             </a> 
  154.         </li> 
  155.         <?php 
  156.     } 
  157.  
  158.     /** 
  159.      * Show stock data is status widget. 
  160.      */ 
  161.     private function status_widget_stock_rows() { 
  162.         global $wpdb; 
  163.  
  164.         // Get products using a query - this is too advanced for get_posts :( 
  165.         $stock = absint( max( get_option( 'woocommerce_notify_low_stock_amount' ), 1 ) ); 
  166.         $nostock = absint( max( get_option( 'woocommerce_notify_no_stock_amount' ), 0 ) ); 
  167.         $transient_name = 'wc_low_stock_count'; 
  168.  
  169.         if ( false === ( $lowinstock_count = get_transient( $transient_name ) ) ) { 
  170.             $query_from = apply_filters( 'woocommerce_report_low_in_stock_query_from', "FROM {$wpdb->posts} as posts 
  171.                 INNER JOIN {$wpdb->postmeta} AS postmeta ON posts.ID = postmeta.post_id 
  172.                 INNER JOIN {$wpdb->postmeta} AS postmeta2 ON posts.ID = postmeta2.post_id 
  173.                 WHERE 1=1 
  174.                 AND posts.post_type IN ( 'product', 'product_variation' ) 
  175.                 AND posts.post_status = 'publish' 
  176.                 AND postmeta2.meta_key = '_manage_stock' AND postmeta2.meta_value = 'yes' 
  177.                 AND postmeta.meta_key = '_stock' AND CAST(postmeta.meta_value AS SIGNED) <= '{$stock}' 
  178.                 AND postmeta.meta_key = '_stock' AND CAST(postmeta.meta_value AS SIGNED) > '{$nostock}' 
  179.             " ); 
  180.             $lowinstock_count = absint( $wpdb->get_var( "SELECT COUNT( DISTINCT posts.ID ) {$query_from};" ) ); 
  181.             set_transient( $transient_name, $lowinstock_count, DAY_IN_SECONDS * 30 ); 
  182.         } 
  183.  
  184.         $transient_name = 'wc_outofstock_count'; 
  185.  
  186.         if ( false === ( $outofstock_count = get_transient( $transient_name ) ) ) { 
  187.             $query_from = apply_filters( 'woocommerce_report_out_of_stock_query_from', "FROM {$wpdb->posts} as posts 
  188.                 INNER JOIN {$wpdb->postmeta} AS postmeta ON posts.ID = postmeta.post_id 
  189.                 INNER JOIN {$wpdb->postmeta} AS postmeta2 ON posts.ID = postmeta2.post_id 
  190.                 WHERE 1=1 
  191.                 AND posts.post_type IN ( 'product', 'product_variation' ) 
  192.                 AND posts.post_status = 'publish' 
  193.                 AND postmeta2.meta_key = '_manage_stock' AND postmeta2.meta_value = 'yes' 
  194.                 AND postmeta.meta_key = '_stock' AND CAST(postmeta.meta_value AS SIGNED) <= '{$nostock}' 
  195.             " ); 
  196.             $outofstock_count = absint( $wpdb->get_var( "SELECT COUNT( DISTINCT posts.ID ) {$query_from};" ) ); 
  197.             set_transient( $transient_name, $outofstock_count, DAY_IN_SECONDS * 30 ); 
  198.         } 
  199.         ?> 
  200.         <li class="low-in-stock"> 
  201.             <a href="<?php echo admin_url( 'admin.php?page=wc-reports&tab=stock&report=low_in_stock' ); ?>"> 
  202.                 <?php 
  203.                     /** translators: %s: order count */ 
  204.                     printf( 
  205.                         _n( '<strong>%s product</strong> low in stock', '<strong>%s products</strong> low in stock', $lowinstock_count, 'woocommerce' ),  
  206.                         $lowinstock_count 
  207.  ); 
  208.                 ?> 
  209.             </a> 
  210.         </li> 
  211.         <li class="out-of-stock"> 
  212.             <a href="<?php echo admin_url( 'admin.php?page=wc-reports&tab=stock&report=out_of_stock' ); ?>"> 
  213.                 <?php 
  214.                     /** translators: %s: order count */ 
  215.                     printf( 
  216.                         _n( '<strong>%s product</strong> out of stock', '<strong>%s products</strong> out of stock', $outofstock_count, 'woocommerce' ),  
  217.                         $outofstock_count 
  218.  ); 
  219.                 ?> 
  220.             </a> 
  221.         </li> 
  222.         <?php 
  223.     } 
  224.  
  225.     /** 
  226.      * Recent reviews widget. 
  227.      */ 
  228.     public function recent_reviews() { 
  229.         global $wpdb; 
  230.         $comments = $wpdb->get_results( " 
  231.             SELECT posts.ID, posts.post_title, comments.comment_author, comments.comment_ID, SUBSTRING(comments.comment_content, 1, 100) AS comment_excerpt 
  232.             FROM $wpdb->comments comments 
  233.             LEFT JOIN $wpdb->posts posts ON (comments.comment_post_ID = posts.ID) 
  234.             WHERE comments.comment_approved = '1' 
  235.             AND comments.comment_type = '' 
  236.             AND posts.post_password = '' 
  237.             AND posts.post_type = 'product' 
  238.             ORDER BY comments.comment_date_gmt DESC 
  239.             LIMIT 5 
  240.         " ); 
  241.  
  242.         if ( $comments ) { 
  243.             echo '<ul>'; 
  244.             foreach ( $comments as $comment ) { 
  245.  
  246.                 echo '<li>'; 
  247.  
  248.                 echo get_avatar( $comment->comment_author, '32' ); 
  249.  
  250.                 $rating = intval( get_comment_meta( $comment->comment_ID, 'rating', true ) ); 
  251.  
  252.                 /** translators: %s: rating */ 
  253.                 echo '<div class="star-rating"><span style="width:' . ( $rating * 20 ) . '%">' . sprintf( __( '%s out of 5', 'woocommerce' ), $rating ) . '</span></div>'; 
  254.  
  255.                 /** translators: %s: review author */ 
  256.                 echo '<h4 class="meta"><a href="' . get_permalink( $comment->ID ) . '#comment-' . absint( $comment->comment_ID ) . '">' . esc_html( apply_filters( 'woocommerce_admin_dashboard_recent_reviews', $comment->post_title, $comment ) ) . '</a> ' . sprintf( __( 'reviewed by %s', 'woocommerce' ), esc_html( $comment->comment_author ) ) . '</h4>'; 
  257.                 echo '<blockquote>' . wp_kses_data( $comment->comment_excerpt ) . ' [...]</blockquote></li>'; 
  258.  
  259.             } 
  260.             echo '</ul>'; 
  261.         } else { 
  262.             echo '<p>' . __( 'There are no product reviews yet.', 'woocommerce' ) . '</p>'; 
  263.         } 
  264.     } 
  265. }