PaymentGatewayInterface
in
Tags
Table of Contents
- getDescription() : string
- getFields() : array<string|int, mixed>
- getFrontendData() : array<string|int, mixed>
- getId() : string
- getMode() : string
- getName() : string
- getPublicName() : string
- isActive() : bool
- isEnabled() : bool
- isInternal() : bool
- isOnlinePayment() : bool
- isSandbox() : bool
- isSupportsSandbox() : bool
- printBillingFields() : mixed
- processPayment() : bool|WP_Error
Methods
getDescription()
public
getDescription() : string
Tags
Return values
string —getFields()
public
getFields() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —Raw field args.
getFrontendData()
public
getFrontendData() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —All additional data, required for a gateway to function properly on the frontend.
getId()
public
getId() : string
Tags
Return values
string —Unprefixed payment gateway ID.
getMode()
public
getMode() : string
Tags
Return values
string —'live'|'sandbox'
getName()
public
getName() : string
Tags
Return values
string —Gateway name / label.
getPublicName()
public
getPublicName() : string
Tags
Return values
string —isActive()
public
isActive() : bool
Tags
Return values
bool —Whether the item is enabled and supports current plugin settings (like currency for payment gateways).
isEnabled()
public
isEnabled() : bool
Tags
Return values
bool —isInternal()
public
isInternal() : bool
Tags
Return values
bool —If true, then don't show this payment gateway on the settings page.
isOnlinePayment()
public
isOnlinePayment() : bool
Tags
Return values
bool —isSandbox()
public
isSandbox() : bool
Tags
Return values
bool —Is sandbox enabled.
isSupportsSandbox()
public
isSupportsSandbox() : bool
Tags
Return values
bool —printBillingFields()
public
printBillingFields() : mixed
Tags
Return values
mixed —processPayment()
public
processPayment(Payment $payment, array<string|int, mixed> $args) : bool|WP_Error
Parameters
- $payment : Payment
- $args : array<string|int, mixed>
-
@param Booking $args['booking']