fix: update commission calculation methods for admin and vendor earnings and add filter on them and remove that filter from get_earning_by_order

[Aunshon]

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

Closes

• Closes dokan_get_earning_by_order doesn't work anymore in 4.0 #2722

How to test the changes in this Pull Request:

Consume dokan_get_earning_by_order filter and add a fee and watch the order details page if fee was added successfully.
And test also the refund.

add_filter( 'dokan_get_earning_by_order', function( $earning, $order, $context ) {
    if ( $context === 'admin' ) {
        $fees = 50 // adding an exra fee.
        $earning += $fees;
    }

    return $earning;
}, 10, 3 );

Changelog entry

- **fix:** Added missing 'dokan_get_earning_by_order' hook in order commission calculation.

Summary by CodeRabbit

• New Features

  • Added an extension point allowing external code to modify vendor earnings and admin commission values before they are returned.

• Chores

  • Updated distribution settings to exclude additional build configuration files from deployment packages.

[coderabbitai]

"""

Walkthrough

The changes refactor how commission values are retrieved and filtered in the commission calculation logic. The get_earning_by_order method now directly returns commission values without applying filters, while the filtering logic is moved into the get_vendor_earning and get_admin_commission methods, which now apply a filter before returning their results.

Changes

File(s)	Change Summary
includes/Commission.php	Simplified get_earning_by_order to directly return commission values, removing deprecated filter and intermediate logic.
includes/Commission/OrderCommission.php	Updated get_vendor_earning and get_admin_commission to apply a filter to their results before returning.
.distignore	Added webpack-dependency-mapping.js, webpack-entries.js, and base-tailwind.config.js to ignore list.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant Commission
    participant OrderCommission

    Caller->>Commission: get_earning_by_order(order, recipient)
    Commission->>OrderCommission: get_vendor_earning() or get_admin_commission()
    OrderCommission->>OrderCommission: Calculate earning/commission
    OrderCommission->>OrderCommission: Apply 'dokan_get_earning_by_order' filter
    OrderCommission-->>Commission: Return filtered value
    Commission-->>Caller: Return value

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Restore functionality of dokan_get_earning_by_order filter hook in Dokan 4.0 (#2722)	✅

Suggested labels

QA approved, :+1: Dev Review Done, Upcoming Release

Suggested reviewers

• mrabbani

Poem

A bunny hopped through code so neat,
Refactored filters, made it sweet.
Commissions now are clear and bright,
With hooks for all to tweak just right.
No more clutter, just a streamlined hop—
This rabbit’s work will never stop!
🐇✨
"""

---

📜 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 49b6542 and 62adfd6.

📒 Files selected for processing (1)

• .distignore (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• .distignore

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

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

---

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

• 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.

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.

[Aunshon]

We have decided no to use dokan_get_earning_by_order filter, we will deprecate it soon. We recommend to use container class override approach.

👇 See the below descussion

#2722 (comment)

[jamil-mahmud]

@Aunshon vai, is it tested and checked for the hotfix version?

[Aunshon]

@Aunshon vai, is it tested and checked for the hotfix version?

@jamil-mahmud Vai we decided not to merge this pr and we recommend user to customize as mentioned.