Skip to content

fix: conditionally hide commission metabox for advertisement product orders #2786

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

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

Aunshon
Copy link
Collaborator

@Aunshon Aunshon commented Jul 4, 2025

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)

Closes

How to test the changes in this Pull Request:

  • Test as described exsection in the isseue.
  • Also test in other regular orders.

Changelog entry

- **fix:** Hide commission metabox for the orders that containing advertisement products

Summary by CodeRabbit

  • New Features
    • Added a filter to allow control over the visibility of the commission meta box on the order details page.

@Aunshon Aunshon self-assigned this Jul 4, 2025
@Aunshon Aunshon added Needs: Testing This requires further testing Needs: Dev Review It requires a developer review and approval labels Jul 4, 2025
Copy link
Contributor

coderabbitai bot commented Jul 4, 2025

Walkthrough

A new filter hook, dokan_show_commission_meta_box, has been introduced to control whether the commission meta box appears on the WooCommerce order details page. The default behavior is preserved but now allows external modification via the filter, with the order object passed as a parameter.

Changes

File(s) Change Summary
includes/Order/Admin/Hooks.php Added dokan_show_commission_meta_box filter to control commission meta box visibility in order admin.

Sequence Diagram(s)

sequenceDiagram
    participant Admin as WooCommerce Admin Order Page
    participant Hooks as Dokan Hooks
    participant Filter as External Filter (via dokan_show_commission_meta_box)

    Admin->>Hooks: Load order details page
    Hooks->>Filter: Apply dokan_show_commission_meta_box filter (default: !has_sub_order, pass $order)
    Filter-->>Hooks: Return true/false
    alt Filter returns true
        Hooks->>Admin: Show commission meta box
    else Filter returns false
        Hooks->>Admin: Do not show commission meta box
    end
Loading

Assessment against linked issues

Objective Addressed Explanation
Hide commission meta box for advertisement payment orders; no commission or vendor earnings (#4455)

Possibly related PRs

Suggested labels

:+1: Dev Review Done, QA approved

Suggested reviewers

  • mrabbani

Poem

In the warren of code, a tweak hops in,
A filter appears—let the logic begin!
No more confusion on what you see,
Commission meta box, shown by decree.
Rabbits rejoice, the bug’s out of sight,
Order details now display just right! 🐇✨

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, please review it.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
includes/Order/Admin/Hooks.php (1)

566-570: Well-implemented filter hook for commission metabox visibility control.

The filter implementation is clean and follows WordPress conventions. It maintains backward compatibility while allowing external control over the commission metabox visibility. The order object parameter provides good context for filtering decisions.

Consider adding inline documentation to describe the filter's purpose and parameters for better developer experience:

+        /**
+         * Filters whether to show the commission meta box on order details page.
+         *
+         * @since 3.14.0
+         *
+         * @param bool     $show_commission_meta_box Whether to show the commission meta box. Default is true when order has no sub-orders.
+         * @param WC_Order $order                    The order object.
+         */
         $show_commission_meta_box = apply_filters(
             'dokan_show_commission_meta_box',
             ! $has_sub_order,
             $order
         );
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between fab1435 and 4287419.

📒 Files selected for processing (1)
  • includes/Order/Admin/Hooks.php (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: api tests (1, 1)
  • GitHub Check: e2e tests (2, 3)
  • GitHub Check: e2e tests (1, 3)
  • GitHub Check: e2e tests (3, 3)
🔇 Additional comments (1)
includes/Order/Admin/Hooks.php (1)

573-573: Conditional check updated correctly to use filtered value.

The condition properly uses the filtered value to determine whether to add the commission metabox, maintaining the intended functionality while allowing external control.

@mrabbani mrabbani added 👍 Dev Review Done and removed Needs: Dev Review It requires a developer review and approval labels Jul 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needs: Testing This requires further testing 👍 Dev Review Done
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants