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
Chi-Hsuan Huang b8aa7eb1fe
Update task list documentation and example (#38245) 
* Update woocommerce task list examples

* Update onboarding-tasks.md

* Add changelog

* Update changelog

* Update task list doc

* Update onboarding-tasks.md

* Update examples readme

* Fix lint

* Update onboarding-tasks.md

* Fix build wca example cmd

* Update plugins/woocommerce-admin/docs/features/onboarding-tasks.md

Co-authored-by: Ilyas Foo <foo.ilyas@gmail.com>

* Update plugins/woocommerce-admin/docs/features/onboarding-tasks.md

Co-authored-by: Ilyas Foo <foo.ilyas@gmail.com>

* Update plugins/woocommerce-admin/docs/features/onboarding-tasks.md

Co-authored-by: Ilyas Foo <foo.ilyas@gmail.com>

* Update plugins/woocommerce-admin/docs/features/onboarding-tasks.md

Co-authored-by: Ilyas Foo <foo.ilyas@gmail.com>

* Update task list image

---------

Co-authored-by: Ilyas Foo <foo.ilyas@gmail.com>
 		2023-05-18 11:21:53 +08:00
..
add-abbreviated-notification Cleanup Loader.php and move it to Internal namespace (https://github.com/woocommerce/woocommerce-admin/pull/8416) 2022-03-09 10:04:34 -04:00
add-navigation-items Fixing an unwanted page refresh when using Woo Navigation (https://github.com/woocommerce/woocommerce-admin/pull/7615) 2021-09-15 09:42:54 -07:00
add-report Cleanup Loader.php and move it to Internal namespace (https://github.com/woocommerce/woocommerce-admin/pull/8416) 2022-03-09 10:04:34 -04:00
add-task Update task list documentation and example (#38245) 2023-05-18 11:21:53 +08:00
dashboard-section Cleanup Loader.php and move it to Internal namespace (https://github.com/woocommerce/woocommerce-admin/pull/8416) 2022-03-09 10:04:34 -04:00
important-admin-notice Cleanup Loader.php and move it to Internal namespace (https://github.com/woocommerce/woocommerce-admin/pull/8416) 2022-03-09 10:04:34 -04:00
payment-gateway-suggestions Fix/37502: Correct spelling errors. (#37887) 2023-05-08 15:55:09 +08:00
simple-inbox-note Add Inbox Note example code to docs (https://github.com/woocommerce/woocommerce-admin/pull/8019) 2021-12-10 12:52:03 +08:00
sql-modification Cleanup Loader.php and move it to Internal namespace (https://github.com/woocommerce/woocommerce-admin/pull/8416) 2022-03-09 10:04:34 -04:00
table-column Cleanup Loader.php and move it to Internal namespace (https://github.com/woocommerce/woocommerce-admin/pull/8416) 2022-03-09 10:04:34 -04:00
README.md Update task list documentation and example (#38245) 2023-05-18 11:21:53 +08:00
examples.config.js Fix admin extensions webpack config 2022-04-14 13:49:51 +08:00

README.md

WooCommerce Admin Extension Examples

Examples for extending WooCommerce Admin

Directions

Install dependencies, if you haven't already.

pnpm install

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

WC_EXT=<example> pnpm --filter=woocommerce/client/admin example

You should see a new directory in ./woocommerce/plugins/{example} path. Include the output plugin in your .wp-env.json or .wp-env.override.json and restart the WordPress instance. WooCommerce 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.
  • payment-gateway-suggestions - An example of how to add a new payment gateway suggestion