Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pronamic/pronamic-payment-gateways-fees-for-woocommerce
This WordPress plugin adds settings to all WooCommerce gateways to add a fixed and/or variable (percentage) fee.
https://github.com/pronamic/pronamic-payment-gateways-fees-for-woocommerce
payment payment-gateway payments pronamic pronamic-pay surcharge surcharge-fee woocommerce woocommerce-extension woocommerce-payment woocommerce-plugin wordpress wordpress-development wordpress-plugin
Last synced: about 1 month ago
JSON representation
This WordPress plugin adds settings to all WooCommerce gateways to add a fixed and/or variable (percentage) fee.
- Host: GitHub
- URL: https://github.com/pronamic/pronamic-payment-gateways-fees-for-woocommerce
- Owner: pronamic
- Created: 2023-09-29T13:13:14.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-14T11:38:29.000Z (8 months ago)
- Last Synced: 2024-09-27T14:42:02.941Z (about 2 months ago)
- Topics: payment, payment-gateway, payments, pronamic, pronamic-pay, surcharge, surcharge-fee, woocommerce, woocommerce-extension, woocommerce-payment, woocommerce-plugin, wordpress, wordpress-development, wordpress-plugin
- Language: PHP
- Homepage: https://www.pronamic.shop/product/pronamic-payment-gateways-fees-for-woocommerce/
- Size: 604 KB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Pronamic Payment Gateways Fees for WooCommerce
This WordPress plugin adds settings to all WooCommerce gateways to add a fixed and/or variable (percentage) fee.
[](https://packagist.org/packages/pronamic/pronamic-payment-gateways-fees-for-woocommerce)
[](https://packagist.org/packages/pronamic/pronamic-payment-gateways-fees-for-woocommerce)
[](https://packagist.org/packages/pronamic/pronamic-payment-gateways-fees-for-woocommerce)
[](https://packagist.org/packages/pronamic/pronamic-payment-gateways-fees-for-woocommerce)
[](https://packagist.org/packages/pronamic/pronamic-payment-gateways-fees-for-woocommerce)
- [Introduction](#introduction)
- [Installation](#installation)
- [Screenshots](#screenshots)
- [Flow](#flow)
- [Links](#links)
## Introduction
This WordPress plugin adds settings to all WooCommerce gateways to add a fixed and/or variable (percentage) fee.
## Installation
```
composer require pronamic/pronamic-payment-gateways-fees-for-woocommerce
```
```php
\Pronamic\WooCommercePaymentGatewaysFees\Plugin::instance()->setup();
```
## Screenshots
## Flow
WooCommerce recommends using the `woocommerce_cart_calculate_fees` hook to add fees:
> We suggest using the action woocommerce_cart_calculate_fees hook for adding fees.
_Source: https://github.com/woocommerce/woocommerce/blob/8.1.0/plugins/woocommerce/includes/class-wc-cart-fees.php#L7_
This hook is called as soon as the `WC()->cart->calculate_totals()` function is called, WooCommerce uses the `WC_Cart_Totals` class to calculate totals:
**`class-wc-cart.php`**
```php
/**
* Calculate totals for the items in the cart.
*
* @uses WC_Cart_Totals
*/
public function calculate_totals() {
$this->reset_totals();
if ( $this->is_empty() ) {
$this->session->set_session();
return;
}
do_action( 'woocommerce_before_calculate_totals', $this );
new WC_Cart_Totals( $this );
do_action( 'woocommerce_after_calculate_totals', $this );
}
```
_Source: https://github.com/woocommerce/woocommerce/blob/8.1.0/plugins/woocommerce/includes/class-wc-cart.php#L1393-L1411_
When creating a `WC_Cart_Totals` instance, the `WC_Cart_Totals->calculate()` function is executed:
**`class-wc-cart-totals.php`**
```php
/**
* Run all calculation methods on the given items in sequence.
*
* @since 3.2.0
*/
protected function calculate() {
$this->calculate_item_totals();
$this->calculate_shipping_totals();
$this->calculate_fee_totals();
$this->calculate_totals();
}
```
_Source: https://github.com/woocommerce/woocommerce/blob/8.1.0/plugins/woocommerce/includes/class-wc-cart-totals.php#L127-L154_
What can be seen here is that the final totals are calculated after calculating the fee totals. This means that the order total is not yet available within the `woocommerce_cart_calculate_fees` hook. In other words, within the `woocommerce_cart_calculate_fees` hook the result of `$cart->get_total( '' )` will always be `0`.
This is inconvenient because the payment gateway fees are often based on the total amount to be paid. That's why we hook into the `woocommerce_after_calculate_totals` hook and recalculate the totals again. This extra calculation seems double, but it seems to be the easiest way to reliably request the cart total.
## Links
- https://www.pronamic.eu/
[](https://www.pronamic.eu/contact/)