WooCommerce Code Reference

WC_Payment_Gateways

Payment gateways class.

Table of Contents

$payment_gateways  : array<string|int, mixed>
Payment gateway classes.
$_instance  : WC_Payment_Gateways
The single instance of the class.
__clone()  : mixed
Cloning is forbidden.
__construct()  : mixed
Initialize payment gateways.
__wakeup()  : mixed
Unserializing instances of this class is forbidden.
get_available_payment_gateways()  : array<string|int, mixed>
Get available gateways.
get_payment_gateway_ids()  : array<string|int, mixed>
Get array of registered gateway ids
init()  : mixed
Load gateways and hook in functions.
instance()  : WC_Payment_Gateways
Main WC_Payment_Gateways Instance.
payment_gateways()  : array<string|int, mixed>
Get gateways.
process_admin_options()  : mixed
Save options in admin.
set_current_gateway()  : mixed
Set the current, active gateway.
filter_valid_gateway_class()  : bool
Callback for array filter. Returns true if gateway is of correct type.
should_load_paypal_standard()  : bool
Determines if PayPal Standard should be loaded.

Properties

Methods

get_available_payment_gateways()

Get available gateways.

public get_available_payment_gateways() : array<string|int, mixed>
Return values
array<string|int, mixed>

get_payment_gateway_ids()

Get array of registered gateway ids

public get_payment_gateway_ids() : array<string|int, mixed>
Tags
since
2.6.0
Return values
array<string|int, mixed>of strings

set_current_gateway()

Set the current, active gateway.

public set_current_gateway(array<string|int, mixed> $gateways) : mixed
Parameters
$gateways : array<string|int, mixed>

Available payment gateways.

Return values
mixed

filter_valid_gateway_class()

Callback for array filter. Returns true if gateway is of correct type.

protected filter_valid_gateway_class(object $gateway) : bool
Parameters
$gateway : object

Gateway to check.

Tags
since
3.6.0
Return values
bool

should_load_paypal_standard()

Determines if PayPal Standard should be loaded.

protected should_load_paypal_standard() : bool
Tags
since
5.5.0
Return values
boolWhether PayPal Standard should be loaded or not.