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

Update example plugin in Activity Notes docs to correct further issues (#45158) 

* Improves documentation of example plugins for WooCommerce Admin Notes.

- Adds namespacing for `Automattic\WooCommerce\Admin\Notes\Notes`.
- Uses namespacing in `class_exists` checks.
- Deletes duplicate code.

* Changelog.
This commit is contained in:
And Finally 2024-03-04 10:03:34 +00:00 committed by GitHub
parent e38ffc8427
commit 2789f39bc7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 14 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -60,6 +60,7 @@ Here’s a short example plugin that adds a new activity panel inbox note on plu
* Version: 1.0.1 * Version: 1.0.1
*/ */
use Automattic\WooCommerce\Admin\Notes\Notes as Notes;
use Automattic\WooCommerce\Admin\Notes\Note as Note; use Automattic\WooCommerce\Admin\Notes\Note as Note;
class WooCommerce_Activity_Panel_Inbox_Example_Plugin_One { class WooCommerce_Activity_Panel_Inbox_Example_Plugin_One {
@ -107,8 +108,6 @@ class WooCommerce_Activity_Panel_Inbox_Example_Plugin_One {
'activated_formatted' => $activated_time_formatted, 'activated_formatted' => $activated_time_formatted,
) ); ) );
$note->set_type( Note::E_WC_ADMIN_NOTE_INFORMATIONAL ); $note->set_type( Note::E_WC_ADMIN_NOTE_INFORMATIONAL );
$note->set_layout('plain');
$note->set_image('');
$note->set_name( self::NOTE_NAME ); $note->set_name( self::NOTE_NAME );
$note->set_source( 'wapi-example-plugin-one' ); $note->set_source( 'wapi-example-plugin-one' );
$note->set_layout('plain'); $note->set_layout('plain');
@ -131,7 +130,7 @@ class WooCommerce_Activity_Panel_Inbox_Example_Plugin_One {
* Removes any notes this plugin created. * Removes any notes this plugin created.
*/ */
public static function remove_activity_panel_inbox_notes() { public static function remove_activity_panel_inbox_notes() {
if ( ! class_exists( 'Notes' ) ) { if ( ! class_exists( 'Automattic\WooCommerce\Admin\Notes\Notes' ) ) {
return; return;
} }
@ -148,6 +147,7 @@ function wapi_example_one_deactivate() {
WooCommerce_Activity_Panel_Inbox_Example_Plugin_One::remove_activity_panel_inbox_notes(); WooCommerce_Activity_Panel_Inbox_Example_Plugin_One::remove_activity_panel_inbox_notes();
} }
register_deactivation_hook( __FILE__, 'wapi_example_one_deactivate' ); register_deactivation_hook( __FILE__, 'wapi_example_one_deactivate' );
``` ```
### Updating Inbox Items ### Updating Inbox Items
@ -166,6 +166,9 @@ Here’s a short example plugin that updates an activity panel inbox note:
* Version: 1.0.0 * Version: 1.0.0
*/ */
use Automattic\WooCommerce\Admin\Notes\Notes as Notes;
use Automattic\WooCommerce\Admin\Notes\Note as Note;
class WooCommerce_Activity_Panel_Inbox_Example_Plugin_Two { class WooCommerce_Activity_Panel_Inbox_Example_Plugin_Two {
const NOTE_NAME = 'wapi-example-plugin-two'; const NOTE_NAME = 'wapi-example-plugin-two';
@ -173,7 +176,7 @@ class WooCommerce_Activity_Panel_Inbox_Example_Plugin_Two {
* Adds a note to the merchant' inbox. * Adds a note to the merchant' inbox.
*/ */
public static function add_or_update_activity_panel_inbox_note() { public static function add_or_update_activity_panel_inbox_note() {
if ( ! class_exists( 'Notes' ) ) { if ( ! class_exists( 'Automattic\WooCommerce\Admin\Notes\Notes' ) ) {
return; return;
} }
@ -205,8 +208,6 @@ class WooCommerce_Activity_Panel_Inbox_Example_Plugin_Two {
) ); ) );
$note->set_type( Note::E_WC_ADMIN_NOTE_INFORMATIONAL ); $note->set_type( Note::E_WC_ADMIN_NOTE_INFORMATIONAL );
$note->set_layout('plain');
$note->set_image('');
$note->set_name( self::NOTE_NAME ); $note->set_name( self::NOTE_NAME );
$note->set_layout('plain'); $note->set_layout('plain');
$note->set_image(''); $note->set_image('');
@ -219,7 +220,7 @@ class WooCommerce_Activity_Panel_Inbox_Example_Plugin_Two {
* Removes any notes this plugin created. * Removes any notes this plugin created.
*/ */
public static function remove_activity_panel_inbox_notes() { public static function remove_activity_panel_inbox_notes() {
if ( ! class_exists( 'Notes' ) ) { if ( ! class_exists( 'Automattic\WooCommerce\Admin\Notes\Notes' ) ) {
return; return;
} }
@ -236,6 +237,7 @@ function wapi_example_two_deactivate() {
WooCommerce_Activity_Panel_Inbox_Example_Plugin_Two::remove_activity_panel_inbox_notes(); WooCommerce_Activity_Panel_Inbox_Example_Plugin_Two::remove_activity_panel_inbox_notes();
} }
register_deactivation_hook( __FILE__, 'wapi_example_two_deactivate' ); register_deactivation_hook( __FILE__, 'wapi_example_two_deactivate' );
``` ```
#### Using the REST API #### Using the REST API

5
plugins/woocommerce/changelog/update-activity-panel-inbox-md Normal file
View File

@ -0,0 +1,5 @@
Significance: patch
Type: tweak
Comment: Minor changes to example plugin code in Markdown file.