Your IP : 216.73.216.171
<?php
/**
* Functions related to payments
*
* @since 4.1.0
*
* @package LearnDash
*/
use LearnDash\Core\Utilities\Cast;
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
const LEARNDASH_PRICE_TYPE_OPEN = 'open';
const LEARNDASH_PRICE_TYPE_CLOSED = 'closed';
const LEARNDASH_PRICE_TYPE_FREE = 'free';
const LEARNDASH_PRICE_TYPE_PAYNOW = 'paynow';
const LEARNDASH_PRICE_TYPE_SUBSCRIBE = 'subscribe';
require_once LEARNDASH_LMS_PLUGIN_DIR . 'includes/payments/class-learndash-payment-button.php';
/**
* Outputs the LearnDash global currency symbol.
*
* @since 4.1.0
*
* @return void
*/
function learndash_the_currency_symbol(): void {
echo wp_kses_post( learndash_get_currency_symbol() );
}
/**
* Gets the LearnDash global currency symbol.
*
* @since 4.1.0
* @since 4.2.0 Added $currency_code parameter.
*
* @param string $currency_code Optional. The country currency code (@since 4.2.0).
*
* @return string Currency symbol.
*/
function learndash_get_currency_symbol( string $currency_code = '' ): string {
$currency = ! empty( $currency_code ) ? $currency_code : learndash_get_currency_code();
if ( ! empty( $currency ) && class_exists( 'NumberFormatter' ) ) {
$number_format = new NumberFormatter(
get_locale() . '@currency=' . $currency,
NumberFormatter::CURRENCY
);
$currency = $number_format->getSymbol( NumberFormatter::CURRENCY_SYMBOL );
}
/**
* Filter the LearnDash global currency symbol.
*
* @since 4.1.0
*
* @param string $currency The currency symbol.
*/
return apply_filters( 'learndash_currency_symbol', $currency );
}
/**
* Gets the LearnDash global currency code.
*
* @since 4.1.0
*
* @return string Currency code.
*/
function learndash_get_currency_code(): string {
$currency = LearnDash_Settings_Section::get_section_setting(
'LearnDash_Settings_Section_Payments_Defaults',
'currency'
);
$currency = trim( $currency );
/**
* Filter the LearnDash global currency code.
*
* @since 4.1.0
*
* @param string $currency The currency code.
*/
return apply_filters( 'learndash_currency_code', $currency );
}
/**
* Gets the price formatted based on the LearnDash global currency configuration.
*
* @since 4.1.0
* @since 4.2.0 Added $currency_code parameter.
* @since 4.16.0 Enforce string return type.
*
* @param mixed $price The price to format.
* @param string $currency_code Optional. The country currency code (@since 4.2.0).
*
* @return string Returns price formatted.
*/
function learndash_get_price_formatted( $price, string $currency_code = '' ): string {
// Empty prices should not be displayed.
if ( '' === $price ) {
return '';
}
$currency_code = ! empty( $currency_code ) ? $currency_code : learndash_get_currency_code();
// Price is shown as is if no currency set.
if ( empty( $currency_code ) ) {
return Cast::to_string( $price );
}
// Price is shown as is if non-numeric.
if ( ! is_numeric( $price ) ) {
return Cast::to_string( $price );
}
if ( class_exists( 'NumberFormatter' ) ) {
$number_format = new NumberFormatter(
get_locale() . '@currency=' . $currency_code,
NumberFormatter::CURRENCY
);
return $number_format->format(
floatval( $price )
);
}
$currency_symbol = learndash_get_currency_symbol( $currency_code );
return strlen( $currency_symbol ) > 1
? "$price $currency_symbol" // it's currency code: we should display at the end of the price.
: "$currency_symbol{$price}"; // show the currency symbol at the beginning of the price (en_US style).
}
/**
* Gets the price as float value.
*
* @since 4.1.1
*
* @param string $price The price to convert.
*
* @return float Returns price as float value.
*/
function learndash_get_price_as_float( string $price ): float {
if ( is_numeric( $price ) ) {
return floatval( $price );
}
// trying to convert it into a numeric string.
$dot_position = strpos( $price, '.' );
$comma_position = strpos( $price, ',' );
if ( false !== $dot_position && false !== $comma_position ) {
if ( $dot_position < $comma_position ) {
// dot is before comma. Comma is decimal separator.
$price = str_replace( '.', '', $price ); // remove dot.
$price = str_replace( ',', '.', $price ); // convert comma to dot.
} else {
// comma is before dot. Dot is decimal separator.
$price = str_replace( ',', '', $price ); // remove comma.
}
} elseif ( ! empty( $comma_position ) ) {
$number_before_comma = (int) mb_substr( $price, 0, $comma_position );
$digits_count_after_comma = mb_strlen( mb_substr( $price, $comma_position + 1 ) );
$price = str_replace(
',',
3 === $digits_count_after_comma && 0 !== $number_before_comma ? '' : '.',
$price
);
}
$price = preg_replace( '/[^0-9.]/', '', $price );
return floatval( $price );
}
/**
* Checks currency code is a zero decimal currency.
*
* @since 4.1.0
*
* @param string $currency Stripe currency ISO code.
*
* @return bool
*/
function learndash_is_zero_decimal_currency( string $currency = '' ): bool {
$zero_decimal_currencies = array(
'BIF',
'CLP',
'DJF',
'GNF',
'JPY',
'KMF',
'KRW',
'MGA',
'PYG',
'RWF',
'VND',
'VUV',
'XAF',
'XOF',
'XPF',
);
return in_array( strtoupper( $currency ), $zero_decimal_currencies, true );
}
/**
* Gets the course price.
*
* Return an array of price type, amount and cycle.
*
* @since 3.0.0
* @since 4.1.0 Optional $user_id param added.
* @since 4.5.0 Param $user_id is not nullable.
*
* @global WP_Post $post Global post object.
*
* @param int|WP_Post|null $course Course `WP_Post` object or post ID. Default to global $post.
* @param int $user_id User ID. Default to current user ID.
*
* @return array Course price details.
*/
function learndash_get_course_price( $course = null, int $user_id = 0 ): array {
if ( is_null( $course ) ) {
global $post;
$course = $post;
}
if ( is_numeric( $course ) ) {
$course = get_post( $course );
}
if ( ! is_a( $course, 'WP_Post' ) ) {
return array();
}
// Get the course price.
$meta = get_post_meta( $course->ID, '_sfwd-courses', true );
$pricing = array(
'type' => ! empty( $meta['sfwd-courses_course_price_type'] )
? $meta['sfwd-courses_course_price_type']
: LEARNDASH_DEFAULT_COURSE_PRICE_TYPE,
'price' => ! empty( $meta['sfwd-courses_course_price'] )
? $meta['sfwd-courses_course_price']
: '',
);
// Get the price a user had when was applying a coupon.
if ( 0 === $user_id ) {
$user_id = get_current_user_id();
}
if (
$user_id > 0 &&
learndash_get_price_as_float( strval( $pricing['price'] ) ) > 0 &&
learndash_post_has_attached_coupon( $course->ID, $user_id )
) {
$attached_coupon_data = learndash_get_attached_coupon_data( $course->ID, $user_id );
if ( ! empty( $attached_coupon_data ) ) {
$pricing['price'] = $attached_coupon_data->price;
}
}
// Add subscription data.
if ( LEARNDASH_PRICE_TYPE_SUBSCRIBE === $pricing['type'] ) {
$interval = intval( learndash_get_setting( $course->ID, 'course_price_billing_p3' ) );
$frequency = strval( learndash_get_setting( $course->ID, 'course_price_billing_t3' ) );
$repeats = intval( learndash_get_setting( $course->ID, 'course_no_of_cycles' ) );
$trial_interval = intval( learndash_get_setting( $course->ID, 'course_trial_duration_p1' ) );
$trial_frequency = strval( learndash_get_setting( $course->ID, 'course_trial_duration_t1' ) );
$pricing['interval'] = $interval;
$pricing['frequency'] = learndash_get_grammatical_number_label_for_interval( $interval, $frequency );
$pricing['frequency_raw'] = $frequency;
$pricing['repeats'] = $repeats;
$pricing['repeat_frequency'] = empty( $repeats ) ? '' : learndash_get_grammatical_number_label_for_interval( $repeats, $frequency );
$pricing['trial_price'] = strval( learndash_get_setting( $course->ID, 'course_trial_price' ) );
$pricing['trial_interval'] = $trial_interval;
$pricing['trial_frequency'] = empty( $trial_interval ) ? '' : learndash_get_grammatical_number_label_for_interval( $trial_interval, $trial_frequency );
$pricing['trial_frequency_raw'] = $trial_frequency;
}
/**
* Filters price details for a course.
*
* @since 3.0.0
*
* @param array $pricing Course price details.
*/
return apply_filters( 'learndash_get_course_price', $pricing );
}
/**
* Get group price
*
* Return an array of price type, amount and cycle
*
* @since 3.2.0
* @since 4.1.0 Optional $user_id param added.
* @since 4.5.0 Param $user_id is not nullable.
*
* @param int|WP_Post|null $group Group `WP_Post` object or post ID. Default to global $post.
* @param int $user_id User ID. Default to current user id.
*
* @return array price details.
*/
function learndash_get_group_price( $group = null, int $user_id = 0 ): array {
if ( is_null( $group ) ) {
global $post;
$group = $post;
}
if ( is_numeric( $group ) ) {
$group = get_post( $group );
}
if ( ! is_a( $group, 'WP_Post' ) ) {
return array();
}
// Get the group price.
$meta = get_post_meta( $group->ID, '_groups', true );
$pricing = array(
'type' => ! empty( $meta['groups_group_price_type'] )
? $meta['groups_group_price_type']
: LEARNDASH_DEFAULT_GROUP_PRICE_TYPE,
'price' => ! empty( $meta['groups_group_price'] )
? $meta['groups_group_price']
: '',
);
// Get the price a user had when was applying a coupon.
if ( 0 === $user_id ) {
$user_id = get_current_user_id();
}
if (
$user_id > 0 &&
learndash_get_price_as_float( strval( $pricing['price'] ) ) > 0 &&
learndash_post_has_attached_coupon( $group->ID, $user_id )
) {
$attached_coupon_data = learndash_get_attached_coupon_data( $group->ID, $user_id );
if ( ! empty( $attached_coupon_data ) ) {
$pricing['price'] = $attached_coupon_data->price;
}
}
// Add subscription data.
if ( LEARNDASH_PRICE_TYPE_SUBSCRIBE === $pricing['type'] ) {
$interval = intval( learndash_get_setting( $group->ID, 'group_price_billing_p3' ) );
$frequency = strval( learndash_get_setting( $group->ID, 'group_price_billing_t3' ) );
$repeats = intval( learndash_get_setting( $group->ID, 'post_no_of_cycles' ) );
$trial_interval = intval( learndash_get_setting( $group->ID, 'group_trial_duration_p1' ) );
$trial_frequency = strval( learndash_get_setting( $group->ID, 'group_trial_duration_t1' ) );
$pricing['interval'] = $interval;
$pricing['frequency'] = learndash_get_grammatical_number_label_for_interval( $interval, $frequency );
$pricing['frequency_raw'] = $frequency;
$pricing['repeats'] = $repeats;
$pricing['repeat_frequency'] = empty( $repeats ) ? '' : learndash_get_grammatical_number_label_for_interval( $repeats, $frequency );
$pricing['trial_price'] = strval( learndash_get_setting( $group->ID, 'group_trial_price' ) );
$pricing['trial_interval'] = $trial_interval;
$pricing['trial_frequency'] = empty( $trial_interval ) ? '' : learndash_get_grammatical_number_label_for_interval( $trial_interval, $trial_frequency );
$pricing['trial_frequency_raw'] = $trial_frequency;
}
/**
* Filter Group Price details.
*
* @since 3.2.0
*
* @param array $pricing Group Price Details array.
*/
return apply_filters( 'learndash_get_group_price', $pricing );
}
/**
* Get the singular or plural label for recurring payment intervals
*
* @since 3.6.0
* @since 4.5.0 $interval must be integer.
*
* @param int $interval Number of payment intervals.
* @param string $frequency A symbol for day, week, month or year.
* @param bool $short_version Whether to return the short version of the label.
*
* @return string
*/
function learndash_get_grammatical_number_label_for_interval( int $interval, string $frequency, bool $short_version = false ): string {
switch ( $frequency ) {
case ( 'D' ):
return _n( 'day', 'days', $interval, 'learndash' );
case ( 'W' ):
return $short_version
? _n( 'wk', 'wks', $interval, 'learndash' )
: _n( 'week', 'weeks', $interval, 'learndash' );
case ( 'M' ):
return $short_version
? _n( 'mo', 'mos', $interval, 'learndash' )
: _n( 'month', 'months', $interval, 'learndash' );
case ( 'Y' ):
return $short_version
? _n( 'yr', 'yrs', $interval, 'learndash' )
: _n( 'year', 'years', $interval, 'learndash' );
default:
return '';
}
}
/**
* Generates the LearnDash payment buttons output.
*
* @since 2.1.0
*
* @param int|WP_Post $post Post ID or `WP_Post` object.
*
* @return string The payment buttons HTML output.
*/
function learndash_payment_buttons( $post ): string {
$payment_button_generator = new Learndash_Payment_Button( $post );
/**
* Filters payment button HTML right before output. Fires in the end.
*
* @since 4.5.0
*
* @param string $button Payment button HTML markup. Can contain all types of buttons.
*
* @return string Payment button HTML markup.
*/
$button = (string) apply_filters( 'learndash_payment_button_markup', $payment_button_generator->map() );
/**
* Fires when the payment button is added.
*
* @since 4.5.0
*
* @param string $button Payment button HTML markup. Can contain all types of buttons.
*/
do_action( 'learndash_payment_button_added', $button );
return $button;
}
/**
* Output array of country currency code data.
*
* @since 4.4.0
*
* @return array
*/
function learndash_currency_codes_list(): array {
$currency_codes = array();
$currency_codes_array = array_map( 'str_getcsv', file( LEARNDASH_LMS_PLUGIN_DIR . 'assets/misc/payment-currencies.csv' ) );
// Remove CSV headers from array.
unset( $currency_codes_array[0] );
foreach ( $currency_codes_array as $code ) {
[
$country,
$currency,
$currency_code,
$numeric_code,
$minor_unit,
$withdrawal_date,
] = $code;
$currency_codes[] = array(
'currency_code' => $currency_code,
'option_label' => ucwords( mb_strtolower( $country ) ) . ' (' . learndash_get_currency_symbol( $currency_code ) . ') ',
'country' => $country,
'currency' => mb_strtoupper( $currency ),
);
}
/**
* Filters list of currency codes.
*
* @since 4.4.0
*
* @param array $currency_codes List of currency codes.
*/
return apply_filters( 'learndash_currency_code_list', $currency_codes );
}