Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add actions before and after deleting product(s). #2368

Merged

Conversation

decodekult
Copy link
Contributor

@decodekult decodekult commented Sep 13, 2024

All Submissions:

  • My code follow the WordPress' coding standards
  • My code satisfies feature requirements
  • My code is tested
  • My code passes the PHPCS tests
  • I've added proper labels to this pull request

Changes proposed in this Pull Request:

Introduce some actions triggered before and after deleting products (individually, or in bulk actions) from the Dokan frontend dashboard, so we can hook WPML delete post actions into them.

The action handles follow the WordPress naming conventions related to suffixes, using _delete for hooks happening just before the deletion, and _deleted for hooks happening right after the deletion.

Closes

How to test the changes in this Pull Request:

No further tests needed here, just adding some actions.

Changelog entry

Add action hooks before and after deleting products.

FOR PR REVIEWER ONLY:

As a reviewer, your feedback should be focused on the idea, not the person. Seek to understand, be respectful, and focus on constructive dialog.

As a contributor, your responsibility is to learn from suggestions and iterate your pull request should it be needed based on feedback. Seek to collaborate and produce the best possible contribution to the greater whole.

  • Correct — Does the change do what it’s supposed to? ie: code 100% fulfilling the requirements?
  • Secure — Would a nefarious party find some way to exploit this change? ie: everything is sanitized/escaped appropriately for any SQL or XSS injection possibilities?
  • Readable — Will your future self be able to understand this change months down the road?
  • Elegant — Does the change fit aesthetically within the overall style and architecture?

Summary by CodeRabbit

  • New Features
    • Introduced action hooks for product deletion, allowing for custom behaviors before and after a product is deleted.
    • Added hooks for bulk product deletion, enabling additional processing or notifications during bulk delete actions.

Copy link
Contributor

coderabbitai bot commented Sep 13, 2024

Walkthrough

The changes introduce new action hooks to the product deletion processes in the Dokan plugin, specifically within the handle_delete_product method and the bulk_product_delete method. These hooks allow developers to execute custom actions before and after products are deleted, enhancing the extensibility of the product management functionality within the dashboard.

Changes

Files Change Summary
includes/Dashboard/Templates/Products.php, includes/Product/Hooks.php Added action hooks dokan_product_delete, dokan_product_deleted, dokan_product_bulk_delete, and dokan_product_bulk_deleted to facilitate custom actions during product deletion processes.

Assessment against linked issues

Objective Addressed Explanation
Trigger actions for product deletion to handle translations (Issue #82)
Ensure custom logic can be executed during bulk deletion (Issue #82)

Poem

In the dashboard, products go,
With hooks that help our features flow.
Before and after, actions play,
For translations, they pave the way.
Hopping through code, we celebrate,
Extensibility, oh, isn’t it great? 🐇✨

Tip

OpenAI O1 model for chat
  • We have deployed OpenAI's latest O1 model for chat.
  • OpenAI claims that this model has superior reasoning capabilities than their GPT-4o model.
  • Please share any feedback with us in the discussions post.

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 656056f and fe1a159.

Files selected for processing (2)
  • includes/Dashboard/Templates/Products.php (1 hunks)
  • includes/Product/Hooks.php (1 hunks)
Additional comments not posted (4)
includes/Product/Hooks.php (2)

250-250: LGTM!

The new action hook dokan_product_bulk_delete is added at the correct location, just before the bulk deletion process begins. The hook name follows the WordPress naming convention and aligns with the PR objectives.


256-256: LGTM!

The new action hook dokan_product_bulk_deleted is added at the correct location, just after the bulk deletion process completes. The hook name follows the WordPress naming convention and aligns with the PR objectives.

includes/Dashboard/Templates/Products.php (2)

624-624: Approve: New action hooks for product deletion.

The addition of the dokan_product_delete and dokan_product_deleted action hooks is a good enhancement. These hooks provide useful extension points for developers to execute custom actions before and after a product is deleted.

  • dokan_product_delete (line 624): This hook allows developers to perform any necessary cleanup or pre-deletion tasks just before a product is deleted. It can be used to modify the product data, trigger notifications, or integrate with other plugins or systems.

  • dokan_product_deleted (line 628): This hook allows developers to perform any post-deletion tasks or cleanup immediately after a product has been deleted. It can be used to update related data, clean up associated records, or trigger post-deletion actions.

The placement of these hooks is appropriate, ensuring they are triggered at the right points in the deletion process.

Also applies to: 628-628


Line range hint 635-666: LGTM!

The bulk_product_delete function looks good and follows a similar structure to the handle_delete_product function. It performs the necessary checks and permissions validation before proceeding with the bulk deletion of products.

The function iterates over the selected product IDs and deletes each product individually, ensuring proper cleanup and triggering the relevant hooks for each deletion.

The code is clean, well-structured, and includes appropriate error handling and redirection.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Deleting products from the dashboard does not delete translations
2 participants