Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
woocommerce/plugins/woocommerce-admin/docs/examples/extensions
History
Yash Kapoor 4a969a6fd1 Included RegExp for JS files in examples.config.js (https://github.com/woocommerce/woocommerce-admin/pull/3510) 2020-01-03 12:03:20 -05:00
..
add-report Remove defunct filename prefix from remaining files. 2019-08-12 15:06:36 -07:00
add-task Update onboarding filters with a consistent prefix (https://github.com/woocommerce/woocommerce-admin/pull/3295) 2019-11-25 11:15:22 -05:00
dashboard-section Decouple currency and numbers packages from `wcSettings`. (https://github.com/woocommerce/woocommerce-admin/pull/3277) 2019-11-21 16:51:52 -05:00
important-admin-notice Add filters to WP notice collapsing behavior. (https://github.com/woocommerce/woocommerce-admin/pull/3391) 2019-12-18 08:12:32 -05:00
sql-modification DataStores: normalize contexts to plural (https://github.com/woocommerce/woocommerce-admin/pull/3419) 2019-12-26 11:50:52 +13:00
table-column Remove defunct filename prefix from remaining files. 2019-08-12 15:06:36 -07:00
README.md AssetDataRegistry: update SQL example (https://github.com/woocommerce/woocommerce-admin/pull/3418) 2019-12-17 07:16:46 +13:00
examples.config.js Included RegExp for JS files in examples.config.js (https://github.com/woocommerce/woocommerce-admin/pull/3510) 2020-01-03 12:03:20 -05:00

README.md

WooCommerce Admin Extension Examples

Examples for extending WooCommerce Admin

Directions

Install dependencies, if you haven't already.

npm install

Build the example extension by running the npm script and passing the example name.

npm run example -- --ext=<example>

Go to your Wordpress installation's plugins page and activate the plugin. WooCommerce Analytics reports will now reflect the changes made by the example extension.

You can make changes to Javascript and PHP files in the example and see changes reflected upon refresh.

Example Extensions

  • add-report - Create a "Hello World" report page.
  • add-task - Create a custom task for the onboarding task list.
  • dashboard-section - Adding a custom "section" to the new dashboard area.
  • table-column - An example of how to add column(s) to any report.
  • sql-modification - An example of how to modify SQL statements.