builder_alerts() ) {
return;
}
$hide_class = ! Helpers::has_square_field( $this->form_data ) ? 'wpforms-hidden' : '';
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
echo Notices::get_fee_notice( $hide_class );
$this->maybe_convert_legacy_settings();
echo '';
if ( ! Helpers::is_pro() ) {
$this->builder_content_one_time();
$this->builder_content_recurring();
} else {
parent::builder_content();
}
echo '
';
}
/**
* Convert legacy settings if they exist.
*
* @since 1.9.5
*/
private function maybe_convert_legacy_settings() {
if ( empty( $this->form_data['payments']['square']['enable'] ) ) {
return;
}
// Enable one-time payments if they were active.
unset( $this->form_data['payments']['square']['enable'] );
$this->form_data['payments']['square']['enable_one_time'] = 1;
}
/**
* Get content inside the one time payment area.
*
* @since 1.9.5
*
* @return string
*/
protected function get_builder_content_one_time_content(): string {
$content = wpforms_panel_field(
'text',
'square',
'payment_description',
$this->form_data,
esc_html__( 'Payment Description', 'wpforms-lite' ),
[
'parent' => 'payments',
'tooltip' => esc_html__( 'Enter your payment description. Eg: Donation for the soccer team.', 'wpforms-lite' ),
],
false
);
$content .= wpforms_panel_field(
'select',
'square',
'buyer_email',
$this->form_data,
esc_html__( 'Buyer Email', 'wpforms-lite' ),
[
'parent' => 'payments',
'field_map' => [ 'email' ],
'placeholder' => esc_html__( '--- Select Buyer Email ---', 'wpforms-lite' ),
'tooltip' => esc_html__( "Select the field that contains the buyer's email address. This field is optional.", 'wpforms-lite' ),
],
false
);
$content .= wpforms_panel_field(
'select',
'square',
'billing_name',
$this->form_data,
esc_html__( 'Billing Name', 'wpforms-lite' ),
[
'parent' => 'payments',
'field_map' => [ 'name' ],
'placeholder' => esc_html__( '--- Select Billing Name ---', 'wpforms-lite' ),
'tooltip' => esc_html__( "Select the field that contains the billing's name. This field is optional.", 'wpforms-lite' ),
],
false
);
$content .= $this->get_address_panel_fields();
$content .= $this->single_payments_conditional_logic_section();
return $content;
}
/**
* Get content inside the recurring payment area.
*
* @since 1.9.5
*
* @param string $plan_id Plan id.
*
* @return string
*/
protected function get_builder_content_recurring_payment_content( $plan_id ): string {
$content = wpforms_panel_field(
'text',
$this->slug,
'name',
$this->form_data,
esc_html__( 'Plan Name', 'wpforms-lite' ),
[
'parent' => 'payments',
'subsection' => 'recurring',
'index' => $plan_id,
'tooltip' => esc_html__( 'Enter the subscription name. Eg: Email Newsletter. Subscription period and price are automatically appended. If left empty the form name will be used.', 'wpforms-lite' ),
'class' => 'wpforms-panel-content-section-payment-plan-name',
],
false
);
$content .= wpforms_panel_field(
'select',
$this->slug,
'phase_cadence',
$this->form_data,
esc_html__( 'Phase Cadence', 'wpforms-lite' ),
[
'parent' => 'payments',
'subsection' => 'recurring',
'index' => $plan_id,
'default' => 'yearly',
'options' => wp_list_pluck( Helpers::get_subscription_cadences(), 'name', 'slug' ),
'tooltip' => esc_html__( 'How often you would like the charge to recur.', 'wpforms-lite' ),
],
false
);
$is_empty_email = isset( $this->form_data['payments'][ $this->slug ]['recurring'][ $plan_id ]['customer_email'] ) && empty( $this->form_data['payments'][ $this->slug ]['recurring'][ $plan_id ]['customer_email'] );
$content .= wpforms_panel_field(
'select',
$this->slug,
'customer_email',
$this->form_data,
esc_html__( 'Customer Email', 'wpforms-lite' ),
[
'parent' => 'payments',
'subsection' => 'recurring',
'index' => $plan_id,
'input_class' => $is_empty_email ? 'wpforms-required-field-error' : '',
'field_map' => [ 'email' ],
'placeholder' => esc_html__( '--- Select Email ---', 'wpforms-lite' ),
'tooltip' => esc_html__( "Select the field that contains the customer's email address. This field is required.", 'wpforms-lite' ),
],
false
);
$is_empty_name = isset( $this->form_data['payments'][ $this->slug ]['recurring'][ $plan_id ]['customer_name'] ) && empty( $this->form_data['payments'][ $this->slug ]['recurring'][ $plan_id ]['customer_name'] );
$content .= wpforms_panel_field(
'select',
$this->slug,
'customer_name',
$this->form_data,
esc_html__( 'Customer Name', 'wpforms-lite' ),
[
'parent' => 'payments',
'subsection' => 'recurring',
'index' => $plan_id,
'input_class' => $is_empty_name ? 'wpforms-required-field-error' : '',
'field_map' => [ 'name' ],
'placeholder' => esc_html__( '--- Select Name ---', 'wpforms-lite' ),
'tooltip' => esc_html__( "Select the field that contains the customer's name. This field is required.", 'wpforms-lite' ),
],
false
);
$content .= $this->get_address_panel_fields( $plan_id );
$content .= $this->recurring_payments_conditional_logic_section( $plan_id );
return $content;
}
/**
* Display Single payment content inside the panel content area.
*
* @since 1.9.5
*/
private function builder_content_one_time() {
?>
slug,
'enable_one_time',
$this->form_data,
esc_html__( 'Enable one-time payments', 'wpforms-lite' ),
[
'parent' => 'payments',
'default' => '0',
'tooltip' => esc_html__( 'Allow your customers to one-time pay via the form.', 'wpforms-lite' ),
'class' => 'wpforms-panel-content-section-payment-toggle wpforms-panel-content-section-payment-toggle-one-time',
]
);
?>
get_builder_content_one_time_content(); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped ?>
add_plan_education();
wpforms_panel_field(
'toggle',
$this->slug,
'enable_recurring',
$this->form_data,
esc_html__( 'Enable recurring subscription payments', 'wpforms-lite' ),
[
'parent' => 'payments',
'default' => '0',
'tooltip' => esc_html__( 'Allow your customer to pay recurringly via the form.', 'wpforms-lite' ),
'class' => 'wpforms-panel-content-section-payment-toggle wpforms-panel-content-section-payment-toggle-recurring',
]
);
?>
form_data['payments'][ $this->slug ]['recurring'] ) ) {
$this->form_data['payments'][ $this->slug ]['recurring'][] = [];
}
foreach ( $this->form_data['payments'][ $this->slug ]['recurring'] as $plan_id => $plan_settings ) {
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
echo wpforms_render(
'builder/payment/recurring/item',
[
'plan_id' => $plan_id,
'content' => $this->get_builder_content_recurring_payment_content( $plan_id ),
],
true
);
break;
}
?>
' . esc_html( $label ) . '';
return;
}
$addon = wpforms()->obj( 'addons' )->get_addon( 'wpforms-square' );
if ( empty( $addon ) ) {
return;
}
echo '' . esc_html( $label ) . '';
}
/**
* Get address panel fields.
*
* @since 1.9.5
*
* @param string|null $plan_id Plan ID.
*
* @return string
*/
private function get_address_panel_fields( $plan_id = null ): string {
$args = [
'parent' => 'payments',
'field_map' => [ 'address' ],
];
$is_pro = wpforms()->is_pro();
if ( ! $is_pro ) {
$args['pro_badge'] = true;
$args['data'] = [
'action' => 'upgrade',
'name' => esc_html__( 'Customer Address', 'wpforms-lite' ),
'utm-content' => 'Builder Square Address Field',
'licence' => 'pro',
];
$args['input_class'] = 'education-modal';
$args['readonly'] = true;
} else {
$args['tooltip'] = esc_html__( 'Select the field that contains the customer\'s Address. This field is optional.', 'wpforms-lite' );
}
// Check if subscription.
if ( ! is_null( $plan_id ) ) {
$args['placeholder'] = esc_html__( '--- Select Address ---', 'wpforms-lite' );
$args['subsection'] = 'recurring';
$args['index'] = $plan_id;
return wpforms_panel_field(
'select',
$this->slug,
'customer_address',
$this->form_data,
esc_html__( 'Customer Address', 'wpforms-lite' ),
$args,
false
);
}
if ( ! $is_pro ) {
$args['data']['name'] = esc_html__( 'Billing Address', 'wpforms-lite' );
} else {
$args['tooltip'] = esc_html__( 'Select the field that contains the billing\'s address. This field is optional.', 'wpforms-lite' );
}
$args['placeholder'] = esc_html__( '--- Select Billing Address ---', 'wpforms-lite' );
return wpforms_panel_field(
'select',
$this->slug,
'billing_address',
$this->form_data,
esc_html__( 'Billing Address', 'wpforms-lite' ),
$args,
false
);
}
/**
* Check if connection exists and ready to use.
*
* @since 1.9.5
*
* @return bool
*/
private function builder_alerts(): bool {
$connection = Connection::get();
if ( ! $connection ) {
$this->disconnected_alert();
return true;
}
if ( ! $connection->is_usable() ) {
// The invalid status requires re-connecting the account; other non-usable reasons (e.g. currency mismatch) do not.
if ( ! $connection->is_valid() ) {
$this->reconnect_alert();
return true;
}
$this->alert_content(
__( 'Square payments can\'t be processed because there\'s a problem with the account connection.', 'wpforms-lite' ),
sprintf(
wp_kses( /* translators: %s - the WPForms Payments settings page URL. */
__( "First, please resolve the connection issue on the Payment Settings page.", 'wpforms-lite' ),
[
'a' => [
'href' => [],
],
]
),
Helpers::is_sandbox_mode() ? esc_html__( 'Sandbox', 'wpforms-lite' ) : esc_html__( 'Production', 'wpforms-lite' ),
esc_url( Helpers::get_settings_page_url() . '#wpforms-setting-row-square-heading' )
)
);
return true;
}
if ( $connection->is_expired() ) {
$this->alert_content(
__( 'Heads up! Square account connection is expired.', 'wpforms-lite' ),
sprintf(
wp_kses( /* translators: %s - the WPForms Payments settings page URL. */
__( "Tokens must be refreshed. Please refresh them on the WPForms Settings page.", 'wpforms-lite' ),
[
'a' => [
'href' => [],
],
]
),
Helpers::is_sandbox_mode() ? esc_html__( 'Sandbox', 'wpforms-lite' ) : esc_html__( 'Production', 'wpforms-lite' ),
esc_url( Helpers::get_settings_page_url() . '#wpforms-setting-row-square-heading' )
)
);
return true;
}
$this->credit_card_alert();
return false;
}
/**
* Display alert content.
*
* @since 1.9.5
*
* @param string $title Alert title.
* @param string $message Alert message.
*/
private function alert_content( string $title, string $message ) {
?>
alert_icon(); ?>
learn_more_link(); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped ?>
form_data ) ? 'wpforms-hidden' : '';
?>
alert_content(
'',
esc_html__( 'To use Square, first add the Square payment field to your form.', 'wpforms-lite' )
);
?>
',
esc_url( $this->icon ),
esc_attr__( 'Connect WPForms to Square.', 'wpforms-lite' )
);
}
/**
* Learn more link.
*
* @since 1.9.5
*
* @return string
*/
private function learn_more_link(): string {
return sprintf(
'%2$s',
esc_url( wpforms_utm_link( 'https://wpforms.com/docs/how-to-install-and-use-the-square-addon-with-wpforms/', 'builder-payments', 'Square Documentation' ) ),
esc_html__( 'Learn more about our Square integration.', 'wpforms-lite' )
);
}
/**
* Display the disconnected-state alert with an inline Connect button.
*
* @since 1.10.1.1
*/
private function disconnected_alert(): void {
$connect_url = $this->get_builder_connect_url();
$this->alert_icon();
?>
learn_more_link(); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped ?>
connect_button( $connect_url, __( 'Connect with Square', 'wpforms-lite' ) );
// The WPForms transaction fee applies to Lite only; Pro has no extra fees.
if ( ! wpforms()->is_pro() ) {
echo '
' . esc_html__( 'No extra WPForms transaction fees on Pro.', 'wpforms-lite' ) . '
';
}
?>
get_builder_connect_url();
$this->alert_icon();
?>
learn_more_link(); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped ?>
connect_button( $connect_url, __( 'Reconnect with Square', 'wpforms-lite' ) ); ?>
form_data['id'] ) ? absint( $this->form_data['id'] ) : 0;
return ( new Connect() )->get_connect_url( '', $form_id );
}
/**
* Render an inline Square connect/reconnect button.
*
* @since 2.0.0
*
* @param string $connect_url The OAuth connect URL.
* @param string $label The button label.
*/
private function connect_button( string $connect_url, string $label ): void {
printf(
'%3$s',
esc_url( $connect_url ),
esc_attr__( 'Square', 'wpforms-lite' ),
esc_html( $label )
);
}
}