🛠 refactor: dokan_is_user_seller function

[devAsadNur]

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

Changes proposed in this Pull Request:

Related Pull Request(s)

• Full PR Link

Closes

• Closes #

How to test the changes in this Pull Request:

• Steps or issue link

Changelog entry

refactor: dokan_is_user_seller function

Detailed Description of the pull request. What was previous behaviour
and what will be changed in this PR.

Before Changes

Describe the issue before changes with screenshots(s).

After Changes

Describe the issue after changes with screenshot(s).

Feature Video (optional)

Link of detailed video if this PR is for a feature.

PR Self Review Checklist:

• Code is not following code style guidelines
• Bad naming: make sure you would understand your code if you read it a few months from now.
• KISS: Keep it simple, Sweetie (not stupid!).
• DRY: Don't Repeat Yourself.
• Code that is not readable: too many nested 'if's are a bad sign.
• Performance issues
• Complicated constructions that need refactoring or comments: code should almost always be self-explanatory.
• Grammar errors.

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
  • Enhanced dokan_is_user_seller function with improved user role verification
• Bug Fixes
  • Added option to exclude vendor staff from seller identification
• Documentation
  • Updated function parameter descriptions for clarity

[coderabbitai]

Walkthrough

The pull request modifies the dokan_is_user_seller function in the includes/functions.php file. The primary change is updating the function signature to include an additional boolean parameter $exclude_staff with a default value of false. This new parameter allows for more granular control over seller identification, specifically enabling the exclusion of users with the vendor_staff capability from being considered sellers when the parameter is set to true.

Changes

File	Change Summary
includes/functions.php	- Updated dokan_is_user_seller() function signature to include int $user_id and bool $exclude_staff = false - Added logic to exclude staff users when $exclude_staff is true - Streamlined return statement for dokandar capability check

Suggested labels

Needs: Testing, Upcoming Release

Suggested reviewers

• mrabbani
• Aunshon

Possibly related PRs

• Error on approved refund request when empty Commission _dokan_additional_fee #4018 #2485: Modifies OrderItem class method related to user capabilities
• 🎯 fix: Invalid return value for commission rate validate method #2490: Updates Commission class method for rate validation
• 🎯 fix: Translation on some pages were not working due to wrong text-domains #2503: Addresses translation issues for text domains

Poem

🐰 A function refined, with staff in mind,
Seller checks now more defined!
One parameter more, a boolean delight,
Dokan's logic shines ever so bright!
Hop to it, code rabbit's glee! 🚀

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e97ff28 and a8eb2d9.

📒 Files selected for processing (1)

• includes/functions.php (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (4)

• GitHub Check: e2e tests (3, 3)
• GitHub Check: e2e tests (2, 3)
• GitHub Check: e2e tests (1, 3)
• GitHub Check: api tests (1, 1)

🔇 Additional comments (2)

includes/functions.php (2)

66-70: LGTM! Documentation is clear and accurate.

The function documentation has been properly updated to include the new $exclude_staff parameter with its description.

---

71-76: LGTM! The implementation is correct and follows best practices.

The function has been refactored to:

1. Add type hints for parameters and return type
2. Add staff exclusion logic
3. Simplify the return statement

The changes improve code readability and maintainability while maintaining backward compatibility with the default $exclude_staff = false.

---

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 generate docstrings to generate docstrings for this PR. (Beta)
• @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.