• Namespace
  • Class
  • Tree
  • Deprecated
  • Hook Reference

Namespaces

  • None
  • PaymentPlugins

Classes

  • WC_Payment_Gateway_Stripe
  • WC_Payment_Gateway_Stripe_ACH
  • WC_Payment_Gateway_Stripe_Afterpay
  • WC_Payment_Gateway_Stripe_Alipay
  • WC_Payment_Gateway_Stripe_ApplePay
  • WC_Payment_Gateway_Stripe_Bancontact
  • WC_Payment_Gateway_Stripe_BECS
  • WC_Payment_Gateway_Stripe_Boleto
  • WC_Payment_Gateway_Stripe_CC
  • WC_Payment_Gateway_Stripe_EPS
  • WC_Payment_Gateway_Stripe_FPX
  • WC_Payment_Gateway_Stripe_Giropay
  • WC_Payment_Gateway_Stripe_GooglePay
  • WC_Payment_Gateway_Stripe_GrabPay
  • WC_Payment_Gateway_Stripe_Ideal
  • WC_Payment_Gateway_Stripe_Klarna
  • WC_Payment_Gateway_Stripe_Local_Payment
  • WC_Payment_Gateway_Stripe_Multibanco
  • WC_Payment_Gateway_Stripe_OXXO
  • WC_Payment_Gateway_Stripe_P24
  • WC_Payment_Gateway_Stripe_Payment_Request
  • WC_Payment_Gateway_Stripe_Sepa
  • WC_Payment_Gateway_Stripe_Sofort
  • WC_Payment_Gateway_Stripe_WeChat
  • WC_Payment_Token_Stripe
  • WC_Payment_Token_Stripe_ACH
  • WC_Payment_Token_Stripe_ApplePay
  • WC_Payment_Token_Stripe_CC
  • WC_Payment_Token_Stripe_GooglePay
  • WC_Payment_Token_Stripe_Local
  • WC_Payment_Token_Stripe_Sepa
  • WC_Stripe_Account_Settings
  • WC_Stripe_Admin_Assets
  • WC_Stripe_Admin_Menus
  • WC_Stripe_Admin_Order_Metaboxes
  • WC_Stripe_Admin_Settings
  • WC_Stripe_Admin_User_Edit
  • WC_Stripe_Advanced_Settings
  • WC_Stripe_API_Operation
  • WC_Stripe_API_Request_Filter
  • WC_Stripe_API_Settings
  • WC_Stripe_Constants
  • WC_Stripe_Controller_Cart
  • WC_Stripe_Controller_Checkout
  • WC_Stripe_Controller_Gateway_Settings
  • WC_Stripe_Controller_GooglePay
  • WC_Stripe_Controller_Order_Actions
  • WC_Stripe_Controller_Payment_Intent
  • WC_Stripe_Controller_Payment_Method
  • WC_Stripe_Controller_Plaid
  • WC_Stripe_Controller_Product_Data
  • WC_Stripe_Controller_Source
  • WC_Stripe_Controller_Webhook
  • WC_Stripe_Customer_Manager
  • WC_Stripe_Field_Manager
  • WC_Stripe_Frontend_Scripts
  • WC_Stripe_Gateway
  • WC_Stripe_Gateway_Conversion
  • WC_Stripe_Install
  • WC_Stripe_Manager
  • WC_Stripe_Payment
  • WC_Stripe_Payment_Balance
  • WC_Stripe_Payment_Charge
  • WC_Stripe_Payment_Charge_Local
  • WC_Stripe_Payment_Factory
  • WC_Stripe_Payment_Intent
  • WC_Stripe_Product_Gateway_Option
  • WC_Stripe_Product_Option
  • WC_Stripe_Redirect_Handler
  • WC_Stripe_Rest_API
  • WC_Stripe_Rest_Controller
  • WC_Stripe_Settings_API
  • WC_Stripe_Shortcode_Payment_Buttons
  • WC_Stripe_Shortcodes
  • WC_Stripe_Update
  • WC_Stripe_Utils

