8ee74ede0e
* replace capitalized Woo.com with WooCommerce.com * replace http URLs * replace https URLs * replace developer.woo.com * add missing version in `@since` tag * unslash the HTTP_REFERER * WordPress.Security.ValidatedSanitizedInput.InputNotSanitized * add changelog file * add more changelog files * address linter errors * address more linter errors * fix test * more linter errors |
||
|---|---|---|
| .. | ||
| add-abbreviated-notification | ||
| add-navigation-items | ||
| add-report | ||
| add-task | ||
| dashboard-section | ||
| important-admin-notice | ||
| payment-gateway-suggestions | ||
| simple-inbox-note | ||
| sql-modification | ||
| table-column | ||
| README.md | ||
| examples.config.js | ||
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/admin-library 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