Payment gateway configuration in Wordpress

Introduction

Payment gateway configuration lets your WordPress site accept online payments safely and easily.

You want to sell products or services on your WordPress website.

You need to accept credit card or digital wallet payments from customers.

You want to connect your site to popular payment providers like PayPal or Stripe.

You want to manage payment settings like currency, test mode, and transaction options.

You want to provide a smooth checkout experience for your visitors.

Syntax

Wordpress

<?php
// Example: Adding a payment gateway in WooCommerce
add_filter('woocommerce_payment_gateways', 'add_custom_gateway');
function add_custom_gateway($gateways) {
    $gateways[] = 'WC_Gateway_Custom';
    return $gateways;
}

class WC_Gateway_Custom extends WC_Payment_Gateway {
    public function __construct() {
        $this->id = 'custom_gateway';
        $this->method_title = __('Custom Gateway', 'woocommerce');
        $this->has_fields = false;
        $this->init_form_fields();
        $this->init_settings();
        $this->title = $this->get_option('title');
        add_action('woocommerce_update_options_payment_gateways_' . $this->id, array($this, 'process_admin_options'));
    }

    public function init_form_fields() {
        $this->form_fields = array(
            'enabled' => array(
                'title' => __('Enable/Disable', 'woocommerce'),
                'type' => 'checkbox',
                'label' => __('Enable Custom Payment Gateway', 'woocommerce'),
                'default' => 'yes'
            ),
            'title' => array(
                'title' => __('Title', 'woocommerce'),
                'type' => 'text',
                'description' => __('This controls the title shown during checkout.', 'woocommerce'),
                'default' => __('Custom Payment', 'woocommerce'),
                'desc_tip' => true
            )
        );
    }

    public function process_payment($order_id) {
        $order = wc_get_order($order_id);
        $order->payment_complete();
        $order->reduce_order_stock();
        wc_add_notice(__('Payment received, thank you!', 'woocommerce'), 'success');
        return array(
            'result' => 'success',
            'redirect' => $this->get_return_url($order)
        );
    }
}

This example shows how to add a custom payment gateway in WooCommerce, a popular WordPress plugin.

You register the gateway, define settings, and handle payment processing.

Examples

Adds PayPal as a payment option in WooCommerce checkout.

Wordpress

<?php
// Enable PayPal gateway in WooCommerce
add_filter('woocommerce_payment_gateways', function($gateways) {
    $gateways[] = 'WC_Gateway_Paypal';
    return $gateways;
});

Defines the title shown to customers during checkout.

Wordpress

<?php
// Set payment gateway title
$this->form_fields = array(
    'title' => array(
        'title' => __('Title', 'woocommerce'),
        'type' => 'text',
        'default' => __('Credit Card', 'woocommerce')
    )
);

Sample Program

This plugin adds a simple custom payment gateway to WooCommerce. It shows a new payment option during checkout. When selected, it marks the order as paid immediately.

Wordpress

<?php
/**
 * Plugin Name: Simple Custom Payment Gateway
 * Description: Adds a simple custom payment gateway to WooCommerce.
 * Version: 1.0
 * Author: Your Name
 */

add_filter('woocommerce_payment_gateways', 'add_simple_custom_gateway');
function add_simple_custom_gateway($gateways) {
    $gateways[] = 'WC_Gateway_Simple_Custom';
    return $gateways;
}

class WC_Gateway_Simple_Custom extends WC_Payment_Gateway {
    public function __construct() {
        $this->id = 'simple_custom_gateway';
        $this->method_title = __('Simple Custom Gateway', 'woocommerce');
        $this->has_fields = false;
        $this->init_form_fields();
        $this->init_settings();
        $this->title = $this->get_option('title');
        add_action('woocommerce_update_options_payment_gateways_' . $this->id, array($this, 'process_admin_options'));
    }

    public function init_form_fields() {
        $this->form_fields = array(
            'enabled' => array(
                'title' => __('Enable/Disable', 'woocommerce'),
                'type' => 'checkbox',
                'label' => __('Enable Simple Custom Gateway', 'woocommerce'),
                'default' => 'yes'
            ),
            'title' => array(
                'title' => __('Title', 'woocommerce'),
                'type' => 'text',
                'description' => __('Title shown during checkout.', 'woocommerce'),
                'default' => __('Simple Custom Payment', 'woocommerce'),
                'desc_tip' => true
            )
        );
    }

    public function process_payment($order_id) {
        $order = wc_get_order($order_id);
        $order->payment_complete();
        $order->reduce_order_stock();
        wc_add_notice(__('Payment received, thank you!', 'woocommerce'), 'success');
        return array(
            'result' => 'success',
            'redirect' => $this->get_return_url($order)
        );
    }
}

Important Notes

Always test payment gateways in a safe test mode before going live.

Use HTTPS on your site to keep payment data secure.

Check WooCommerce documentation for updates on payment gateway development.

Summary

Payment gateway configuration connects your WordPress site to payment services.

It involves adding, enabling, and setting up gateways like PayPal or custom ones.

Proper setup ensures smooth and secure online payments for your customers.

Practice

1. What is the main purpose of configuring a payment gateway in a WordPress site?

easy

A. To allow customers to make payments securely on the website

B. To change the website's theme colors