Traits

  • WC_Payment_Token_Payment_Method_Trait
  • WC_Payment_Token_Source_Trait
  • WC_Stripe_Controller_Cart_Trait
  • WC_Stripe_Controller_Frontend_Trait
  • WC_Stripe_Local_Payment_Charge_Trait
  • WC_Stripe_Local_Payment_Intent_Trait
  • WC_Stripe_Payment_Charge_Trait
  • WC_Stripe_Payment_Intent_Trait
  • WC_Stripe_Settings_Trait

Functions

  • stripe_wc
  • wc_stripe_add_allowed_html
  • wc_stripe_add_number_precision
  • wc_stripe_api_options
  • wc_stripe_available_payment_gateways
  • wc_stripe_charge_dispute_closed
  • wc_stripe_charge_dispute_created
  • wc_stripe_credit_card_labels
  • wc_stripe_delete_customer
  • wc_stripe_display_prices_including_tax
  • wc_stripe_filter_address_state
  • wc_stripe_filter_order_id
  • wc_stripe_get_account_id
  • wc_stripe_get_available_local_gateways
  • wc_stripe_get_checkout_fields
  • wc_stripe_get_currencies
  • wc_stripe_get_current_page
  • wc_stripe_get_custom_forms
  • wc_stripe_get_customer_id
  • wc_stripe_get_customer_payment_tokens
  • wc_stripe_get_display_items
  • wc_stripe_get_error_messages
  • wc_stripe_get_idempotency_key
  • wc_stripe_get_local_payment_params
  • wc_stripe_get_order_from_source_id
  • wc_stripe_get_order_from_transaction
  • wc_stripe_get_publishable_key
  • wc_stripe_get_secret_key
  • wc_stripe_get_shipping_options
  • wc_stripe_get_site_locale
  • wc_stripe_get_template
  • wc_stripe_get_template_html
  • wc_stripe_hidden_field
  • wc_stripe_log
  • wc_stripe_log_error
  • wc_stripe_log_info
  • wc_stripe_mode
  • wc_stripe_order_cancelled
  • wc_stripe_order_has_shipping_address
  • wc_stripe_order_mode
  • wc_stripe_order_status_completed
  • wc_stripe_output_checkout_error
  • wc_stripe_payment_complete_order_status
  • wc_stripe_payment_gateways
  • wc_stripe_payment_intent_field
  • wc_stripe_pre_orders_active
  • wc_stripe_process_charge_failed
  • wc_stripe_process_charge_succeeded
  • wc_stripe_process_create_refund
  • wc_stripe_process_payment_intent_succeeded
  • wc_stripe_process_shop_subscription_meta
  • wc_stripe_process_source_chargeable
  • wc_stripe_remove_number_precision
  • wc_stripe_remove_order_locks
  • wc_stripe_restore_cart
  • wc_stripe_restore_cart_after_product_checkout
  • wc_stripe_retry_source_chargeable
  • wc_stripe_review_closed
  • wc_stripe_review_opened
  • wc_stripe_save_customer
  • wc_stripe_set_checkout_error
  • wc_stripe_set_idempotency_key
  • wc_stripe_shipping_address_serviceable
  • wc_stripe_stash_cart
  • wc_stripe_stash_product_cart
  • wc_stripe_token_field
  • wc_stripe_update_customer_location
  • wc_stripe_update_option_3_3_13
  • wc_stripe_update_shipping_methods
  • wc_stripe_woocommerce_payment_token_deleted
  • wcs_stripe_active

No namespace

Classes summary

WC_Payment_Gateway_Stripe
WC_Payment_Gateway_Stripe_ACH

Gateway that processes ACH payments. Only available for U.S. based merchants at this time.

