Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request woocommerce/woocommerce-admin#2043 from woocommerce/fix/activity-panel-readme 

Update admin notes readme.
This commit is contained in:
Jeff Stieler 2019-04-12 13:30:49 -06:00 committed by GitHub
parent ef0fd73f2c 8c382773c2
commit bf1d1323b3
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
plugins/woocommerce-admin/docs/examples/activity-panel-inbox.md
View File

@ -19,7 +19,7 @@ But unlike today’s notices, this part of the UI will be reserved for “priori
The second category is what we’re focusing on in this example - and what we expect the vast majority of extension developers will want to extend - we call it the “Activity Panel Inbox.” It will look something like this:
![Activity Panel Inbox](images/activity-panel-inbox.png)
<img src="images/activity-panel-inbox.png" width="400" title="Activity Panel Inbox" alt="Activity Panel Inbox" />
This section is dedicated to informational content coming from multiple sources such as WooCommerce core, WooCommerce.com Subscription management, extensions activity and store achievements. This section was also envisioned to display more insightful content in the future, e.g. content that could help with the day to day tasks of managing and optimizing a store.
@ -48,7 +48,7 @@ So, enough rules - let’s get into how to code this up. And surprise, no JavaSc
Here’s a short example plugin that adds a new activity panel inbox note on plugin activation, and removes it on deactivation:
```
```php
<?php
/**
* Plugin Name: WooCommerce Activity Panel Inbox Example Plugin One
@ -151,7 +151,7 @@ register_deactivation_hook( __FILE__, 'wapi_example_one_deactivate' );
Here’s a short example plugin that updates an activity panel inbox note:
```
```php
<?php
/**
* Plugin Name: WooCommerce Activity Panel Inbox Example Plugin Two
@ -234,7 +234,11 @@ function wapi_example_two_deactivate() {
register_deactivation_hook( __FILE__, 'wapi_example_two_deactivate' );
```
#### Using the REST API
A limited set of note fields can be updated over the REST API: `status` and `date_reminder`.
## Questions?
This is just the tip of the iceberg for possibilities for your own extensions to WooCommerce. Check
out the new [sales record notes](https://github.com/woocommerce/woocommerce-admin/blob/master/includes/class-wc-admin-notes-new-sales-record.php) and the [settings notes](https://github.com/woocommerce/woocommerce-admin/blob/master/includes/class-wc-admin-notes-settings-notes.php) for in the woocommerce-admin code itself for other examples of working with this fun new feature.
out the new [sales record notes](https://github.com/woocommerce/woocommerce-admin/blob/master/includes/notes/class-wc-admin-notes-new-sales-record.php) and the [settings notes](https://github.com/woocommerce/woocommerce-admin/blob/master/includes/notes/class-wc-admin-notes-settings-notes.php) in the woocommerce-admin code itself for other examples of working with this fun new feature.