should_display_widget() ) {
// If on network admin, only load the widget that works in that context and skip the rest.
if ( is_multisite() && is_network_admin() ) {
add_action( 'wp_network_dashboard_setup', array( $this, 'register_network_order_widget' ) );
} else {
add_action( 'wp_dashboard_setup', array( $this, 'init' ) );
}
}
}
/**
* Init dashboard widgets.
*/
public function init() {
// Reviews Widget.
if ( current_user_can( 'publish_shop_orders' ) && post_type_supports( 'product', 'comments' ) ) {
wp_add_dashboard_widget( 'woocommerce_dashboard_recent_reviews', __( 'WooCommerce Recent Reviews', 'woocommerce' ), array( $this, 'recent_reviews' ) );
}
wp_add_dashboard_widget( 'woocommerce_dashboard_status', __( 'WooCommerce Status', 'woocommerce' ), array( $this, 'status_widget' ) );
// Network Order Widget.
if ( is_multisite() && is_main_site() ) {
$this->register_network_order_widget();
}
}
/**
* Register the network order dashboard widget.
*/
public function register_network_order_widget() {
wp_add_dashboard_widget( 'woocommerce_network_orders', __( 'WooCommerce Network Orders', 'woocommerce' ), array( $this, 'network_orders' ) );
}
/**
* Check to see if we should display the widget.
*
* @return bool
*/
private function should_display_widget() {
if ( ! WC()->is_wc_admin_active() ) {
return false;
}
$has_permission = current_user_can( 'view_woocommerce_reports' ) || current_user_can( 'manage_woocommerce' ) || current_user_can( 'publish_shop_orders' );
$task_completed_or_hidden = 'yes' === get_option( 'woocommerce_task_list_complete' ) || 'yes' === get_option( 'woocommerce_task_list_hidden' );
return $task_completed_or_hidden && $has_permission;
}
/**
* Get top seller from DB.
*
* @return object
*/
private function get_top_seller() {
global $wpdb;
$hpos_enabled = OrderUtil::custom_orders_table_usage_is_enabled();
$orders_table = OrderUtil::get_table_for_orders();
$orders_column_id = $hpos_enabled ? 'id' : 'ID';
$orders_column_type = $hpos_enabled ? 'type' : 'post_type';
$orders_column_status = $hpos_enabled ? 'status' : 'post_status';
$orders_column_date = $hpos_enabled ? 'date_created_gmt' : 'post_date_gmt';
$query = array();
$query['fields'] = "SELECT SUM( order_item_meta.meta_value ) as qty, order_item_meta_2.meta_value as product_id FROM {$orders_table} AS orders";
$query['join'] = "INNER JOIN {$wpdb->prefix}woocommerce_order_items AS order_items ON orders.{$orders_column_id} = order_id ";
$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 ";
$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 ";
$query['where'] = "WHERE orders.{$orders_column_type} IN ( '" . implode( "','", wc_get_order_types( 'order-count' ) ) . "' ) ";
/**
* Allows modifying the order statuses used in the top seller query inside the dashboard status widget.
*
* @since 2.2.0
*
* @param string[] $order_statuses Order statuses.
*/
$order_statuses = apply_filters( 'woocommerce_reports_order_statuses', array( OrderStatus::COMPLETED, OrderStatus::PROCESSING, OrderStatus::ON_HOLD ) );
$query['where'] .= "AND orders.{$orders_column_status} IN ( 'wc-" . implode( "','wc-", $order_statuses ) . "' ) ";
$query['where'] .= "AND order_item_meta.meta_key = '_qty' ";
$query['where'] .= "AND order_item_meta_2.meta_key = '_product_id' ";
$query['where'] .= "AND orders.{$orders_column_date} >= '" . gmdate( 'Y-m-01', current_time( 'timestamp' ) ) . "' "; // phpcs:ignore WordPress.DateTime.CurrentTimeTimestamp.Requested
$query['where'] .= "AND orders.{$orders_column_date} <= '" . gmdate( 'Y-m-d H:i:s', current_time( 'timestamp' ) ) . "' "; // phpcs:ignore WordPress.DateTime.CurrentTimeTimestamp.Requested
$query['groupby'] = 'GROUP BY product_id';
$query['orderby'] = 'ORDER BY qty DESC';
$query['limits'] = 'LIMIT 1';
/**
* Allows modification of the query to determine the top seller product in the dashboard status widget.
*
* @since 2.2.0
*
* @param array $query SQL query parts.
*/
$query = apply_filters( 'woocommerce_dashboard_status_widget_top_seller_query', $query );
$sql = implode( ' ', $query );
return $wpdb->get_row( $sql ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
}
/**
* Show status widget.
*/
public function status_widget() {
$suffix = Constants::is_true( 'SCRIPT_DEBUG' ) ? '' : '.min';
$version = Constants::get_constant( 'WC_VERSION' );
wp_enqueue_script( 'wc-status-widget', WC()->plugin_url() . '/assets/js/admin/wc-status-widget' . $suffix . '.js', array( 'jquery', 'flot' ), $version, true );
//phpcs:ignore
$is_wc_admin_disabled = apply_filters( 'woocommerce_admin_disabled', false ) || ! Features::is_enabled( 'analytics' );
$status_widget_reports = array(
'net_sales_link' => 'admin.php?page=wc-admin&path=%2Fanalytics%2Frevenue&chart=net_revenue&orderby=net_revenue&period=month&compare=previous_period',
'top_seller_link' => 'admin.php?page=wc-admin&filter=single_product&path=%2Fanalytics%2Fproducts&products=',
'lowstock_link' => 'admin.php?page=wc-admin&type=lowstock&path=%2Fanalytics%2Fstock',
'outofstock_link' => 'admin.php?page=wc-admin&type=outofstock&path=%2Fanalytics%2Fstock',
'report_data' => null,
'get_sales_sparkline' => array( $this, 'get_sales_sparkline' ),
);
if ( $is_wc_admin_disabled ) {
/**
* Filter to change the reports of the status widget on the Dashboard page.
*
* Please note that this filter is mainly for backward compatibility with the legacy reports.
* It's not recommended to use this filter to change the data of this widget.
*
* @since 9.5.0
*/
$status_widget_reports = apply_filters( 'woocommerce_dashboard_status_widget_reports', $status_widget_reports );
} else {
$status_widget_reports['report_data'] = $this->get_wc_admin_performance_data();
}
echo '
';
if ( current_user_can( 'view_woocommerce_reports' ) ) {
$report_data = $status_widget_reports['report_data'];
$get_sales_sparkline = $status_widget_reports['get_sales_sparkline'];
$net_sales_link = $status_widget_reports['net_sales_link'];
$top_seller_link = $status_widget_reports['top_seller_link'];
$days = max( 7, (int) gmdate( 'd', current_time( 'timestamp' ) ) ); // phpcs:ignore WordPress.DateTime.CurrentTimeTimestamp.Requested
$sparkline_allowed_html = array(
'span' => array(
'class' => array(),
'data-color' => array(),
'data-tip' => array(),
'data-barwidth' => array(),
'data-sparkline' => array(),
),
);
if ( $report_data && is_callable( $get_sales_sparkline ) ) {
$sparkline = call_user_func_array( $get_sales_sparkline, array( '', $days ) );
$sparkline = $this->sales_sparkline_markup( 'sales', $days, $sparkline['total'], $sparkline['data'] );
?>
-
' . wc_price( $report_data->net_sales ) . ''
); // phpcs:ignore WordPress.XSS.EscapeOutput.OutputNotEscaped
?>
get_top_seller();
if ( $top_seller && $top_seller->qty && is_callable( $get_sales_sparkline ) ) {
$sparkline = call_user_func_array( $get_sales_sparkline, array( $top_seller->product_id, $days, 'count' ) );
$sparkline = $this->sales_sparkline_markup( 'count', $days, $sparkline['total'], $sparkline['data'] );
?>
-
' . get_the_title( $top_seller->product_id ) . '',
$top_seller->qty
); // phpcs:ignore WordPress.XSS.EscapeOutput.OutputNotEscaped
?>
status_widget_order_rows();
if ( get_option( 'woocommerce_manage_stock' ) === 'yes' ) {
$this->status_widget_stock_rows( $status_widget_reports['lowstock_link'], $status_widget_reports['outofstock_link'] );
}
/**
* Filter to change the first argument passed to the `woocommerce_after_dashboard_status_widget` action.
*
* Please note that this filter is mainly for backward compatibility with the legacy reports.
* It's not recommended to use this filter as it will soon be deprecated along with the retiring of the legacy reports.
*
* @since 9.5.0
*/
$reports = apply_filters( 'woocommerce_after_dashboard_status_widget_parameter', null );
do_action( 'woocommerce_after_dashboard_status_widget', $reports );
echo '
';
}
/**
* Show order data is status widget.
*/
private function status_widget_order_rows() {
if ( ! current_user_can( 'edit_shop_orders' ) ) {
return;
}
$on_hold_count = 0;
$processing_count = 0;
foreach ( wc_get_order_types( 'order-count' ) as $type ) {
$counts = OrderUtil::get_count_for_type( $type );
$on_hold_count += $counts[ OrderInternalStatus::ON_HOLD ];
$processing_count += $counts[ OrderInternalStatus::PROCESSING ];
}
?>
%s order awaiting processing', '%s orders awaiting processing', $processing_count, 'woocommerce' ),
$processing_count
); // phpcs:ignore WordPress.XSS.EscapeOutput.OutputNotEscaped
?>
%s order on-hold', '%s orders on-hold', $on_hold_count, 'woocommerce' ),
$on_hold_count
); // phpcs:ignore WordPress.XSS.EscapeOutput.OutputNotEscaped
?>
get_var(
$wpdb->prepare(
"SELECT COUNT( product_id )
FROM {$wpdb->wc_product_meta_lookup} AS lookup
INNER JOIN {$wpdb->posts} as posts ON lookup.product_id = posts.ID
WHERE stock_quantity <= %d
AND stock_quantity > %d
AND posts.post_status = 'publish'",
$stock,
$nostock
)
);
}
set_transient( $transient_name, (int) $lowinstock_count, DAY_IN_SECONDS * 30 );
}
$transient_name = 'wc_outofstock_count';
$outofstock_count = get_transient( $transient_name );
$lowstock_url = $lowstock_link ? admin_url( $lowstock_link ) : '#';
$outofstock_url = $outofstock_link ? admin_url( $outofstock_link ) : '#';
if ( false === $outofstock_count ) {
/**
* Status widget out of stock count pre query.
*
* @since 4.3.0
* @param null|string $outofstock_count Out of stock count, by default null.
* @param int $nostock No stock amount
*/
$outofstock_count = apply_filters( 'woocommerce_status_widget_out_of_stock_count_pre_query', null, $nostock );
if ( is_null( $outofstock_count ) ) {
$outofstock_count = (int) $wpdb->get_var(
$wpdb->prepare(
"SELECT COUNT( product_id )
FROM {$wpdb->wc_product_meta_lookup} AS lookup
INNER JOIN {$wpdb->posts} as posts ON lookup.product_id = posts.ID
WHERE stock_quantity <= %d
AND posts.post_status = 'publish'",
$nostock
)
);
}
set_transient( $transient_name, (int) $outofstock_count, DAY_IN_SECONDS * 30 );
}
?>
%s product low in stock', '%s products low in stock', $lowinstock_count, 'woocommerce' ),
$lowinstock_count
); // phpcs:ignore WordPress.XSS.EscapeOutput.OutputNotEscaped
?>
%s product out of stock', '%s products out of stock', $outofstock_count, 'woocommerce' ),
$outofstock_count
); // phpcs:ignore WordPress.XSS.EscapeOutput.OutputNotEscaped
?>
comments} comments
LEFT JOIN {$wpdb->posts} posts ON (comments.comment_post_ID = posts.ID)
WHERE comments.comment_approved = '1'
AND comments.comment_type = 'review'
AND posts.post_password = ''
AND posts.post_type = 'product'
AND comments.comment_parent = 0
ORDER BY comments.comment_date_gmt DESC
LIMIT 5"
);
$comments = $wpdb->get_results(
"SELECT posts.ID, posts.post_title, comments.comment_author, comments.comment_author_email, comments.comment_ID, comments.comment_content {$query_from};" // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
);
if ( $comments ) {
echo '';
} else {
echo '' . esc_html__( 'There are no product reviews yet.', 'woocommerce' ) . '
';
}
}
/**
* Network orders widget.
*/
public function network_orders() {
$suffix = Constants::is_true( 'SCRIPT_DEBUG' ) ? '' : '.min';
$version = Constants::get_constant( 'WC_VERSION' );
wp_enqueue_style( 'wc-network-orders', WC()->plugin_url() . '/assets/css/network-order-widget.css', array(), $version );
wp_enqueue_script( 'wc-network-orders', WC()->plugin_url() . '/assets/js/admin/network-orders' . $suffix . '.js', array( 'jquery', 'underscore' ), $version, true );
$user = wp_get_current_user();
$blogs = get_blogs_of_user( $user->ID );
$blog_ids = wp_list_pluck( $blogs, 'userblog_id' );
wp_localize_script(
'wc-network-orders',
'woocommerce_network_orders',
array(
'nonce' => wp_create_nonce( 'wp_rest' ),
'sites' => array_values( $blog_ids ),
'order_endpoint' => get_rest_url( null, 'wc/v3/orders/network' ),
)
);
?>
set_query_params(
array(
'before' => $end_date,
'after' => $start_date,
'stats' => 'revenue/total_sales,revenue/net_revenue,orders/orders_count,products/items_sold,variations/items_sold',
)
);
$response = rest_do_request( $request );
if ( is_wp_error( $response ) ) {
return $response;
}
if ( 200 !== $response->get_status() ) {
return new \WP_Error( 'woocommerce_analytics_performance_indicators_result_failed', __( 'Sorry, fetching performance indicators failed.', 'woocommerce' ) );
}
$report_keys = array(
'net_revenue' => 'net_sales',
);
$performance_data = new stdClass();
foreach ( $response->get_data() as $indicator ) {
if ( isset( $indicator['chart'] ) && isset( $indicator['value'] ) ) {
$key = isset( $report_keys[ $indicator['chart'] ] ) ? $report_keys[ $indicator['chart'] ] : $indicator['chart'];
$performance_data->$key = $indicator['value'];
}
}
return $performance_data;
}
/**
* Prepares the data for a sparkline to show sales in the last X days.
*
* @param int $id ID of the product to show. Blank to get all orders.
* @param int $days Days of stats to get. Default to 7 days.
* @param string $type Type of sparkline to get. Ignored if ID is not set.
* @return array
*/
private function get_sales_sparkline( $id = '', $days = 7, $type = 'sales' ) {
$sales_endpoint = '/wc-analytics/reports/revenue/stats';
$start_date = gmdate( 'Y-m-d 00:00:00', current_time( 'timestamp' ) - ( ( $days - 1 ) * DAY_IN_SECONDS ) );
$end_date = gmdate( 'Y-m-d 23:59:59', current_time( 'timestamp' ) );
$meta_key = 'net_revenue';
$params = array(
'order' => 'asc',
'interval' => 'day',
'per_page' => 100,
'before' => $end_date,
'after' => $start_date,
);
if ( $id ) {
$sales_endpoint = '/wc-analytics/reports/products/stats';
$meta_key = ( 'sales' === $type ) ? 'net_revenue' : 'items_sold';
$params['products'] = $id;
}
$request = new \WP_REST_Request( 'GET', $sales_endpoint );
$params['fields'] = array( $meta_key );
$request->set_query_params( $params );
$response = rest_do_request( $request );
if ( is_wp_error( $response ) ) {
return $response;
}
$resp_data = $response->get_data();
$data = $resp_data['intervals'];
$sparkline_data = array();
$total = 0;
foreach ( $data as $d ) {
$total += $d['subtotals']->$meta_key;
array_push( $sparkline_data, array( strval( strtotime( $d['interval'] ) * 1000 ), $d['subtotals']->$meta_key ) );
}
return array(
'total' => $total,
'data' => $sparkline_data,
);
}
/**
* Prepares the markup for a sparkline to show sales in the last X days with the given data.
*
* @param string $type Type of sparkline to form the markup.
* @param int $days Days of stats to form the markup.
* @param int $total Total income or items sold to form the markup.
* @param array $sparkline_data Sparkline data to form the markup.
* @return string
*/
private function sales_sparkline_markup( $type, $days, $total, $sparkline_data ) {
if ( 'sales' === $type ) {
/* translators: 1: total income 2: days */
$tooltip = sprintf( __( 'Sold %1$s worth in the last %2$d days', 'woocommerce' ), strip_tags( wc_price( $total ) ), $days );
} else {
/* translators: 1: total items sold 2: days */
$tooltip = sprintf( _n( 'Sold %1$d item in the last %2$d days', 'Sold %1$d items in the last %2$d days', $total, 'woocommerce' ), $total, $days );
}
return '';
}
}
endif;
return new WC_Admin_Dashboard();