Add $data parameter to dokan_update_vendor hook

[mralaminahamed]

All Submissions:

• My code follow the WordPress' coding standards
• My code satisfies feature requirements
• My code is tested
• My code passes the PHPCS tests
• My code has proper inline documentation
• I've included related pull request(s) (optional)
• I've included developer documentation (optional)
• I've added proper labels to this pull request

Related Pull Request(s)

• N/A

Closes

• Closes #

How to test the changes in this Pull Request:

1. Navigate to the vendor update function in the Manager class
2. Verify that the 'dokan_update_vendor' hook now includes the $data parameter
3. Check that the doc blocks for both 'dokan_before_update_vendor' and 'dokan_update_vendor' hooks are present and accurate

Changelog entry

Enhanced Vendor Update Hook Functionality

Added $data parameter to the dokan_update_vendor action hook, allowing developers to access the full array of updated vendor data. Updated related documentation to reflect this change and added missing doc block for dokan_before_update_vendor hook.

Before Changes

The dokan_update_vendor hook only passed the vendor ID, limiting the information available to hooked functions.

After Changes

The dokan_update_vendor hook now passes both the vendor ID and the full $data array, providing more comprehensive information to hooked functions.

Feature Video (optional)

N/A

PR Self Review Checklist:

• Code follows style guidelines
• Naming is clear and understandable
• Code is simple and straightforward (KISS principle)
• No code duplication (DRY principle)
• Code is readable
• No performance issues
• No overly complicated constructions needing refactoring or comments
• No grammar errors in comments or documentation

FOR PR REVIEWER ONLY:

• Correct — Does the change do what it's supposed to?
• Secure — Are there any security concerns?
• Readable — Is the code easily understandable?
• Elegant — Does the change fit well within the overall style and architecture?

Summary by CodeRabbit

• New Features
  • Introduced two new action hooks for the vendor update process: dokan_before_update_vendor and dokan_update_vendor, enhancing integration and customization options.
• Improvements
  • Updated the vendor update method to allow for pre-update processing and provide additional context during the update.
• Documentation
  • Added comments to clarify the purpose and parameters of the new hooks, improving code documentation.

[coderabbitai]

Walkthrough

The changes in this pull request focus on the Manager class within the WeDevs\Dokan\Vendor namespace, specifically the update method. Two new action hooks, dokan_before_update_vendor and dokan_update_vendor, have been added to facilitate pre-update processing and provide additional context about the updated vendor data. The overall logic of the update method remains largely unchanged, but the new hooks enhance extensibility and integration options for external code.

Changes

File	Change Summary
includes/Vendor/Manager.php	- Added action hook dokan_before_update_vendor before vendor data update.
	- Added action hook dokan_update_vendor after vendor data update, including $data parameter.

Possibly related PRs

• fix: Improve vendor coupon validation for various discount item types and empty cart scenarios #2351: The changes in the ensure_vendor_coupon method may interact with vendor data updates, similar to the modifications made in the update method of the Manager class.

Suggested labels

Upcoming Release

Suggested reviewers

• shohag121

Poem

🐰 In the garden where vendors play,
New hooks are here to save the day!
Before and after, they dance and sing,
Enhancing updates, oh what a thing!
With each little change, we hop with glee,
For better integration, just wait and see! 🌼

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 443a6de and d8a4394.

📒 Files selected for processing (1)

• includes/Vendor/Manager.php (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• includes/Vendor/Manager.php

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)

includes/Vendor/Manager.php (2)

432-439: Update the version number in the docblock

The implementation of the dokan_before_update_vendor action hook looks good. It's correctly placed before the vendor update and passes appropriate parameters. However, the version number is missing in the docblock.

Please update the docblock with the correct version number:

- * @since [insert version number here]
+ * @since 3.7.22

---

444-452: Update the version number and improve wording in the docblock

The implementation of the dokan_update_vendor action hook is correct. It's properly placed after the vendor update and passes appropriate parameters. However, there are two minor improvements needed in the docblock:

1. The version number is missing.
2. The wording can be slightly improved for clarity.

Please update the docblock as follows:

- * Fires after a vendor has been updated.
+ * Fires after a vendor is updated.
  *
- * @since [insert version number here]
+ * @since 3.7.22

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 9a21a84 and 2e7463c.

📒 Files selected for processing (1)

• includes/Vendor/Manager.php (1 hunks)

🔇 Additional comments (1)

includes/Vendor/Manager.php (1)

432-452: LGTM: New action hooks enhance extensibility

The addition of dokan_before_update_vendor and dokan_update_vendor action hooks significantly improves the extensibility of the vendor update process. These hooks allow developers to perform custom actions before and after a vendor is updated, which aligns well with the PR objectives.

The implementation is correct, and the hooks are placed at appropriate points in the update process. The only minor issues were in the documentation, which have been addressed in previous comments.

These changes provide developers with more control and flexibility when working with vendor updates, which is a valuable improvement to the Dokan plugin.