stripe_wc()
Returns the global instance of the WC_Stripe_Manager. This function replaces the wc_stripe function as of version 3.2.8
stripe_wc() : WC_Stripe_Manager
💥 TRENDING: Documentation/stripe/code - Full Archive
Documentation
Table of Contents
Packages
Namespaces
Classes
- WC_Payment_Gateway_Stripe_Local_Payment
- Local payment method classes should extend this abstract class
- WC_Payment_Gateway_Stripe
- WC_Payment_Token_Stripe
- WC_Stripe_Payment
- WC_Stripe_Rest_Controller
- WC_Stripe_Settings_API
- WC_Stripe_Admin_Assets
- WC_Stripe_Admin_Menus
- WC_Stripe_Admin_Product_Edit
- WC_Stripe_Admin_Settings
- WC_Stripe_Admin_Support
- WC_Stripe_Admin_User_Edit
- WC_Stripe_Admin_Welcome
- WC_Stripe_Admin_Order_Metaboxes
- WC_Stripe_Account_Settings
- Class WC_Stripe_Account_Settings
- WC_Stripe_Advanced_Settings
- WC_Stripe_API_Settings
- WC_Stripe_Manager
- Singleton class that handles plugin functionality like class loading.
- WC_Stripe_API_Operation
- Used as a wrapper for API requests to Stripe.
- WC_Stripe_API_Request_Filter
- WC_Stripe_Constants
- WC_Stripe_Customer_Manager
- Class that manages customer creation and custom updates.
- WC_Stripe_Field_Manager
- WC_Stripe_Frontend_Scripts
- Handles script enqueuement and output of params needed by the plugin.
- WC_Stripe_Gateway_Conversion
- WC_Stripe_Gateway
- Gateway class that abstracts all API calls to Stripe.
- WC_Stripe_Install
- WC_Stripe_Payment_Balance
- WC_Stripe_Payment_Charge_Local
- WC_Stripe_Payment_Charge
- WC_Stripe_Payment_Factory
- WC_Stripe_Payment_Intent
- WC_Stripe_Product_Gateway_Option
- WC_Stripe_Redirect_Handler
- WC_Stripe_Rest_API
- WC_Stripe_Shortcodes
- Class WC_Stripe_Shortcodes
- WC_Stripe_Update
- WC_Stripe_Utils
- 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_Product_Data
- WC_Stripe_Controller_Source
- Controller class that perfors cart operations for client side requests.
- WC_Stripe_Controller_Webhook
- WC_Payment_Gateway_Stripe_ACH
- Gateway that processes ACH payments.
- WC_Payment_Gateway_Stripe_Affirm
- Local payment method classes should extend this abstract class
- WC_Payment_Gateway_Stripe_Afterpay
- Class WC_Payment_Gateway_Stripe_Afterpay
- WC_Payment_Gateway_Stripe_Alipay
- Local payment method classes should extend this abstract class
- WC_Payment_Gateway_Stripe_AmazonPay
- Local payment method classes should extend this abstract class
- WC_Payment_Gateway_Stripe_ApplePay
- WC_Payment_Gateway_Stripe_Bancontact
- Local payment method classes should extend this abstract class
- WC_Payment_Gateway_Stripe_BECS
- Class WC_Payment_Gateway_Stripe_Becs
- WC_Payment_Gateway_Stripe_BLIK
- Local payment method classes should extend this abstract class
- WC_Payment_Gateway_Stripe_Boleto
- Local payment method classes should extend this abstract class
- WC_Payment_Gateway_Stripe_CashApp
- Local payment method classes should extend this abstract class
- WC_Payment_Gateway_Stripe_CC
- WC_Payment_Gateway_Stripe_EPS
- Local payment method classes should extend this abstract class
- WC_Payment_Gateway_Stripe_FPX
- Local payment method classes should extend this abstract class
- WC_Payment_Gateway_Stripe_Giropay
- Local payment method classes should extend this abstract class
- WC_Payment_Gateway_Stripe_GooglePay
- WC_Payment_Gateway_Stripe_GrabPay
- Local payment method classes should extend this abstract class
- WC_Payment_Gateway_Stripe_Ideal
- Local payment method classes should extend this abstract class
- WC_Payment_Gateway_Stripe_Klarna
- Class WC_Payment_Gateway_Stripe_Klarna
- WC_Payment_Gateway_Stripe_Konbini
- Local payment method classes should extend this abstract class
- WC_Payment_Gateway_Stripe_Link
- WC_Payment_Gateway_Stripe_MobilePay
- Local payment method classes should extend this abstract class
- WC_Payment_Gateway_Stripe_Multibanco
- Local payment method classes should extend this abstract class
- WC_Payment_Gateway_Stripe_OXXO
- Local payment method classes should extend this abstract class
- WC_Payment_Gateway_Stripe_P24
- Local payment method classes should extend this abstract class
- WC_Payment_Gateway_Stripe_PayByBank
- Local payment method classes should extend this abstract class
- WC_Payment_Gateway_Stripe_Payment_Request
- This gateway is provided so merchants can accept Chrome Payments, Microsoft Pay, etc.
- WC_Payment_Gateway_Stripe_PayNow
- Local payment method classes should extend this abstract class
- WC_Payment_Gateway_Stripe_PromptPay
- Local payment method classes should extend this abstract class
- WC_Payment_Gateway_Stripe_Revolut
- Local payment method classes should extend this abstract class
- WC_Payment_Gateway_Stripe_Sepa
- Local payment method classes should extend this abstract class
- WC_Payment_Gateway_Stripe_Sofort
- Local payment method classes should extend this abstract class
- WC_Payment_Gateway_Stripe_Swish
- Local payment method classes should extend this abstract class
- WC_Payment_Gateway_Stripe_Twint
- Local payment method classes should extend this abstract class
- WC_Payment_Gateway_Stripe_UPM
- WC_Payment_Gateway_Stripe_WeChat
- Local payment method classes should extend this abstract class
- WC_Payment_Gateway_Stripe_Zip
- Local payment method classes should extend this abstract class
- WC_Stripe_Shortcode_Payment_Buttons
- Class WC_Stripe_Shortcode_Payment_Buttons
- WC_Payment_Token_Stripe_ACH
- WC_Payment_Token_Stripe_ApplePay
- WC_Payment_Token_Stripe_Becs
- WC_Payment_Token_Stripe_CC
- WC_Payment_Token_Stripe_GooglePay
- WC_Payment_Token_Stripe_Local
- WC_Payment_Token_Stripe_Sepa
Traits
- WC_Stripe_Controller_Cart_Trait
- WC_Stripe_Controller_Frontend_Trait
- Trait WC_Stripe_Controller_Frontend_Trait
- WC_Payment_Token_Source_Trait
- WC_Payment_Token_Payment_Method_Trait
- WC_Stripe_Payment_Intent_Trait
- WC_Stripe_Payment_Charge_Trait
- WC_Stripe_Local_Payment_Charge_Trait
- WC_Stripe_Local_Payment_Intent_Trait
- WC_Stripe_Voucher_Payment_Trait
- WC_Stripe_Express_Payment_Trait
- WC_Stripe_Settings_Trait
Functions
- stripe_wc() : WC_Stripe_Manager
- Returns the global instance of the WC_Stripe_Manager. This function replaces the wc_stripe function as of version 3.2.8
- wc_stripe_get_template() : mixed
- wc_stripe_get_template_html() : string
- Wrapper for wc_get_template_html that returns Stripe specififc templates in an html string.
- wcs_stripe_active() : bool
- Return true if WCS is active.
- wc_stripe_token_field() : mixed
- wc_stripe_payment_intent_field() : mixed
- wc_stripe_hidden_field() : mixed
- wc_stripe_mode() : string
- Return the mode for the plugin.
- wc_stripe_test_mode() : mixed
- wc_stripe_get_secret_key() : mixed
- Return the secret key for the provided mode.
- wc_stripe_get_publishable_key() : mixed
- Return the publishable key for the provided mode.
- wc_stripe_get_account_id() : string
- Return the merchant's Stripe account.
- wc_stripe_get_customer_id() : mixed
- Return the stripe customer ID
- wc_stripe_save_customer() : mixed
- wc_stripe_delete_customer() : mixed
- wc_stripe_woocommerce_payment_token_deleted() : mixed
- wc_stripe_log() : mixed
- Log the provided message in the WC logs directory.
- wc_stripe_log_error() : mixed
- wc_stripe_log_info() : mixed
- wc_stripe_order_mode() : mixed
- Return the mode that the order was created in.
- wc_stripe_payment_gateways() : mixed
- wc_stripe_get_payment_gateways() : array<string|int, WC_Payment_Gateway_Stripe>
- wc_stripe_order_cancelled() : mixed
- Cancel the Stripe charge
- wc_stripe_order_status_completed() : mixed
- wc_stripe_update_customer_location() : mixed
- wc_stripe_update_shipping_methods() : mixed
- wc_stripe_shipping_address_serviceable() : bool
- Return true if there are shipping packages that contain rates.
- wc_stripe_get_display_items() : mixed
- wc_stripe_get_shipping_options() : mixed
- wc_stripe_set_checkout_error() : mixed
- wc_stripe_output_checkout_error() : mixed
- wc_stripe_add_allowed_html() : mixed
- wc_stripe_process_shop_subscription_meta() : mixed
- Save WCS meta data when it's changed in the admin section.
- wc_stripe_available_payment_gateways() : mixed
- Filter the WC payment gateways based on criteria specific to Stripe functionality.
- wc_stripe_get_local_payment_params() : array<string|int, mixed>
- wc_stripe_get_available_local_gateways() : array<string|int, WC_Payment_Gateway>
- wc_stripe_set_idempotency_key() : mixed
- wc_stripe_get_idempotency_key() : mixed
- wc_stripe_api_options() : array<string|int, mixed>
- wc_stripe_payment_complete_order_status() : mixed
- wc_stripe_add_number_precision() : number
- Converts the amount to cents.
- wc_stripe_remove_number_precision() : mixed
- Remove precision from a number.
- wc_stripe_get_custom_forms() : mixed
- Return an array of credit card forms.
- wc_stripe_order_has_shipping_address() : mixed
- wc_stripe_display_prices_including_tax() : mixed
- wc_stripe_pre_orders_active() : mixed
- Return true if the WC pre-orders plugin is active
- wc_stripe_get_order_from_source_id() : mixed
- wc_stripe_get_order_from_transaction() : WC_Order|WC_Refund|bool|WC_Order_Refund
- wc_stripe_stash_cart() : mixed
- Stash the WC cart contents in the session and empty it's contents.
- wc_stripe_stash_product_cart() : mixed
- wc_stripe_restore_cart() : mixed
- wc_stripe_restore_cart_after_product_checkout() : mixed
- wc_stripe_get_customer_payment_tokens() : array<string|int, WC_Payment_Token>
- wc_stripe_credit_card_labels() : string
- wc_stripe_get_error_messages() : mixed
- Return an array of Stripe error messages.
- wc_stripe_get_currencies() : mixed
- Return an array of Stripe currencies where the value of each currency is the curency multiplier.
- wc_stripe_filter_order_id() : mixed
- Function that triggers a filter on the order id.
- wc_stripe_remove_order_locks() : mixed
- Removes order locks that have expired so the options table does not get cluttered with transients.
- wc_stripe_get_checkout_fields() : array<string|int, mixed>
- Returns an array of checkout fields needed to complete an order.
- wc_stripe_filter_address_state() : string
- Filters a state value, making sure the abbreviated state value recognized by WC is returned.
- wc_stripe_get_current_page() : mixed
- wc_stripe_get_site_locale() : mixed|void
- wc_stripe_is_processing_webhook() : bool
- wc_stripe_process_source_chargeable() : mixed
- Processes the charge via webhooks for local payment methods like P24, EPS, etc.
- wc_stripe_process_charge_succeeded() : mixed
- When the charge has succeeded, the order should be completed.
- wc_stripe_process_payment_intent_succeeded() : mixed
- wc_stripe_process_charge_failed() : mixed
- wc_stripe_process_create_refund() : mixed
- 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_retry_source_chargeable() : mixed
- wc_stripe_charge_dispute_created() : mixed
- wc_stripe_charge_dispute_closed() : mixed
- wc_stripe_review_opened() : mixed
- wc_stripe_review_closed() : mixed
- wc_stripe_process_requires_action() : mixed
- wc_stripe_process_charge_pending() : mixed
Functions
wc_stripe_get_template()
wc_stripe_get_template(string $template_name[, array<string|int, mixed> $args = array() ]) : mixed
Parameters
- $template_name : string
- $args : array<string|int, mixed> = array()
Tags
wc_stripe_get_template_html()
Wrapper for wc_get_template_html that returns Stripe specififc templates in an html string.
wc_stripe_get_template_html(string $template_name[, array<string|int, mixed> $args = array() ]) : string
Parameters
- $template_name : string
- $args : array<string|int, mixed> = array()
Tags
Return values
stringwcs_stripe_active()
Return true if WCS is active.
wcs_stripe_active() : bool
Return values
boolwc_stripe_token_field()
wc_stripe_token_field(WC_Payment_Gateway_Stripe $gateway) : mixed
Parameters
- $gateway : WC_Payment_Gateway_Stripe
wc_stripe_payment_intent_field()
wc_stripe_payment_intent_field(WC_Payment_Gateway_Stripe $gateway) : mixed
Parameters
- $gateway : WC_Payment_Gateway_Stripe
wc_stripe_hidden_field()
wc_stripe_hidden_field(string $id[, string $class = '' ][, string $value = '' ]) : mixed
Parameters
- $id : string
- $class : string = ''
- $value : string = ''
wc_stripe_mode()
Return the mode for the plugin.
wc_stripe_mode() : string
Return values
stringwc_stripe_test_mode()
wc_stripe_test_mode() : mixed
wc_stripe_get_secret_key()
Return the secret key for the provided mode.
wc_stripe_get_secret_key([string $mode = '' ]) : mixed
If no mode given, the key for the active mode is returned.
Parameters
- $mode : string = ''
Tags
wc_stripe_get_publishable_key()
Return the publishable key for the provided mode.
wc_stripe_get_publishable_key([string $mode = '' ]) : mixed
If no mode given, the key for the active mode is returned.
Parameters
- $mode : string = ''
Tags
wc_stripe_get_account_id()
Return the merchant's Stripe account.
wc_stripe_get_account_id() : string
Tags
Return values
stringwc_stripe_get_customer_id()
Return the stripe customer ID
wc_stripe_get_customer_id([int $user_id = '' ][, string $mode = '' ]) : mixed
Parameters
- $user_id : int = ''
- $mode : string = ''
Tags
wc_stripe_save_customer()
wc_stripe_save_customer(string $customer_id, int $user_id[, string $mode = '' ]) : mixed
Parameters
- $customer_id : string
- $user_id : int
- $mode : string = ''
wc_stripe_delete_customer()
wc_stripe_delete_customer(int $user_id[, string $mode = '' ][, bool $global = false ]) : mixed
Parameters
- $user_id : int
- $mode : string = ''
- $global : bool = false
Tags
wc_stripe_woocommerce_payment_token_deleted()
wc_stripe_woocommerce_payment_token_deleted(int $token_id, WC_Payment_Token $token) : mixed
Parameters
- $token_id : int
- $token : WC_Payment_Token
Tags
wc_stripe_log()
Log the provided message in the WC logs directory.
wc_stripe_log(int $level, string $message) : mixed
Parameters
- $level : int
- $message : string
Tags
wc_stripe_log_error()
wc_stripe_log_error(string $message) : mixed
Parameters
- $message : string
Tags
wc_stripe_log_info()
wc_stripe_log_info(string $message) : mixed
Parameters
- $message : string
Tags
wc_stripe_order_mode()
Return the mode that the order was created in.
wc_stripe_order_mode(WC_Order|int $order) : mixed
Values can be live or test
Parameters
- $order : WC_Order|int
Tags
wc_stripe_payment_gateways()
wc_stripe_payment_gateways(array<string|int, mixed> $gateways) : mixed
Parameters
- $gateways : array<string|int, mixed>