WC_Payment_Gateway_Stripe_Afterpay Class WC_Payment_Gateway_Stripe_Afterpay
WC_Payment_Gateway_Stripe_Alipay
WC_Payment_Gateway_Stripe_ApplePay
WC_Payment_Gateway_Stripe_Bancontact
WC_Payment_Gateway_Stripe_BECS Class WC_Payment_Gateway_Stripe_Becs
WC_Payment_Gateway_Stripe_Boleto
WC_Payment_Gateway_Stripe_CC
WC_Payment_Gateway_Stripe_EPS
WC_Payment_Gateway_Stripe_FPX
WC_Payment_Gateway_Stripe_Giropay
WC_Payment_Gateway_Stripe_GooglePay
WC_Payment_Gateway_Stripe_GrabPay
WC_Payment_Gateway_Stripe_Ideal
WC_Payment_Gateway_Stripe_Klarna Class WC_Payment_Gateway_Stripe_Klarna
WC_Payment_Gateway_Stripe_Local_Payment Local payment method classes should extend this abstract class
WC_Payment_Gateway_Stripe_Multibanco
WC_Payment_Gateway_Stripe_OXXO
WC_Payment_Gateway_Stripe_P24
WC_Payment_Gateway_Stripe_Payment_Request This gateway is provided so merchants can accept Chrome Payments, Microsoft Pay, etc.
WC_Payment_Gateway_Stripe_Sepa
WC_Payment_Gateway_Stripe_Sofort
WC_Payment_Gateway_Stripe_WeChat
WC_Payment_Token_Stripe
WC_Payment_Token_Stripe_ACH
WC_Payment_Token_Stripe_ApplePay
WC_Payment_Token_Stripe_CC
WC_Payment_Token_Stripe_GooglePay
WC_Payment_Token_Stripe_Local
WC_Payment_Token_Stripe_Sepa
WC_Stripe_Account_Settings Class WC_Stripe_Account_Settings
WC_Stripe_Admin_Assets
WC_Stripe_Admin_Menus
WC_Stripe_Admin_Order_Metaboxes
WC_Stripe_Admin_Settings
WC_Stripe_Admin_User_Edit
WC_Stripe_Advanced_Settings
WC_Stripe_API_Operation

Used as a wrapper for API requests to Stripe. Allows method chaining so things like mode can be set intuitively.

WC_Stripe_API_Request_Filter
WC_Stripe_API_Settings
WC_Stripe_Constants
WC_Stripe_Controller_Cart Controller class that perfors cart operations for client side requests.
WC_Stripe_Controller_Checkout
WC_Stripe_Controller_Gateway_Settings
WC_Stripe_Controller_GooglePay
WC_Stripe_Controller_Order_Actions
WC_Stripe_Controller_Payment_Intent Controller which handles Payment Intent related actions such as creation.
WC_Stripe_Controller_Payment_Method
WC_Stripe_Controller_Plaid
WC_Stripe_Controller_Product_Data
WC_Stripe_Controller_Source Controller class that perfors cart operations for client side requests.
WC_Stripe_Controller_Webhook
WC_Stripe_Customer_Manager Class that manages customer creation and custom updates.
WC_Stripe_Field_Manager
WC_Stripe_Frontend_Scripts Handles scrip enqueuement and output of params needed by the plugin.
WC_Stripe_Gateway Gateway class that abstracts all API calls to Stripe.
WC_Stripe_Gateway_Conversion
WC_Stripe_Install
WC_Stripe_Manager Singleton class that handles plugin functionality like class loading.
WC_Stripe_Payment
WC_Stripe_Payment_Balance
WC_Stripe_Payment_Charge
WC_Stripe_Payment_Charge_Local
WC_Stripe_Payment_Factory
WC_Stripe_Payment_Intent
WC_Stripe_Product_Gateway_Option
WC_Stripe_Product_Option
WC_Stripe_Redirect_Handler
WC_Stripe_Rest_API
WC_Stripe_Rest_Controller
WC_Stripe_Settings_API
WC_Stripe_Shortcode_Payment_Buttons Class WC_Stripe_Shortcode_Payment_Buttons
WC_Stripe_Shortcodes Class WC_Stripe_Shortcodes
WC_Stripe_Update
WC_Stripe_Utils

Traits summary

WC_Payment_Token_Payment_Method_Trait
WC_Payment_Token_Source_Trait
WC_Stripe_Controller_Cart_Trait
WC_Stripe_Controller_Frontend_Trait Trait WC_Stripe_Controller_Frontend_Trait
WC_Stripe_Local_Payment_Charge_Trait
WC_Stripe_Local_Payment_Intent_Trait
WC_Stripe_Payment_Charge_Trait
WC_Stripe_Payment_Intent_Trait
WC_Stripe_Settings_Trait

Functions summary

stripe_wc

Returns the global instance of the WC_Stripe_Manager. This function replaces the wc_stripe function as of version 3.2.8

