Feature: Update V3 DonationController to support trashed donations #8018
Conversation
JoshuaHungDinh
changed the base branch from
develop
to
epic/donation-details-admin-page
| $query->where('post_type', 'give_payment'); | ||
| $query->where('post_status', 'trash', '<>'); |
There was a problem hiding this comment.
We should have a way for folks to choose whether trashed donations are included in the results.
There was a problem hiding this comment.
Agreed. I’ve was thinking we might need a way to surface trashed donations in the list table and also provide users with a way to 'empty the trash'.
| @@ -126,6 +127,16 @@ public function registerRoute() | |||
| 'columns', | |||
| ], | |||
| ], | |||
| 'postStatus' => [ | |||
There was a problem hiding this comment.
The post status is something we use under the hood for storage - however, the donation should just refer to this as status
| 'postStatus' => [ | |
| 'status' => [ |
There was a problem hiding this comment.
Resolved: 4b24aa6
| 'active', | ||
| 'trash', | ||
| ], | ||
| 'description' => 'Filter donations by WordPress post status: active (all except trash), or trash.' |
There was a problem hiding this comment.
Again here let's keep the context of the donation - not WordPress posts (which is the storage we use under the hood and will change in the future)
| 'description' => 'Filter donations by WordPress post status: active (all except trash), or trash.' | |
| 'description' => 'Filter donations by Donation status: active (all except trash), or trash.' |
There was a problem hiding this comment.
Resolved: 4b24aa6
| $errors[] = ['id' => $id, 'message' => __('Failed to delete donation', 'give')]; | ||
| } | ||
| } else { | ||
| $trashed = wp_trash_post($donation->id); |
There was a problem hiding this comment.
I'm hesitant to use wp_trash_post directly here as we want this endpoint to interact with the donation model & abstract awa the data layer as much as possible. In the future when the storage of a donation changes - this would be something we would have to update.
wp_trash_post does a couple things:
- Changes the status to
trash - Stores the previous status & time in meta
_wp_trash_meta_status,_wp_trash_meta_time(as a way to restore to previous status)
All that is something we can support directly in the donation repository with a new trash() method and/or build it into the existing delete method.
At the very least if we simply changed the status of the donation to trash and saved - then that would be better for maintainability here.
There was a problem hiding this comment.
Thanks for the context! That makes sense in terms of long-term maintainability and keeping the data layer abstracted.
I pushed up a commit here to reflect that approach: 59a1f8b. Let me know if this looks more in line with what you were thinking!
Resolves GIVE-2686
Description
Enhance DonationController to Support Soft and Hard Deletes with force Parameter
This PR improves the Donation REST API by introducing support for soft deletes (trashing) and hard deletes (permanent removal) of donations via a new optional force parameter on delete endpoints.
Key Changes:
forceisfalseor omitted (default), donations are soft deleted by moving them to trash (wp_trash_post).forceistrue, donations are permanently deleted from the database.delete_itemanddelete_itemsmethods to handle theforceparameter accordingly.Affects
Visuals
Testing Instructions
Posttable of the database to verify the its status is nowTrashedPre-review Checklist
@unreleasedtags included in DocBlocks