32 lines
1.1 KiB
Markdown
32 lines
1.1 KiB
Markdown
# WooCommerce Admin Extension Examples
|
|
|
|
Examples for extending WooCommerce Admin
|
|
|
|
## Directions
|
|
|
|
Install dependencies, if you haven't already.
|
|
|
|
```bash
|
|
pnpm install
|
|
```
|
|
|
|
Build the example extension by running the pnpm script and passing the example name.
|
|
|
|
|
|
```bash
|
|
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
|