wc_stripe_add_allowed_html
wc_stripe_add_number_precision

Converts the amount to cents. Stripe processes all requests in cents.

wc_stripe_api_options
wc_stripe_available_payment_gateways Filter the WC payment gateways based on criteria specific to Stripe functionality.
wc_stripe_charge_dispute_closed
wc_stripe_charge_dispute_created
wc_stripe_credit_card_labels
wc_stripe_delete_customer
wc_stripe_display_prices_including_tax
wc_stripe_filter_address_state

Filters a state value, making sure the abbreviated state value recognized by WC is returned. Example: Texas = TX

wc_stripe_filter_order_id

Function that triggers a filter on the order id. Allows 3rd parties to convert the order_id from the metadata of the Stripe object.

wc_stripe_get_account_id Return the merchant's Stripe account.
wc_stripe_get_available_local_gateways
wc_stripe_get_checkout_fields Returns an array of checkout fields needed to complete an order.
wc_stripe_get_currencies

Return an array of Stripe currencies where the value of each currency is the curency multiplier.

wc_stripe_get_current_page
wc_stripe_get_custom_forms Return an array of credit card forms.
wc_stripe_get_customer_id Return the stripe customer ID
wc_stripe_get_customer_payment_tokens
wc_stripe_get_display_items
wc_stripe_get_error_messages Return an array of Stripe error messages.
wc_stripe_get_idempotency_key
wc_stripe_get_local_payment_params
wc_stripe_get_order_from_source_id
wc_stripe_get_order_from_transaction
wc_stripe_get_publishable_key

Return the publishable key for the provided mode. If no mode given, the key for the active mode is returned.

wc_stripe_get_secret_key

Return the secret key for the provided mode. If no mode given, the key for the active mode is returned.

wc_stripe_get_shipping_options
wc_stripe_get_site_locale
wc_stripe_get_template
wc_stripe_get_template_html
wc_stripe_hidden_field
wc_stripe_log Log the provided message in the WC logs directory.
wc_stripe_log_error
wc_stripe_log_info
wc_stripe_mode Return the mode for the plugin.
wc_stripe_order_cancelled Cancel the Stripe charge
wc_stripe_order_has_shipping_address
wc_stripe_order_mode

Return the mode that the order was created in. Values can be live or test

wc_stripe_order_status_completed
wc_stripe_output_checkout_error
wc_stripe_payment_complete_order_status
wc_stripe_payment_gateways
wc_stripe_payment_intent_field
wc_stripe_pre_orders_active Return true if the WC pre-orders plugin is active
wc_stripe_process_charge_failed
wc_stripe_process_charge_succeeded When the charge has succeeded, the order should be completed.
wc_stripe_process_create_refund

Function that processes the charge.refund webhook. If the refund is created in the Stripe dashboard, a refund will be created in the WC system to keep WC and Stripe in sync.

wc_stripe_process_payment_intent_succeeded
wc_stripe_process_shop_subscription_meta

Save WCS meta data when it's changed in the admin section. By default WCS saves the payment method title as the gateway title. This method saves the payment method title in a human readable format suitable for the frontend.

wc_stripe_process_source_chargeable Processes the charge via webhooks for local payment methods like P24, EPS, etc.
wc_stripe_remove_number_precision Remove precision from a number.
wc_stripe_remove_order_locks Removes order locks that have expired so the options table does not get cluttered with transients.
wc_stripe_restore_cart
wc_stripe_restore_cart_after_product_checkout
wc_stripe_retry_source_chargeable
wc_stripe_review_closed
wc_stripe_review_opened
wc_stripe_save_customer
wc_stripe_set_checkout_error
wc_stripe_set_idempotency_key
wc_stripe_shipping_address_serviceable Return true if there are shipping packages that contain rates.
wc_stripe_stash_cart

Stash the WC cart contents in the session and empty it's contents. If $product_cart is true, add the stashed product(s) to the cart.

wc_stripe_stash_product_cart
wc_stripe_token_field
wc_stripe_update_customer_location
wc_stripe_update_option_3_3_13
wc_stripe_update_shipping_methods
wc_stripe_woocommerce_payment_token_deleted
wcs_stripe_active Return true if WCS is active.
Stripe API documentation generated by ApiGen