Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[WC Analytics] Add filters for custom orderby query params (#49722) 

* Add a filter `woocommerce_report_categories_orderby_params` for custom orderby query params

* Add a filter `woocommerce_report_coupons_orderby_params` for custom orderby query params

* Add a filter `woocommerce_report_coupons_stats_orderby_params` for custom orderby query params

* Add a filter `woocommerce_report_customers_orderby_params` for custom orderby query params

* Add a filter `woocommerce_report_downloads_orderby_params` for custom orderby query params

* Add a filter `woocommerce_report_downloads_stats_orderby_params` for custom orderby query params

* Add a filter `woocommerce_report_orders_orderby_params` for custom orderby query params

* Add a filter `woocommerce_report_orders_stats_orderby_params` for custom orderby query params

* Add a filter `woocommerce_report_products_orderby_params` for custom orderby query params

* Add a filter `woocommerce_report_products_stats_orderby_params` for custom orderby query params

* Add a filter `woocommerce_report_revenue_stats_orderby_params` for custom orderby query params

* Add a filter `woocommerce_report_stock_orderby_params` for custom orderby query params

* Add a filter `woocommerce_report_taxes_orderby_params` for custom orderby query params

* Add a filter `woocommerce_report_taxes_stats_orderby_params` for custom orderby query params

* Add a filter `woocommerce_report_variations_orderby_params` for custom orderby query params

* Add a filter `woocommerce_report_variations_stats_orderby_params` for custom orderby query params

* Add changelog

* Add a method `apply_custom_orderby_filters()` in analytics GenericController

* Use the shared method to in analytics GenericController to apply custom
orderby enum

* Fix typo, add more comments in analytics custom orderby filter PHPDoc

---------

Co-authored-by: Tomek Wytrębowicz <tomalecpub@gmail.com>
This commit is contained in:
Ian Yu-Hsun Lin 2024-09-06 12:13:03 +08:00 committed by GitHub
parent cb2549386a
commit 43ce3c1c4d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
18 changed files with 175 additions and 112 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
plugins/woocommerce/changelog/add-46275-custom-order-by-for-analytics-report Normal file
View File

@ -0,0 +1,4 @@
Significance: minor
Type: enhancement
Add filters for custom orderby query params for WC Analytics

16
plugins/woocommerce/src/Admin/API/Reports/Categories/Controller.php
View File

@ -171,13 +171,15 @@ class Controller extends GenericController implements ExportableInterface {
public function get_collection_params() {
$params = parent::get_collection_params();
$params['orderby']['default'] = 'category_id';
$params['orderby']['enum'] = array(
'category_id',
'items_sold',
'net_revenue',
'orders_count',
'products_count',
'category',
$params['orderby']['enum'] = $this->apply_custom_orderby_filters(
array(
'category_id',
'items_sold',
'net_revenue',
'orders_count',
'products_count',
'category',
)
);
$params['interval'] = array(
'description' => __( 'Time interval to use for buckets in the returned data.', 'woocommerce' ),

12
plugins/woocommerce/src/Admin/API/Reports/Coupons/Controller.php
View File

@ -184,11 +184,13 @@ class Controller extends GenericController implements ExportableInterface {
public function get_collection_params() {
$params = parent::get_collection_params();
$params['orderby']['default'] = 'coupon_id';
$params['orderby']['enum'] = array(
'coupon_id',
'code',
'amount',
'orders_count',
$params['orderby']['enum'] = $this->apply_custom_orderby_filters(
array(
'coupon_id',
'code',
'amount',
'orders_count',
)
);
$params['coupons'] = array(
'description' => __( 'Limit result set to coupons assigned specific coupon IDs.', 'woocommerce' ),

12
plugins/woocommerce/src/Admin/API/Reports/Coupons/Stats/Controller.php
View File

@ -142,11 +142,13 @@ class Controller extends GenericStatsController {
*/
public function get_collection_params() {
$params = parent::get_collection_params();
$params['orderby']['enum'] = array(
'date',
'amount',
'coupons_count',
'orders_count',
$params['orderby']['enum'] = $this->apply_custom_orderby_filters(
array(
'date',
'amount',
'coupons_count',
'orders_count',
)
);
$params['coupons'] = array(
'description' => __( 'Limit result set to coupons assigned specific coupon IDs.', 'woocommerce' ),

26
plugins/woocommerce/src/Admin/API/Reports/Customers/Controller.php
View File

@ -304,18 +304,20 @@ class Controller extends GenericController implements ExportableInterface {
'validate_callback' => 'rest_validate_request_arg',
);
$params['orderby']['default'] = 'date_registered';
$params['orderby']['enum'] = array(
'username',
'name',
'country',
'city',
'state',
'postcode',
'date_registered',
'date_last_active',
'orders_count',
'total_spend',
'avg_order_value',
$params['orderby']['enum'] = $this->apply_custom_orderby_filters(
array(
'username',
'name',
'country',
'city',
'state',
'postcode',
'date_registered',
'date_last_active',
'orders_count',
'total_spend',
'avg_order_value',
)
);
$params['match'] = array(
'description' => __( 'Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories', 'woocommerce' ),

8
plugins/woocommerce/src/Admin/API/Reports/Downloads/Controller.php
View File

@ -219,9 +219,11 @@ class Controller extends GenericController implements ExportableInterface {
*/
public function get_collection_params() {
$params = parent::get_collection_params();
$params['orderby']['enum'] = array(
'date',
'product',
$params['orderby']['enum'] = $this->apply_custom_orderby_filters(
array(
'date',
'product',
)
);
$params['match'] = array(
'description' => __( 'Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: products, orders, username, ip_address.', 'woocommerce' ),

8
plugins/woocommerce/src/Admin/API/Reports/Downloads/Stats/Controller.php
View File

@ -196,9 +196,11 @@ class Controller extends GenericStatsController {
*/
public function get_collection_params() {
$params = parent::get_collection_params();
$params['orderby']['enum'] = array(
'date',
'download_count',
$params['orderby']['enum'] = $this->apply_custom_orderby_filters(
array(
'date',
'download_count',
)
);
$params['match'] = array(
'description' => __( 'Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories', 'woocommerce' ),

27
plugins/woocommerce/src/Admin/API/Reports/GenericController.php
View File

@ -257,4 +257,31 @@ abstract class GenericController extends \WC_REST_Reports_Controller {
return $args;
}
/**
* Apply a filter for custom orderby enum.
*
* @param array $orderby_enum An array of orderby enum options.
*
* @return array An array of filtered orderby enum options.
*
* @since 9.4.0
*/
protected function apply_custom_orderby_filters( $orderby_enum ) {
/**
* Filter orderby query parameter enum.
*
* There was an initial concern about potential SQL injection with the custom orderby.
* However, testing shows it is safely blocked by validation in the controller,
* which results in an "Invalid parameter(s): orderby" error.
*
* Additionally, it's the responsibility of the merchant/developer to ensure the custom orderby is valid,
* or a WordPress database error will occur for unknown columns.
*
* @since 9.4.0
*
* @param array $orderby_enum The orderby query parameter enum.
*/
return apply_filters( "woocommerce_analytics_orderby_enum_{$this->rest_base}", $orderby_enum );
}
}

10
plugins/woocommerce/src/Admin/API/Reports/Orders/Controller.php
View File

@ -233,10 +233,12 @@ class Controller extends GenericController implements ExportableInterface {
public function get_collection_params() {
$params = parent::get_collection_params();
$params['per_page']['minimum'] = 0;
$params['orderby']['enum'] = array(
'date',
'num_items_sold',
'net_total',
$params['orderby']['enum'] = $this->apply_custom_orderby_filters(
array(
'date',
'num_items_sold',
'net_total',
)
);
$params['product_includes'] = array(
'description' => __( 'Limit result set to items that have the specified product(s) assigned.', 'woocommerce' ),

12
plugins/woocommerce/src/Admin/API/Reports/Orders/Stats/Controller.php
View File

@ -202,11 +202,13 @@ class Controller extends GenericStatsController {
*/
public function get_collection_params() {
$params = parent::get_collection_params();
$params['orderby']['enum'] = array(
'date',
'net_revenue',
'orders_count',
'avg_order_value',
$params['orderby']['enum'] = $this->apply_custom_orderby_filters(
array(
'date',
'net_revenue',
'orders_count',
'avg_order_value',
)
);
$params['match'] = array(
'description' => __( 'Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories', 'woocommerce' ),

18
plugins/woocommerce/src/Admin/API/Reports/Products/Controller.php
View File

@ -231,14 +231,16 @@ class Controller extends GenericController implements ExportableInterface {
*/
public function get_collection_params() {
$params = parent::get_collection_params();
$params['orderby']['enum'] = array(
'date',
'net_revenue',
'orders_count',
'items_sold',
'product_name',
'variations',
'sku',
$params['orderby']['enum'] = $this->apply_custom_orderby_filters(
array(
'date',
'net_revenue',
'orders_count',
'items_sold',
'product_name',
'variations',
'sku',
)
);
$params['categories'] = array(
'description' => __( 'Limit result to items from the specified categories.', 'woocommerce' ),

22
plugins/woocommerce/src/Admin/API/Reports/Products/Stats/Controller.php
View File

@ -197,16 +197,18 @@ class Controller extends GenericStatsController {
*/
public function get_collection_params() {
$params = parent::get_collection_params();
$params['orderby']['enum'] = array(
'date',
'net_revenue',
'coupons',
'refunds',
'shipping',
'taxes',
'net_revenue',
'orders_count',
'items_sold',
$params['orderby']['enum'] = $this->apply_custom_orderby_filters(
array(
'date',
'net_revenue',
'coupons',
'refunds',
'shipping',
'taxes',
'net_revenue',
'orders_count',
'items_sold',
)
);
$params['categories'] = array(
'description' => __( 'Limit result to items from the specified categories.', 'woocommerce' ),

24
plugins/woocommerce/src/Admin/API/Reports/Revenue/Stats/Controller.php
View File

@ -223,17 +223,19 @@ class Controller extends GenericStatsController implements ExportableInterface {
*/
public function get_collection_params() {
$params = parent::get_collection_params();
$params['orderby']['enum'] = array(
'date',
'total_sales',
'coupons',
'refunds',
'shipping',
'taxes',
'net_revenue',
'orders_count',
'items_sold',
'gross_sales',
$params['orderby']['enum'] = $this->apply_custom_orderby_filters(
array(
'date',
'total_sales',
'coupons',
'refunds',
'shipping',
'taxes',
'net_revenue',
'orders_count',
'items_sold',
'gross_sales',
)
);
$params['segmentby'] = array(
'description' => __( 'Segment the response by additional constraint.', 'woocommerce' ),

18
plugins/woocommerce/src/Admin/API/Reports/Stock/Controller.php
View File

@ -443,14 +443,16 @@ class Controller extends GenericController implements ExportableInterface {
);
$params['order']['default'] = 'asc';
$params['orderby']['default'] = 'stock_status';
$params['orderby']['enum'] = array(
'stock_status',
'stock_quantity',
'date',
'id',
'include',
'title',
'sku',
$params['orderby']['enum'] = $this->apply_custom_orderby_filters(
array(
'stock_status',
'stock_quantity',
'date',
'id',
'include',
'title',
'sku',
)
);
$params['parent'] = array(
'description' => __( 'Limit result set to those of particular parent IDs.', 'woocommerce' ),

20
plugins/woocommerce/src/Admin/API/Reports/Taxes/Controller.php
View File

@ -195,15 +195,17 @@ class Controller extends GenericController implements ExportableInterface {
public function get_collection_params() {
$params = parent::get_collection_params();
$params['orderby']['default'] = 'tax_rate_id';
$params['orderby']['enum'] = array(
'name',
'tax_rate_id',
'tax_code',
'rate',
'order_tax',
'total_tax',
'shipping_tax',
'orders_count',
$params['orderby']['enum'] = $this->apply_custom_orderby_filters(
array(
'name',
'tax_rate_id',
'tax_code',
'rate',
'order_tax',
'total_tax',
'shipping_tax',
'orders_count',
)
);
$params['taxes'] = array(
'description' => __( 'Limit result set to items assigned one or more tax rates.', 'woocommerce' ),

14
plugins/woocommerce/src/Admin/API/Reports/Taxes/Stats/Controller.php
View File

@ -186,12 +186,14 @@ class Controller extends GenericStatsController {
*/
public function get_collection_params() {
$params = parent::get_collection_params();
$params['orderby']['enum'] = array(
'date',
'items_sold',
'total_sales',
'orders_count',
'products_count',
$params['orderby']['enum'] = $this->apply_custom_orderby_filters(
array(
'date',
'items_sold',
'total_sales',
'orders_count',
'products_count',
)
);
$params['taxes'] = array(
'description' => __( 'Limit result set to all items that have the specified term assigned in the taxes taxonomy.', 'woocommerce' ),

14
plugins/woocommerce/src/Admin/API/Reports/Variations/Controller.php
View File

@ -246,12 +246,14 @@ class Controller extends GenericController implements ExportableInterface {
*/
public function get_collection_params() {
$params = parent::get_collection_params();
$params['orderby']['enum'] = array(
'date',
'net_revenue',
'orders_count',
'items_sold',
'sku',
$params['orderby']['enum'] = $this->apply_custom_orderby_filters(
array(
'date',
'net_revenue',
'orders_count',
'items_sold',
'sku',
)
);
$params['match'] = array(
'description' => __( 'Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories', 'woocommerce' ),

22
plugins/woocommerce/src/Admin/API/Reports/Variations/Stats/Controller.php
View File

@ -210,16 +210,18 @@ class Controller extends GenericStatsController {
),
'validate_callback' => 'rest_validate_request_arg',
);
$params['orderby']['enum'] = array(
'date',
'net_revenue',
'coupons',
'refunds',
'shipping',
'taxes',
'net_revenue',
'orders_count',
'items_sold',
$params['orderby']['enum'] = $this->apply_custom_orderby_filters(
array(
'date',
'net_revenue',
'coupons',
'refunds',
'shipping',
'taxes',
'net_revenue',
'orders_count',
'items_sold',
)
);
$params['category_includes'] = array(
'description' => __( 'Limit result to items from the specified categories.', 'woocommerce' ),