C. To add new blog posts automatically

D. To improve website loading speed

Solution

1. Step 1: Understand what a payment gateway does

   A payment gateway connects the website to payment services to process payments.

2. Step 2: Identify the correct purpose in the options

   Only To allow customers to make payments securely on the website mentions secure payments, which matches the gateway's role.

3. Final Answer:

   To allow customers to make payments securely on the website -> Option A

4. Quick Check:

   Payment gateway = secure payments [OK]

Hint: Payment gateways handle payments, not design or content [OK]

Common Mistakes:

• Confusing payment gateway with website design features
• Thinking it manages blog posts
• Assuming it speeds up the site

2. Which code snippet correctly adds a new payment gateway class in WooCommerce for WordPress?

easy

A. add_filter('woocommerce_payment_gateways', 'add_my_gateway'); function add_my_gateway($gateways) { $gateways[] = 'WC_Gateway_MyGateway'; return $gateways; }

B. add_action('woocommerce_payment_gateways', 'add_my_gateway'); function add_my_gateway() { return 'WC_Gateway_MyGateway'; }

C. add_filter('woocommerce_payment_gateways', 'add_my_gateway'); function add_my_gateway() { return 'WC_Gateway_MyGateway'; }

D. add_action('woocommerce_payment_gateways', 'add_my_gateway'); function add_my_gateway($gateways) { $gateways[] = 'WC_Gateway_MyGateway'; }

Solution

1. Step 1: Identify correct WordPress hook type

   To modify gateways list, use add_filter, not add_action.

2. Step 2: Check function signature and return

   The function must accept $gateways array, add new gateway, and return the updated array.

3. Final Answer:

   add_filter with function adding to $gateways and returning it -> Option A

4. Quick Check:

   Filter modifies list and returns it [OK]

Hint: Use add_filter with $gateways parameter and return updated array [OK]

Common Mistakes:

• Using add_action instead of add_filter
• Not returning the updated gateways array
• Missing $gateways parameter in function

3. Given this code snippet in a WordPress plugin for WooCommerce payment gateway registration:

add_filter('woocommerce_payment_gateways', function($gateways) {
  $gateways[] = 'WC_Gateway_Custom';
  return $gateways;
});

What will happen after this code runs?

medium

A. Nothing changes because add_filter is used incorrectly

B. The payment gateways list will be replaced with only 'WC_Gateway_Custom'

C. An error will occur because the function does not return anything

D. The custom payment gateway 'WC_Gateway_Custom' will be added to the available gateways list

Solution

1. Step 1: Understand the add_filter usage

   The anonymous function receives $gateways array, adds a new gateway, and returns the updated array.

2. Step 2: Predict the effect on WooCommerce gateways

   The new gateway 'WC_Gateway_Custom' is appended, so it becomes available alongside existing gateways.

3. Final Answer:

   The custom payment gateway 'WC_Gateway_Custom' will be added to the available gateways list -> Option D

4. Quick Check:

   Appending gateway and returning list adds it [OK]

Hint: Returning updated gateways array adds new gateway [OK]

Common Mistakes:

• Thinking the list is replaced instead of appended
• Assuming no return means error
• Confusing add_filter with add_action

4. You wrote this code to add a payment gateway but it causes a fatal error:

add_filter('woocommerce_payment_gateways', 'add_gateway');
function add_gateway() {
  $gateways[] = 'WC_Gateway_New';
  return $gateways;
}

What is the main problem?

medium

A. The function should use add_action instead of add_filter

B. The function add_gateway does not accept the $gateways parameter

C. The gateway class name is incorrect

D. The function does not return anything

Solution

1. Step 1: Check function parameters for filter hook

   Filter functions must accept the value they modify, here $gateways array.

2. Step 2: Identify missing parameter causing error

   Function add_gateway() has no parameters, so $gateways is undefined inside, causing error.

3. Final Answer:

   The function add_gateway does not accept the $gateways parameter -> Option B

4. Quick Check:

   Filter function needs $gateways parameter [OK]

Hint: Filter functions must accept and return the filtered value [OK]

Common Mistakes:

• Omitting the parameter in the filter function
• Using add_action instead of add_filter
• Not returning the updated array

5. You want to configure a payment gateway in WooCommerce that only appears for customers from the US. Which approach correctly applies this condition in your gateway class?

hard

A. Use CSS to hide the payment option on the checkout page for non-US customers

B. Add a filter to remove the gateway from the list after checkout is complete

C. Override the is_available() method in your gateway class to check the customer's billing country and return true only if it is 'US'

D. Set the gateway to be enabled only in the WooCommerce settings without any code

Solution

1. Step 1: Understand how to conditionally show gateways

   WooCommerce gateways can override the is_available() method to control when they appear.

2. Step 2: Apply country check in is_available()

   Checking the customer's billing country inside is_available() and returning true only for 'US' ensures correct display.

3. Final Answer:

   Override is_available() to check billing country and return true only for 'US' -> Option C

4. Quick Check:

   Use is_available() for conditional gateway display [OK]

Hint: Use is_available() method to control gateway visibility by condition [OK]

Common Mistakes:

• Trying to hide gateway with CSS (not secure or reliable)
• Filtering gateways after checkout (too late)
• Only enabling gateway in settings without conditions