<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Integrations\Stripe;

[2] Fix | Delete

[3] Fix | Delete

/**

[4] Fix | Delete

* Stripe related helper methods.

[5] Fix | Delete

*

[6] Fix | Delete

* @since 1.8.2

[7] Fix | Delete

*/

[8] Fix | Delete

class Helpers {

[9] Fix | Delete

[10] Fix | Delete

/**

[11] Fix | Delete

* Stripe connection modes.

[12] Fix | Delete

*

[13] Fix | Delete

* @since 1.8.2

[14] Fix | Delete

*/

[15] Fix | Delete

const CONNECTION_MODES = [ 'live', 'test' ];

[16] Fix | Delete

[17] Fix | Delete

/**

[18] Fix | Delete

* Get field slug.

[19] Fix | Delete

*

[20] Fix | Delete

* @since 1.8.2

[21] Fix | Delete

*

[22] Fix | Delete

* @return string

[23] Fix | Delete

*/

[24] Fix | Delete

public static function get_field_slug() {

[25] Fix | Delete

[26] Fix | Delete

return self::is_pro() ? wpforms_stripe()->api->get_config( 'field_slug' ) : 'stripe-credit-card';

[27] Fix | Delete

}

[28] Fix | Delete

[29] Fix | Delete

/**

[30] Fix | Delete

* Determine whether the Stripe field is in the form.

[31] Fix | Delete

*

[32] Fix | Delete

* @since 1.8.2

[33] Fix | Delete

*

[34] Fix | Delete

* @param array $forms Form data (e.g. forms on a current page).

[35] Fix | Delete

* @param bool $multiple Must be 'true' if $forms contain multiple forms.

[36] Fix | Delete

*

[37] Fix | Delete

* @return bool

[38] Fix | Delete

*/

[39] Fix | Delete

public static function has_stripe_field( $forms, $multiple = false ) {

[40] Fix | Delete

[41] Fix | Delete

$slug = self::get_field_slug();

[42] Fix | Delete

[43] Fix | Delete

if ( empty( $slug ) ) {

[44] Fix | Delete

return false;

[45] Fix | Delete

}

[46] Fix | Delete

[47] Fix | Delete

return wpforms_has_field_type( $slug, $forms, $multiple ) !== false;

[48] Fix | Delete

}

[49] Fix | Delete

[50] Fix | Delete

/**

[51] Fix | Delete

* Determine whether the Stripe is enabled in forms used on the page.

[52] Fix | Delete

*

[53] Fix | Delete

* @since 1.8.2

[54] Fix | Delete

*

[55] Fix | Delete

* @param array $forms Form data (e.g. forms on a current page).

[56] Fix | Delete

*

[57] Fix | Delete

* @return bool

[58] Fix | Delete

*/

[59] Fix | Delete

public static function has_stripe_enabled( $forms ) {

[60] Fix | Delete

[61] Fix | Delete

foreach ( $forms as $form ) {

[62] Fix | Delete

if ( self::is_payments_enabled( $form ) ) {

[63] Fix | Delete

return true;

[64] Fix | Delete

}

[65] Fix | Delete

}

[66] Fix | Delete

[67] Fix | Delete

return false;

[68] Fix | Delete

}

[69] Fix | Delete

[70] Fix | Delete

/**

[71] Fix | Delete

* Determine whether Stripe keys are configured on the Payments settings page.

[72] Fix | Delete

*

[73] Fix | Delete

* @since 1.8.2

[74] Fix | Delete

*

[75] Fix | Delete

* @param string $mode Stripe mode to check the keys for.

[76] Fix | Delete

*

[77] Fix | Delete

* @return bool

[78] Fix | Delete

*/

[79] Fix | Delete

public static function has_stripe_keys( $mode = '' ) {

[80] Fix | Delete

[81] Fix | Delete

$mode = self::validate_stripe_mode( $mode );

[82] Fix | Delete

[83] Fix | Delete

return wpforms_setting( "stripe-{$mode}-secret-key" ) && wpforms_setting( "stripe-{$mode}-publishable-key" );

[84] Fix | Delete

}

[85] Fix | Delete

[86] Fix | Delete

/**

[87] Fix | Delete

* Validate Stripe mode name to ensure it's either 'live' or 'test'.

[88] Fix | Delete

* If given mode is invalid, fetches current Stripe mode.

[89] Fix | Delete

*

[90] Fix | Delete

* @since 1.8.2

[91] Fix | Delete

*

[92] Fix | Delete

* @param string $mode Stripe mode to validate.

[93] Fix | Delete

*

[94] Fix | Delete

* @return string

[95] Fix | Delete

*/

[96] Fix | Delete

public static function validate_stripe_mode( $mode ) {

[97] Fix | Delete

[98] Fix | Delete

if ( empty( $mode ) || ! in_array( $mode, self::CONNECTION_MODES, true ) ) {

[99] Fix | Delete

return self::get_stripe_mode();

[100] Fix | Delete

}

[101] Fix | Delete

[102] Fix | Delete

return $mode;

[103] Fix | Delete

}

[104] Fix | Delete

[105] Fix | Delete

/**

[106] Fix | Delete

* Get Stripe mode from the WPForms settings.

[107] Fix | Delete

*

[108] Fix | Delete

* @since 1.8.2

[109] Fix | Delete

*

[110] Fix | Delete

* @return string

[111] Fix | Delete

*/

[112] Fix | Delete

public static function get_stripe_mode() {

[113] Fix | Delete

[114] Fix | Delete

return wpforms_setting( 'stripe-test-mode' ) ? 'test' : 'live';

[115] Fix | Delete

}

[116] Fix | Delete

[117] Fix | Delete

/**

[118] Fix | Delete

* Get Stripe key from the WPForms settings.

[119] Fix | Delete

*

[120] Fix | Delete

* @since 1.8.2

[121] Fix | Delete

*

[122] Fix | Delete

* @param string $type Key type (e.g. 'publishable' or 'secret').

[123] Fix | Delete

* @param string $mode Stripe mode (e.g. 'live' or 'test').

[124] Fix | Delete

*

[125] Fix | Delete

* @return string

[126] Fix | Delete

*/

[127] Fix | Delete

public static function get_stripe_key( $type, $mode = '' ) {

[128] Fix | Delete

[129] Fix | Delete

$mode = self::validate_stripe_mode( $mode );

[130] Fix | Delete

[131] Fix | Delete

if ( ! in_array( $type, [ 'publishable', 'secret' ], true ) ) {

[132] Fix | Delete

return '';

[133] Fix | Delete

}

[134] Fix | Delete

[135] Fix | Delete

$key = wpforms_setting( "stripe-{$mode}-{$type}-key" );

[136] Fix | Delete

[137] Fix | Delete

if ( ! empty( $key ) && is_string( $key ) ) {

[138] Fix | Delete

return sanitize_text_field( $key );

[139] Fix | Delete

}

[140] Fix | Delete

[141] Fix | Delete

return '';

[142] Fix | Delete

}

[143] Fix | Delete

[144] Fix | Delete

/**

[145] Fix | Delete

* Set Stripe key from the WPForms settings.

[146] Fix | Delete

*

[147] Fix | Delete

* @since 1.8.2

[148] Fix | Delete

*

[149] Fix | Delete

* @param string $value Key string to set.

[150] Fix | Delete

* @param string $type Key type (e.g. 'publishable' or 'secret').

[151] Fix | Delete

* @param string $mode Stripe mode (e.g. 'live' or 'test').

[152] Fix | Delete

*

[153] Fix | Delete

* @return bool

[154] Fix | Delete

*/

[155] Fix | Delete

public static function set_stripe_key( $value, $type, $mode = '' ) {

[156] Fix | Delete

[157] Fix | Delete

$mode = self::validate_stripe_mode( $mode );

[158] Fix | Delete

[159] Fix | Delete

if ( ! in_array( $type, [ 'publishable', 'secret' ], true ) ) {

[160] Fix | Delete

return false;

[161] Fix | Delete

}

[162] Fix | Delete

[163] Fix | Delete

$key = "stripe-{$mode}-{$type}-key";

[164] Fix | Delete

$settings = (array) get_option( 'wpforms_settings', [] );

[165] Fix | Delete

$settings[ $key ] = sanitize_text_field( $value );

[166] Fix | Delete

[167] Fix | Delete

return wpforms_update_settings( $settings );

[168] Fix | Delete

}

[169] Fix | Delete

[170] Fix | Delete

/**

[171] Fix | Delete

* Determine whether a license key is active.

[172] Fix | Delete

*

[173] Fix | Delete

* @since 1.8.2

[174] Fix | Delete

*

[175] Fix | Delete

* @return bool

[176] Fix | Delete

*/

[177] Fix | Delete

public static function is_license_active() {

[178] Fix | Delete

[179] Fix | Delete

$license = (array) get_option( 'wpforms_license', [] );

[180] Fix | Delete

[181] Fix | Delete

return ! empty( wpforms_get_license_key() ) &&

[182] Fix | Delete

empty( $license['is_expired'] ) &&

[183] Fix | Delete

empty( $license['is_disabled'] ) &&

[184] Fix | Delete

empty( $license['is_invalid'] );

[185] Fix | Delete

}

[186] Fix | Delete

[187] Fix | Delete

/**

[188] Fix | Delete

* Determine whether a license type is allowed.

[189] Fix | Delete

*

[190] Fix | Delete

* @since 1.8.2

[191] Fix | Delete

*

[192] Fix | Delete

* @return bool

[193] Fix | Delete

*/

[194] Fix | Delete

public static function is_allowed_license_type() {

[195] Fix | Delete

[196] Fix | Delete

return in_array( wpforms_get_license_type(), [ 'pro', 'elite', 'agency', 'ultimate' ], true );

[197] Fix | Delete

}

[198] Fix | Delete

[199] Fix | Delete

/**

[200] Fix | Delete

* Determine whether a license is ok.

[201] Fix | Delete

*

[202] Fix | Delete

* @since 1.8.2

[203] Fix | Delete

*

[204] Fix | Delete

* @return bool

[205] Fix | Delete

*/

[206] Fix | Delete

public static function is_license_ok() {

[207] Fix | Delete

[208] Fix | Delete

return self::is_license_active() && self::is_allowed_license_type();

[209] Fix | Delete

}

[210] Fix | Delete

[211] Fix | Delete

/**

[212] Fix | Delete

* Determine whether the addon is activated.

[213] Fix | Delete

*

[214] Fix | Delete

* @since 1.8.2

[215] Fix | Delete

* @since 1.9.5 Added a fallback for legacy versions of the Stripe addon.

[216] Fix | Delete

*

[217] Fix | Delete

* @return bool

[218] Fix | Delete

*/

[219] Fix | Delete

public static function is_addon_active(): bool {

[220] Fix | Delete

[221] Fix | Delete

// Legacy versions of the Stripe addon do not support the Requirements core feature.

[222] Fix | Delete

if ( defined( 'WPFORMS_STRIPE_VERSION' ) && version_compare( WPFORMS_STRIPE_VERSION, '3.0.1', '<=' ) ) {

[223] Fix | Delete

return function_exists( 'wpforms_stripe' );

[224] Fix | Delete

}

[225] Fix | Delete

[226] Fix | Delete

return wpforms_is_addon_initialized( 'stripe' );

[227] Fix | Delete

}

[228] Fix | Delete

[229] Fix | Delete

/**

[230] Fix | Delete

* Determine whether the addon is activated and appropriate license is set.

[231] Fix | Delete

*

[232] Fix | Delete

* @since 1.8.2

[233] Fix | Delete

*

[234] Fix | Delete

* @return bool

[235] Fix | Delete

*/

[236] Fix | Delete

public static function is_pro() {

[237] Fix | Delete

[238] Fix | Delete

return self::is_addon_active() && self::is_allowed_license_type();

[239] Fix | Delete

}

[240] Fix | Delete

[241] Fix | Delete

/**

[242] Fix | Delete

* Get authorization options used for every Stripe transaction as recommended in Stripe official docs.

[243] Fix | Delete

*

[244] Fix | Delete

* @link https://stripe.com/docs/connect/authentication#api-keys

[245] Fix | Delete

*

[246] Fix | Delete

* @since 1.8.2

[247] Fix | Delete

*

[248] Fix | Delete

* @return array

[249] Fix | Delete

*/

[250] Fix | Delete

public static function get_auth_opts() {

[251] Fix | Delete

[252] Fix | Delete

return [ 'api_key' => self::get_stripe_key( 'secret' ) ];

[253] Fix | Delete

}

[254] Fix | Delete

[255] Fix | Delete

/**

[256] Fix | Delete

* Determine whether the Payment element mode is enabled.

[257] Fix | Delete

*

[258] Fix | Delete

* @since 1.8.2

[259] Fix | Delete

*

[260] Fix | Delete

* @return bool

[261] Fix | Delete

*/

[262] Fix | Delete

public static function is_payment_element_enabled() {

[263] Fix | Delete

[264] Fix | Delete

return wpforms_setting( 'stripe-card-mode' ) === 'payment';

[265] Fix | Delete

}

[266] Fix | Delete

[267] Fix | Delete

/**

[268] Fix | Delete

* Determine whether the application fee is supported.

[269] Fix | Delete

*

[270] Fix | Delete

* @since 1.8.2

[271] Fix | Delete

*

[272] Fix | Delete

* @return bool

[273] Fix | Delete

*/

[274] Fix | Delete

public static function is_application_fee_supported() {

[275] Fix | Delete

[276] Fix | Delete

return ! in_array( self::get_account_country(), [ 'br', 'in', 'mx' ], true );

[277] Fix | Delete

}

[278] Fix | Delete

[279] Fix | Delete

/**

[280] Fix | Delete

* Get Stripe webhook endpoint data.

[281] Fix | Delete

*

[282] Fix | Delete

* @since 1.8.4

[283] Fix | Delete

*

[284] Fix | Delete

* @return array

[285] Fix | Delete

*/

[286] Fix | Delete

public static function get_webhook_endpoint_data() {

[287] Fix | Delete

[288] Fix | Delete

return [

[289] Fix | Delete

'namespace' => 'wpforms',

[290] Fix | Delete

'route' => 'stripe/webhooks',

[291] Fix | Delete

'fallback' => 'wpforms_stripe_webhooks',

[292] Fix | Delete

];

[293] Fix | Delete

}

[294] Fix | Delete

[295] Fix | Delete

/**

[296] Fix | Delete

* Get webhook URL for REST API.

[297] Fix | Delete

*

[298] Fix | Delete

* @since 1.8.4

[299] Fix | Delete

*

[300] Fix | Delete

* @return string

[301] Fix | Delete

*/

[302] Fix | Delete

public static function get_webhook_url_for_rest() {

[303] Fix | Delete

[304] Fix | Delete

$path = implode(

[305] Fix | Delete

'/',

[306] Fix | Delete

[

[307] Fix | Delete

self::get_webhook_endpoint_data()['namespace'],

[308] Fix | Delete

self::get_webhook_endpoint_data()['route'],

[309] Fix | Delete

]

[310] Fix | Delete

);

[311] Fix | Delete

[312] Fix | Delete

return rest_url( $path );

[313] Fix | Delete

}

[314] Fix | Delete

[315] Fix | Delete

/**

[316] Fix | Delete

* Get webhook URL for cURL fallback.

[317] Fix | Delete

*

[318] Fix | Delete

* @since 1.8.4

[319] Fix | Delete

*

[320] Fix | Delete

* @return string

[321] Fix | Delete

*/

[322] Fix | Delete

public static function get_webhook_url_for_curl() {

[323] Fix | Delete

[324] Fix | Delete

return add_query_arg( self::get_webhook_endpoint_data()['fallback'], '1', site_url() );

[325] Fix | Delete

}

[326] Fix | Delete

[327] Fix | Delete

/**

[328] Fix | Delete

* Determine if webhook ID and secret is set in WPForms settings.

[329] Fix | Delete

*

[330] Fix | Delete

* @since 1.8.4

[331] Fix | Delete

*

[332] Fix | Delete

* @return bool

[333] Fix | Delete

*/

[334] Fix | Delete

public static function is_webhook_configured() {

[335] Fix | Delete

[336] Fix | Delete

$mode = self::get_stripe_mode();

[337] Fix | Delete

[338] Fix | Delete

return wpforms_setting( 'stripe-webhooks-id-' . $mode ) && wpforms_setting( 'stripe-webhooks-secret-' . $mode );

[339] Fix | Delete

}

[340] Fix | Delete

[341] Fix | Delete

/**

[342] Fix | Delete

* Determine if webhooks are enabled in WPForms settings.

[343] Fix | Delete

*

[344] Fix | Delete

* @since 1.8.4

[345] Fix | Delete

*

[346] Fix | Delete

* @return bool

[347] Fix | Delete

*/

[348] Fix | Delete

public static function is_webhook_enabled() {

[349] Fix | Delete

[350] Fix | Delete

return wpforms_setting( 'stripe-webhooks-enabled' );

[351] Fix | Delete

}

[352] Fix | Delete

[353] Fix | Delete

/**

[354] Fix | Delete

* Determine if REST API is set in WPForms settings.

[355] Fix | Delete

*

[356] Fix | Delete

* @since 1.8.4

[357] Fix | Delete

*

[358] Fix | Delete

* @return bool

[359] Fix | Delete

*/

[360] Fix | Delete

public static function is_rest_api_set() {

[361] Fix | Delete

[362] Fix | Delete

return wpforms_setting( 'stripe-webhooks-communication', 'rest' ) === 'rest';

[363] Fix | Delete

}

[364] Fix | Delete

[365] Fix | Delete

/**

[366] Fix | Delete

* Get decimals amount.

[367] Fix | Delete

*

[368] Fix | Delete

* @since 1.8.4

[369] Fix | Delete

* @deprecated 1.9.5

[370] Fix | Delete

*

[371] Fix | Delete

* @param string $currency Currency.

[372] Fix | Delete

*

[373] Fix | Delete

* @return int

[374] Fix | Delete

*/

[375] Fix | Delete

public static function get_decimals_amount( $currency = '' ) {

[376] Fix | Delete

[377] Fix | Delete

_deprecated_function( __METHOD__, '1.9.5 of the WPForms plugin', 'wpforms_get_currency_multiplier()' );

[378] Fix | Delete

[379] Fix | Delete

return wpforms_get_currency_multiplier( $currency );

[380] Fix | Delete

}

[381] Fix | Delete

[382] Fix | Delete

/**

[383] Fix | Delete

* Get Stripe webhook endpoint URL.

[384] Fix | Delete

*

[385] Fix | Delete

* If the constant WPFORMS_STRIPE_WHURL is defined, it will be used as the webhook URL.

[386] Fix | Delete

*

[387] Fix | Delete

* @since 1.8.4

[388] Fix | Delete

*

[389] Fix | Delete

* @return string

[390] Fix | Delete

*/

[391] Fix | Delete

public static function get_webhook_url() {

[392] Fix | Delete

[393] Fix | Delete

if ( defined( 'WPFORMS_STRIPE_WHURL' ) ) {

[394] Fix | Delete

return WPFORMS_STRIPE_WHURL;

[395] Fix | Delete

}

[396] Fix | Delete

[397] Fix | Delete

if ( self::is_rest_api_set() ) {

[398] Fix | Delete

return self::get_webhook_url_for_rest();

[399] Fix | Delete

}

[400] Fix | Delete

[401] Fix | Delete

return self::get_webhook_url_for_curl();

[402] Fix | Delete

}

[403] Fix | Delete

[404] Fix | Delete

/**

[405] Fix | Delete

* Is Stripe payment enabled for the form.

[406] Fix | Delete

*

[407] Fix | Delete

* @since 1.8.4

[408] Fix | Delete

*

[409] Fix | Delete

* @param array $form_data Form data.

[410] Fix | Delete

*

[411] Fix | Delete

* @return bool

[412] Fix | Delete

*/

[413] Fix | Delete

public static function is_payments_enabled( $form_data ) {

[414] Fix | Delete

[415] Fix | Delete

return self::is_modern_settings_enabled( $form_data ) || ! empty( $form_data['payments']['stripe']['enable'] );

[416] Fix | Delete

}

[417] Fix | Delete

[418] Fix | Delete

/**

[419] Fix | Delete

* Is Stripe modern payment enabled for the form.

[420] Fix | Delete

*

[421] Fix | Delete

* @since 1.8.4

[422] Fix | Delete

*

[423] Fix | Delete

* @param array $form_data Form data.

[424] Fix | Delete

*

[425] Fix | Delete

* @return bool

[426] Fix | Delete

*/

[427] Fix | Delete

public static function is_modern_settings_enabled( $form_data ) {

[428] Fix | Delete

[429] Fix | Delete

return ! empty( $form_data['payments']['stripe']['enable_one_time'] ) || ! empty( $form_data['payments']['stripe']['enable_recurring'] );

[430] Fix | Delete

}

[431] Fix | Delete

[432] Fix | Delete

/**

[433] Fix | Delete

* Detect if form supports multiple subscription plans.

[434] Fix | Delete

*

[435] Fix | Delete

* @since 1.8.4

[436] Fix | Delete

*

[437] Fix | Delete

* @param array $form_data Form data.

[438] Fix | Delete

*

[439] Fix | Delete

* @return bool

[440] Fix | Delete

*/

[441] Fix | Delete

public static function is_form_supports_multiple_recurring_plans( $form_data ) {

[442] Fix | Delete

[443] Fix | Delete

return ! isset( $form_data['payments']['stripe'] ) || empty( $form_data['payments']['stripe']['recurring']['enable'] );

[444] Fix | Delete

}

[445] Fix | Delete

[446] Fix | Delete

/**

[447] Fix | Delete

* Determine if legacy payment settings should be displayed.

[448] Fix | Delete

*

[449] Fix | Delete

* @since 1.8.4

[450] Fix | Delete

*

[451] Fix | Delete

* @param array $form_data Form data.

[452] Fix | Delete

*

[453] Fix | Delete

* @return bool

[454] Fix | Delete

*/

[455] Fix | Delete

public static function is_legacy_payment_settings( $form_data ) {

[456] Fix | Delete

[457] Fix | Delete

$has_legacy_settings = ! self::is_form_supports_multiple_recurring_plans( $form_data );

[458] Fix | Delete

[459] Fix | Delete

// Return early if form has legacy payment settings.

[460] Fix | Delete

if ( $has_legacy_settings ) {

[461] Fix | Delete

return true;

[462] Fix | Delete

}

[463] Fix | Delete

[464] Fix | Delete

$addon_compat = ( new StripeAddonCompatibility() )->init();

[465] Fix | Delete

[466] Fix | Delete

// Return early if Stripe Pro addon doesn't support modern settings (multiple plans).

[467] Fix | Delete

if ( $addon_compat && ! $addon_compat->is_supported_modern_settings() ) {

[468] Fix | Delete

return true;

[469] Fix | Delete

}

[470] Fix | Delete

[471] Fix | Delete

return false;

[472] Fix | Delete

}

[473] Fix | Delete

[474] Fix | Delete

/**

[475] Fix | Delete

* Determine whether the Link is supported.

[476] Fix | Delete

*

[477] Fix | Delete

* @link https://docs.stripe.com/payments/payment-methods/integration-options#payment-method-availability

[478] Fix | Delete

*

[479] Fix | Delete

* @since 1.8.8

[480] Fix | Delete

*

[481] Fix | Delete

* @return bool

[482] Fix | Delete

*/

[483] Fix | Delete

public static function is_link_supported(): bool {

[484] Fix | Delete

[485] Fix | Delete

return ! in_array( self::get_account_country(), [ 'br', 'in', 'id', 'th' ], true );

[486] Fix | Delete

}

[487] Fix | Delete

[488] Fix | Delete

/**

[489] Fix | Delete

* Get the maximum number of cycles for recurring plans.

[490] Fix | Delete

*

[491] Fix | Delete

* @since 1.9.8

[492] Fix | Delete

*

[493] Fix | Delete

* @return int

[494] Fix | Delete

*/

[495] Fix | Delete

public static function recurring_plan_cycles_max(): int {

[496] Fix | Delete

[497] Fix | Delete

/**

[498] Fix | Delete

* Filters the maximum number of cycles for recurring plans.

[499] Fix | Delete