7cdbbf87e8
* Update all wc-admin endpoints to v4 * Add namespace for products and customers controllers * Include product quantity in orders data store * Add coupons to extended data in the orders data store * Format order statuses response from database * Hook up orders table to orders endpoint * Add namespace to data endpoint controller * Add namespaces to remaining extended controllers * Use NAMESPACE var in place of wc/v4 * Update product links in orders table to products reports * Add coupons rest controller override * Format coupon code in response Co-Authored-By: joshuatf <joshuatf@gmail.com> |
||
---|---|---|
.. | ||
categories | ||
coupons | ||
customers | ||
downloads | ||
orders | ||
products | ||
revenue | ||
stock | ||
taxes | ||
README.md | ||
index.js | ||
style.scss |
README.md
Reports
The core reports offered by WooCommerce live in this folder. The Header is added automatically by the parent Report component, each individual component should contain just the report contents.
Extending Reports
New reports can be added by third-parties without altering wc-admin
, by hooking into the reports filter, woocommerce-reports-list
. For example:
addFilter( 'woocommerce-reports-list', 'wc-example/my-report', pages => {
return [
...pages,
{
report: 'example',
title: 'My Example Extension',
component: Report,
},
];
} );
Each report is defined by an object containing report
, title
, component
.
report
(string): The path used to show the report, ex:/analytics/example
title
(string): The title shown in the breadcrumbs & document title.component
(react component): The component containing the report content- everything on the page under the breadcrumbs header.
The component will get the following props:
query
(object): The query string for the current view, can be used to paginate reports, or sort/filter report data.path
(string): The exact path for this view.pathMatch
(string): The route matched for this view, should always be/analytics/:report
.params
(object): This will contain thereport
from the path, which should matchreport
in the page object.
Note: Adding your page to woocommerce-reports-list
does not add the item to the admin menu, you'll need to do that in PHP with wc_admin_register_page
.