WordPress at Your Fingertips
function is not described

WC_API_Reports::get_sales_report() public WC 2.1

Get the sales report

{} It's a method of the class: WC_API_Reports{}

Hooks from the method
Return

Array|WP_Error.

Usage

$WC_API_Reports = new WC_API_Reports();
$WC_API_Reports->get_sales_report( $fields, $filter );
$fields(string)
fields to include in response
Default: null
$filter(array)
date filtering
Default: array()

Changelog

Since 2.1 Introduced.

Code of WC_API_Reports::get_sales_report() WC 5.7.1

public function get_sales_report( $fields = null, $filter = array() ) {

	// check user permissions
	$check = $this->validate_request();

	if ( is_wp_error( $check ) ) {
		return $check;
	}

	// set date filtering
	$this->setup_report( $filter );

	// total sales, taxes, shipping, and order count
	$totals = $this->report->get_order_report_data( array(
		'data' => array(
			'_order_total' => array(
				'type'     => 'meta',
				'function' => 'SUM',
				'name'     => 'sales',
			),
			'_order_tax' => array(
				'type'            => 'meta',
				'function'        => 'SUM',
				'name'            => 'tax',
			),
			'_order_shipping_tax' => array(
				'type'            => 'meta',
				'function'        => 'SUM',
				'name'            => 'shipping_tax',
			),
			'_order_shipping' => array(
				'type'     => 'meta',
				'function' => 'SUM',
				'name'     => 'shipping',
			),
			'ID' => array(
				'type'     => 'post_data',
				'function' => 'COUNT',
				'name'     => 'order_count',
			),
		),
		'filter_range' => true,
	) );

	// total items ordered
	$total_items = absint( $this->report->get_order_report_data( array(
		'data' => array(
			'_qty' => array(
				'type'            => 'order_item_meta',
				'order_item_type' => 'line_item',
				'function'        => 'SUM',
				'name'            => 'order_item_qty',
			),
		),
		'query_type' => 'get_var',
		'filter_range' => true,
	) ) );

	// total discount used
	$total_discount = $this->report->get_order_report_data( array(
		'data' => array(
			'discount_amount' => array(
				'type'            => 'order_item_meta',
				'order_item_type' => 'coupon',
				'function'        => 'SUM',
				'name'            => 'discount_amount',
			),
		),
		'where' => array(
			array(
				'key'      => 'order_item_type',
				'value'    => 'coupon',
				'operator' => '=',
			),
		),
		'query_type' => 'get_var',
		'filter_range' => true,
	) );

	// new customers
	$users_query = new WP_User_Query(
		array(
			'fields'  => array( 'user_registered' ),
			'role'    => 'customer',
		)
	);

	$customers = $users_query->get_results();

	foreach ( $customers as $key => $customer ) {
		if ( strtotime( $customer->user_registered ) < $this->report->start_date || strtotime( $customer->user_registered ) > $this->report->end_date ) {
			unset( $customers[ $key ] );
		}
	}

	$total_customers = count( $customers );

	// get order totals grouped by period
	$orders = $this->report->get_order_report_data( array(
		'data' => array(
			'_order_total' => array(
				'type'     => 'meta',
				'function' => 'SUM',
				'name'     => 'total_sales',
			),
			'_order_shipping' => array(
				'type'     => 'meta',
				'function' => 'SUM',
				'name'     => 'total_shipping',
			),
			'_order_tax' => array(
				'type'     => 'meta',
				'function' => 'SUM',
				'name'     => 'total_tax',
			),
			'_order_shipping_tax' => array(
				'type'     => 'meta',
				'function' => 'SUM',
				'name'     => 'total_shipping_tax',
			),
			'ID' => array(
				'type'     => 'post_data',
				'function' => 'COUNT',
				'name'     => 'total_orders',
				'distinct' => true,
			),
			'post_date' => array(
				'type'     => 'post_data',
				'function' => '',
				'name'     => 'post_date',
			),
		),
		'group_by'     => $this->report->group_by_query,
		'order_by'     => 'post_date ASC',
		'query_type'   => 'get_results',
		'filter_range' => true,
	) );

	// get order item totals grouped by period
	$order_items = $this->report->get_order_report_data( array(
		'data' => array(
			'_qty' => array(
				'type'            => 'order_item_meta',
				'order_item_type' => 'line_item',
				'function'        => 'SUM',
				'name'            => 'order_item_count',
			),
			'post_date' => array(
				'type'     => 'post_data',
				'function' => '',
				'name'     => 'post_date',
			),
		),
		'where' => array(
			array(
				'key'      => 'order_item_type',
				'value'    => 'line_item',
				'operator' => '=',
			),
		),
		'group_by'     => $this->report->group_by_query,
		'order_by'     => 'post_date ASC',
		'query_type'   => 'get_results',
		'filter_range' => true,
	) );

	// get discount totals grouped by period
	$discounts = $this->report->get_order_report_data( array(
		'data' => array(
			'discount_amount' => array(
				'type'            => 'order_item_meta',
				'order_item_type' => 'coupon',
				'function'        => 'SUM',
				'name'            => 'discount_amount',
			),
			'post_date' => array(
				'type'     => 'post_data',
				'function' => '',
				'name'     => 'post_date',
			),
		),
		'where' => array(
			array(
				'key'      => 'order_item_type',
				'value'    => 'coupon',
				'operator' => '=',
			),
		),
		'group_by'     => $this->report->group_by_query . ', order_item_name',
		'order_by'     => 'post_date ASC',
		'query_type'   => 'get_results',
		'filter_range' => true,
	) );

	$period_totals = array();

	// setup period totals by ensuring each period in the interval has data
	for ( $i = 0; $i <= $this->report->chart_interval; $i ++ ) {

		switch ( $this->report->chart_groupby ) {
			case 'day' :
				$time = date( 'Y-m-d', strtotime( "+{$i} DAY", $this->report->start_date ) );
				break;
			case 'month' :
				$time = date( 'Y-m', strtotime( "+{$i} MONTH", $this->report->start_date ) );
				break;
		}

		// set the customer signups for each period
		$customer_count = 0;
		foreach ( $customers as $customer ) {

			if ( date( ( 'day' == $this->report->chart_groupby ) ? 'Y-m-d' : 'Y-m', strtotime( $customer->user_registered ) ) == $time ) {
				$customer_count++;
			}
 			}

		$period_totals[ $time ] = array(
			'sales'     => wc_format_decimal( 0.00, 2 ),
			'orders'    => 0,
			'items'     => 0,
			'tax'       => wc_format_decimal( 0.00, 2 ),
			'shipping'  => wc_format_decimal( 0.00, 2 ),
			'discount'  => wc_format_decimal( 0.00, 2 ),
			'customers' => $customer_count,
		);
	}

	// add total sales, total order count, total tax and total shipping for each period
	foreach ( $orders as $order ) {

		$time = ( 'day' === $this->report->chart_groupby ) ? date( 'Y-m-d', strtotime( $order->post_date ) ) : date( 'Y-m', strtotime( $order->post_date ) );

		if ( ! isset( $period_totals[ $time ] ) ) {
			continue;
		}

		$period_totals[ $time ]['sales']    = wc_format_decimal( $order->total_sales, 2 );
		$period_totals[ $time ]['orders']   = (int) $order->total_orders;
		$period_totals[ $time ]['tax']      = wc_format_decimal( $order->total_tax + $order->total_shipping_tax, 2 );
		$period_totals[ $time ]['shipping'] = wc_format_decimal( $order->total_shipping, 2 );
	}

	// add total order items for each period
	foreach ( $order_items as $order_item ) {

		$time = ( 'day' === $this->report->chart_groupby ) ? date( 'Y-m-d', strtotime( $order_item->post_date ) ) : date( 'Y-m', strtotime( $order_item->post_date ) );

		if ( ! isset( $period_totals[ $time ] ) ) {
			continue;
		}

		$period_totals[ $time ]['items'] = (int) $order_item->order_item_count;
	}

	// add total discount for each period
	foreach ( $discounts as $discount ) {

		$time = ( 'day' === $this->report->chart_groupby ) ? date( 'Y-m-d', strtotime( $discount->post_date ) ) : date( 'Y-m', strtotime( $discount->post_date ) );

		if ( ! isset( $period_totals[ $time ] ) ) {
			continue;
		}

		$period_totals[ $time ]['discount'] = wc_format_decimal( $discount->discount_amount, 2 );
	}

	$sales_data = array(
		'total_sales'       => wc_format_decimal( $totals->sales, 2 ),
		'average_sales'     => wc_format_decimal( $totals->sales / ( $this->report->chart_interval + 1 ), 2 ),
		'total_orders'      => (int) $totals->order_count,
		'total_items'       => $total_items,
		'total_tax'         => wc_format_decimal( $totals->tax + $totals->shipping_tax, 2 ),
		'total_shipping'    => wc_format_decimal( $totals->shipping, 2 ),
		'total_discount'    => is_null( $total_discount ) ? wc_format_decimal( 0.00, 2 ) : wc_format_decimal( $total_discount, 2 ),
		'totals_grouped_by' => $this->report->chart_groupby,
		'totals'            => $period_totals,
		'total_customers'   => $total_customers,
	);

	return array( 'sales' => apply_filters( 'woocommerce_api_report_response', $sales_data, $this->report, $fields, $this->server ) );
}