Add do_action before displaying the confirmation page

[Genevieve-K]

Could you add a do_action() when a payment is done and the confirmation page displayed ?
I developed a cart and I want to delete the gifts in the cart when the payment is done. The donation status can be pending for an offline donation or complete. Testing the status is therefore not sufficient.

I use until now the filter to 'give_get_success_page_uri' but for Stripe, if there are errors with the payment, the give_get_success_page_uri() function is called before creating the payment intent. And this filter is applied even if there is a failure.

I tested to use a filter to 'give_success_page_redirect', but this work only for legacy gateways. For Stripe, the redirect is in __invoke(), in the HandleGatewayPaymentCommand class.

If all gateways use this function, could you add a do_action() in this function for example? It's rather urgent.
Thank you by advance.

[jonwaldstein]

Hey @Genevieve-K, great suggestions. I'll need to determine the best place for the do_action to go. The lifecycle of a donation is a little tricky because gateways are the deciding factor and we rely on them to essentially complete the form how they see fit.

Sometimes they will tell the framework the payment is complete, other times they will use webhooks to complete the payment, or handle redirecting themselves on the front-end.

To truly know when a donation is complete would be to listen for its status to change through givewp_donation_updated or legacy hook give_update_payment_status.

To know when a form is complete, I think you are on the right track recommending the confirmation page.

Honestly, I think having an action right before the actual URL request to the confirmation page might be the most reliable way to determine when a form is completed. In your situation you would probably need to check the confirmation page $donationId against a $donationId stored in some type of session before clearing anything. Reason being, the confirmation page is a unique, secure url for each donation and can be visited more than once.

[Genevieve-K]

Maybe I can continue to use the 'give_get_success_page_uri' filter, but in the create() function for CreatePaymentIntent, an arg named return_url is created with the value give_get_success_page_uri(), and this arg doesn't seem to be used. The result is that my filter being applied and I delete the gifts in the cart even if an error occurs.

[Genevieve-K]

Is the arg named return_url useful? Without it, I can continue to use the 'give_get_success_page_uri' filter.

[jonwaldstein]

@Genevieve-K I have temporary solutions for you to try below. If any of these work we can look into adding some actions to make things easier.

/**
 * This could work for v3 forms
 */
add_action('template_redirect', static function() {
    // check for the confirmation page URL
    if (isset($_GET['givewp-route']) && $_GET['givewp-route'] === 'donation-confirmation-receipt-view') {
        // Check if the referer is a valid URL and contains the string 'givewp-route=donation-form-view' which means it came from a GiveWP donation form
        if (filter_var($_SERVER['HTTP_REFERER'], FILTER_VALIDATE_URL) && str_contains('givewp-route=donation-form-view', $_SERVER['HTTP_REFERER']) !== null) {
            // at this point we know the user successfully came from a GiveWP donation form
        }
    }
});

/**
 * I'm not completely sure but I think this could work for v2 forms (priority would need to be lower than core to work)
 */
add_action('wp_ajax_get_receipt', static function() {
    // might need to get clever here but since this is an ajax request for the receipt - you can probabaly assume the form is complete
    // check LoadTemplate.php handleReceiptAjax() for more inspiration
}, 8);

[Genevieve-K]

Waouh! isDirty() is a magic function!
I added an action to 'give_success_page_redirect' for legacy gateways. I tested with several gateways (offline, Stripe...). It seems good.
Thank you!

[jonwaldstein]

@Genevieve-K glad to hear!

[Genevieve-K]

Thank you a lot for your help. I have now 3 filters: for 'give_success_page_redirect', 'givewp_donation_updated' and 'give_update_payment_status'.
I still have a case where the gifts remain in the cart. It's for a recurring donation with PayPal Commerce. In the donation confirmation, the status is 'pending', and a few minutes later, after PayPal responses, the status changed to 'Complete'. But it's too late., the donation confirmation is still displayed.
Which filter do you advice? Perhaps when the PayPal status changes to 'APPROVAL_PENDING' ? an action to 'give_recurring_post_create_payment_profiles' ?

[jonwaldstein]

@Genevieve-K

It looks like PayPal Commerce sets the donation status processing and then will complete the status via webhook.

I think in some cases for recurring, you could check the subscription status property instead of the donation status property - basically the same way as above but using givewp_subscription_updated.

add_action('givewp_subscription_updated', static function (Give\Subscriptions\Models\Subscription $subscription) {
    if ($subscription->isDirty('status')) {
        $allowedSubscriptionStatuses = [
            Give\Subscriptions\ValueObjects\SubscriptionStatus::PENDING(),
            Give\Subscriptions\ValueObjects\SubscriptionStatus::COMPLETED(),
            Give\Subscriptions\ValueObjects\SubscriptionStatus::ACTIVE(),
        ];

        /** @var Give\Subscriptions\ValueObjects\SubscriptionStatus $originalStatus */
        $originalStatus = $subscription->getOriginal('status');
        $newStatus = $subscription->status;

        if ($newStatus->isOneOf(...$allowedSubscriptionStatuses)) {
            // do something
        }

    }
});

[Genevieve-K]

Thank you. I try with these status:

		$allowedSubscriptionStatuses = [
			SubscriptionStatus::PENDING(),
			SubscriptionStatus::COMPLETED(),
			SubscriptionStatus::ACTIVE(),
		];

It's difficult to test because PayPal donations work from time to time.

[Genevieve-K]

I was finally able to test it. My gift is still in the cart. I don't think that subscription status changes until PayPal responds via the webhook.
In PaymentGateways/PayPalCommerce/Repositories/Subscription.php, there are some functions as updateStatus() for a $paypalSubscriptionId, isSuccessful(). But I don't se how to exploit them.

[Genevieve-K]

@jonwaldstein I see in class SubscriptionProcessingHandler that the donation status is set to DonationStatus::PROCESSING(). But this class seems to be invoked only for legacy gateways. Perhaps the same thing when processing a PayPal recurring donation is a good idea. I think that it's not possible for now to use a filter.
For the moment, it works for test and Stripe recurring donations. I have to test with RazorPay.