LLMS_Settings_Checkout
Admin Settings Page, Checkout Tab class
Source Source
File: includes/admin/settings/class.llms.settings.checkout.php
class LLMS_Settings_Checkout extends LLMS_Settings_Page {
/**
* Allow settings page to determine if a rewrite flush is required
*
* @var boolean
* @since 3.0.4
* @version 3.10.0
*/
protected $flush = true;
/**
* Constructor
* executes settings tab actions
*
* @since 3.0.4
* @version 3.17.5
*/
public function __construct() {
$this->id = 'checkout';
$this->label = __( 'Checkout', 'lifterlms' );
add_filter( 'lifterlms_settings_tabs_array', array( $this, 'add_settings_page' ), 20 );
add_action( 'lifterlms_sections_' . $this->id, array( $this, 'output_sections_nav' ) );
add_action( 'lifterlms_settings_' . $this->id, array( $this, 'output' ) );
add_action( 'lifterlms_settings_save_' . $this->id, array( $this, 'save' ) );
}
/**
* Get HTML for the payment gateways table
*
* @return string
* @since 3.17.5
* @version 3.17.5
*/
public function get_gateway_table_html() {
$gateways = llms()->payment_gateways()->get_payment_gateways();
usort( $gateways, array( $this, 'sort_gateways' ) );
ob_start();
?>
<table class="llms-table zebra text-left size-large llms-gateway-table">
<thead>
<tr>
<th class="sort"></th>
<th><?php _e( 'Gateway', 'lifterlms' ); ?></th>
<th><?php _e( 'Gateway ID', 'lifterlms' ); ?></th>
<th><?php _e( 'Enabled', 'lifterlms' ); ?></th>
</tr>
</thead>
<tbody>
<?php foreach ( $gateways as $gateway ) : ?>
<tr>
<td class="sort">
<i class="fa fa-bars llms-action-icon" aria-hidden="true"></i>
<input type="hidden" name="<?php echo $gateway->get_option_name( 'display_order' ); ?>" value="<?php echo $gateway->get_display_order(); ?>">
</td>
<td><a href="<?php echo esc_url( admin_url( 'admin.php?page=llms-settings&tab=' . $this->id . '§ion=' . $gateway->get_id() ) ); ?>"><?php echo $gateway->get_admin_title(); ?></a></td>
<td><?php echo $gateway->get_id(); ?></td>
<td class="status">
<?php if ( $gateway->is_enabled() ) : ?>
<span class="tip--bottom-right" data-tip="<?php esc_attr_e( 'Enabled', 'lifterlms' ); ?>">
<span class="screen-reader-text"><?php _e( 'Enabled', 'lifterlms' ); ?></span>
<i class="fa fa-check-circle" aria-hidden="true"></i>
</span>
<?php else : ?>
–
<?php endif; ?>
</td>
</tr>
<?php endforeach; ?>
</tbody>
</table>
<?php
return ob_get_clean();
}
/**
* Get the page sections
*
* @return array
* @since 3.17.5
* @version 3.17.5
*/
public function get_sections() {
$sections = array();
$gateways = llms()->payment_gateways()->get_payment_gateways();
foreach ( $gateways as $id => $gateway ) {
$sections[ $id ] = $gateway->get_admin_title();
}
asort( $sections );
$sections = array_merge(
array(
'main' => __( 'Checkout Settings', 'lifterlms' ),
),
$sections
);
return apply_filters( 'llms_checkout_settings_sections', $sections );
}
/**
* Get settings array
*
* @return array
* @since 3.0.4
* @version 3.17.5
*/
public function get_settings() {
$curr_section = $this->get_current_section();
if ( 'main' === $curr_section ) {
return apply_filters( 'lifterlms_checkout_settings', $this->get_settings_default() );
}
return apply_filters( 'lifterlms_gateway_settings_' . $curr_section, $this->get_settings_gateway( $curr_section ) );
}
/**
* Retrieve the default checkout settings for the main section
*
* @since 3.17.5
* @since 3.30.3 Fixed spelling errors.
*
* @return array
*/
private function get_settings_default() {
$currency_code_options = get_lifterlms_currencies();
foreach ( $currency_code_options as $code => $name ) {
$currency_code_options[ $code ] = $name . ' (' . get_lifterlms_currency_symbol( $code ) . ')';
}
$country_options = get_lifterlms_countries();
foreach ( $country_options as $code => $name ) {
$country_options[ $code ] = $name . ' (' . $code . ')';
}
return array(
array(
'class' => 'top',
'id' => 'course_archive_options',
'type' => 'sectionstart',
),
array(
'id' => 'course_options',
'title' => __( 'Checkout Settings', 'lifterlms' ),
'type' => 'title',
),
array(
'title' => __( 'Checkout Page', 'lifterlms' ),
'desc' => __( 'Page used for displaying the checkout form.', 'lifterlms' ),
'id' => 'lifterlms_checkout_page_id',
'type' => 'select',
'default' => '',
'class' => 'llms-select2-post',
'custom_attributes' => array(
'data-post-type' => 'page',
),
'options' => llms_make_select2_post_array( get_option( 'lifterlms_checkout_page_id', '' ) ),
),
array(
'title' => __( 'Confirm Payment', 'lifterlms' ),
'desc' => __( 'Payment confirmation endpoint slug', 'lifterlms' ),
'id' => 'lifterlms_myaccount_confirm_payment_endpoint',
'type' => 'text',
'default' => 'confirm-payment',
'desc_tip' => true,
'sanitize' => 'slug',
),
array(
'title' => __( 'Force SSL', 'lifterlms' ),
'desc' => __( 'Force secure checkout via SSL (https) on the checkout page(s).', 'lifterlms' ) .
'<p class="description">' . sprintf( __( 'Requires an SSL certificate. %1$sLearn More%2$s', 'lifterlms' ), '<a href="https://lifterlms.com/docs/ssl-and-https/" target="_blank">', '</a>' ) . '</p>',
'id' => 'lifterlms_checkout_force_ssl',
'type' => 'checkbox',
'default' => 'no',
),
array(
'default' => 'yes',
'desc' => __( 'Enable automatic retry of failed recurring payments.', 'lifterlms' ) .
'<p class="description">' . sprintf( __( 'Recover lost revenue from temporarily declined payment methods. %1$sLearn More%2$s', 'lifterlms' ), '<a href="https://lifterlms.com/docs/automatic-retry-failed-payments/" target="_blank">', '</a>' ) . '</p>',
'id' => 'lifterlms_recurring_payment_retry',
'title' => __( 'Retry Failed Payments', 'lifterlms' ),
'type' => 'checkbox',
),
array(
'type' => 'sectionend',
'id' => 'course_archive_options',
),
array(
'type' => 'sectionstart',
'id' => 'general_options',
),
array(
'title' => __( 'Currency Options', 'lifterlms' ),
'type' => 'title',
'desc' => __( 'The following options affect how prices are displayed on the frontend.', 'lifterlms' ),
'id' => 'pricing_options',
),
array(
'class' => 'llms-select2',
'title' => __( 'Country', 'lifterlms' ),
'desc' => __( 'Select the country LifterLMS should use as the default during transactions and registrations.', 'lifterlms' ),
'id' => 'lifterlms_country',
'default' => 'US',
'type' => 'select',
'desc_tip' => false,
'options' => $country_options,
),
array(
'class' => 'llms-select2',
'title' => __( 'Currency', 'lifterlms' ),
'desc' => __( 'Select the currency LifterLMS should use to display prices and process transactions.', 'lifterlms' ),
'id' => 'lifterlms_currency',
'default' => 'USD',
'type' => 'select',
'desc_tip' => false,
'options' => $currency_code_options,
),
array(
'title' => __( 'Currency Position', 'lifterlms' ),
'desc' => __( 'Customize the position and formatting of the currency symbol for displayed prices.', 'lifterlms' ),
'id' => 'lifterlms_currency_position',
'default' => 'left',
'type' => 'select',
'options' => array(
'left' => 'Left (' . sprintf( '%1$s%2$s', get_lifterlms_currency_symbol(), 99.99 ) . ')',
'right' => 'Right (' . sprintf( '%2$s%1$s', get_lifterlms_currency_symbol(), 99.99 ) . ')',
'left_space' => 'Left with Space (' . sprintf( '%1$s %2$s', get_lifterlms_currency_symbol(), 99.99 ) . ')',
'right_space' => 'Right with Space (' . sprintf( '%2$s %1$s', get_lifterlms_currency_symbol(), 99.99 ) . ')',
),
),
array(
'title' => __( 'Thousand Separator', 'lifterlms' ),
'class' => 'tiny',
'desc' => __( 'Choose the character to display as the thousand\'s place separator for displayed prices.', 'lifterlms' ),
'id' => 'lifterlms_thousand_separator',
'type' => 'text',
'default' => ',',
),
array(
'title' => __( 'Decimal Separator', 'lifterlms' ),
'class' => 'tiny',
'desc' => __( 'Choose the character to display as the decimal separator for displayed prices.', 'lifterlms' ),
'id' => 'lifterlms_decimal_separator',
'type' => 'text',
'default' => '.',
),
array(
'title' => __( 'Decimal Places', 'lifterlms' ),
'class' => 'tiny',
'desc' => __( 'Customize the number of decimal places for prices.', 'lifterlms' ),
'id' => 'lifterlms_decimals',
'type' => 'number',
'default' => '2',
),
array(
'title' => __( 'Hide Zero Decimals', 'lifterlms' ),
'desc' => __( 'Automatically remove zero decimals from the end of displayed prices.', 'lifterlms' ),
'id' => 'lifterlms_trim_zero_decimals',
'default' => 'no',
'type' => 'checkbox',
),
array(
'type' => 'sectionend',
'id' => 'general_options',
),
array(
'type' => 'sectionstart',
'id' => 'checkout_settings_gateways_list_start',
),
array(
'title' => __( 'Payment Gateways', 'lifterlms' ),
'type' => 'title',
'id' => 'checkout_settings_gateways_list_title',
),
array(
'value' => $this->get_gateway_table_html(),
'type' => 'custom-html',
),
array(
'type' => 'sectionend',
'id' => 'checkout_settings_gateways_list_end',
),
);
}
/**
* Retrieve settings for a gateway section
*
* @param string $curr_section gateway ID string
* @return array
* @since 3.17.5
* @version 3.17.5
*/
private function get_settings_gateway( $curr_section ) {
$settings = array();
$settings[] = array(
'type' => 'sectionstart',
'id' => 'start_gateway_settings_' . $curr_section,
'class' => 'top',
);
$gateway = llms()->payment_gateways()->get_gateway_by_id( $curr_section );
if ( ! $gateway ) {
$settings[] = array(
'title' => __( 'Payment Gateway Settings', 'lifterlms' ),
'type' => 'title',
'id' => 'title_gateway_settings_' . $curr_section,
);
$settings[] = array(
'title' => sprintf( __( 'Error: "%s" is not a valid payment gateway', 'lifterlms' ), $curr_section ),
'type' => 'subtitle',
'id' => 'title_gateway_settings_' . $curr_section,
);
} else {
$settings[] = array(
'title' => sprintf( __( '%s Payment Gateway Settings', 'lifterlms' ), $gateway->get_admin_title() ),
'type' => 'title',
'id' => 'title_gateway_settings_' . $curr_section,
);
$settings = array_merge( $settings, $gateway->get_admin_settings_fields() );
}
$settings[] = array(
'type' => 'sectionend',
'id' => 'end_gateway_settings_' . $curr_section,
);
return $settings;
}
/**
* Override default save method to save the display order of payment gateways
*
* @since 3.17.5
* @since 3.35.1 Verify nonce.
*
* @return void
*/
public function save() {
if ( ! llms_verify_nonce( '_wpnonce', 'lifterlms-settings' ) ) {
return;
}
// Save all custom fields.
parent::save();
// Save display order of gateways.
foreach ( llms()->payment_gateways()->get_payment_gateways() as $id => $gateway ) {
$option = $gateway->get_option_name( 'display_order' );
if ( isset( $_POST[ $option ] ) ) {
update_option( $option, absint( $_POST[ $option ] ) );
}
}
}
/**
* usort function used to ensure gateways are sorted by display order on the gateways table
*
* @param obj $gateway_a Payment Gateway instance
* @param obj $gateway_b Payment Gateway instance
* @return int
* @since 3.17.5
* @version 3.17.5
*/
public function sort_gateways( $gateway_a, $gateway_b ) {
$a_order = $gateway_a->get_display_order();
$b_order = $gateway_b->get_display_order();
if ( $a_order == $b_order ) {
return 0;
}
return $a_order < $b_order ? -1 : 1;
}
}
Expand full source code Collapse full source code View on GitHub
Methods Methods
- __construct — Constructor executes settings tab actions
- get_gateway_table_html — Get HTML for the payment gateways table
- get_sections — Get the page sections
- get_settings — Get settings array
- get_settings_default — Retrieve the default checkout settings for the main section
- get_settings_gateway — Retrieve settings for a gateway section
- save — Override default save method to save the display order of payment gateways
- sort_gateways — usort function used to ensure gateways are sorted by display order on the gateways table
Changelog Changelog
| Version | Description |
|---|---|
| 3.35.1 | Verify nonce when saving. |
| 3.30.3 | Fixed spelling errors. |
| 3.0.0 | Introduced. |