| Current File : /home/kelaby89/jrncommunityhousing.charity/wp-content/plugins/give/includes/forms/functions.php |
<?php
/**
* Give Form Functions
*
* @package GiveWP
* @subpackage Includes/Forms
* @copyright Copyright (c) 2016, GiveWP
* @license https://opensource.org/licenses/gpl-license GNU Public License
* @since 1.1
*/
// Exit if accessed directly.
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
use Give\Helpers\Form\Utils as FormUtils;
/**
* Filter: Do not show the Give shortcut button on Give Forms CPT
*
* @return bool
*/
function give_shortcode_button_condition() {
global $typenow;
if ( $typenow != 'give_forms' ) {
return true;
}
return false;
}
add_filter( 'give_shortcode_button_condition', 'give_shortcode_button_condition' );
/**
* Get the form ID from the form $args
*
* @param array $args
*
* @return int|false
*/
function get_form_id_from_args( $args ) {
if ( isset( $args['form_id'] ) && $args['form_id'] != 0 ) {
return intval( $args['form_id'] );
}
return false;
}
/**
* Checks whether floating labels is enabled for the form ID in $args
*
* @since 1.1
*
* @param array $args
*
* @return bool
*/
function give_is_float_labels_enabled( $args ) {
$float_labels = '';
if ( ! empty( $args['float_labels'] ) ) {
$float_labels = $args['float_labels'];
}
if ( empty( $float_labels ) ) {
$float_labels = give_get_meta( $args['form_id'], '_give_form_floating_labels', true );
}
if ( empty( $float_labels ) || ( 'global' === $float_labels ) ) {
$float_labels = give_get_option( 'floatlabels', 'disabled' );
}
// If the form is using a non-legacy form template, do not use floating labels
if ( ! FormUtils::isLegacyForm( $args['form_id'] ) ) {
$float_labels = 'disabled';
}
return give_is_setting_enabled( $float_labels );
}
/**
* Determines if a user can checkout or not
*
* Allows themes and plugins to set donation checkout conditions
*
* @since 1.0
*
* @return bool Can user checkout?
*/
function give_can_checkout() {
$can_checkout = true;
return (bool) apply_filters( 'give_can_checkout', $can_checkout );
}
/**
* Retrieve the Success page URI
*
* @access public
* @since 1.0
*
* @return string
*/
function give_get_success_page_uri() {
$give_options = give_get_settings();
$success_page = isset( $give_options['success_page'] )
? get_permalink( absint( $give_options['success_page'] ) )
: get_bloginfo( 'url' );
return apply_filters( 'give_get_success_page_uri', $success_page );
}
/**
* Determines if we're currently on the Success page.
*
* @since 1.0
*
* @return bool True if on the Success page, false otherwise.
*/
function give_is_success_page() {
$give_options = give_get_settings();
$success_page = isset( $give_options['success_page'] ) ? is_page( $give_options['success_page'] ) : false;
return apply_filters( 'give_is_success_page', $success_page );
}
/**
* @since 4.0.0
*
* @return bool
*/
function give_is_campaign_page() {
$currentId = get_the_ID();
return (bool)get_post_meta( $currentId, 'give_campaign_id', true );
}
/**
* Send To Success Page
*
* Sends the user to the success page.
*
* @param string $query_string
*
* @access public
* @since 1.0
* @return void
*/
function give_send_to_success_page( $query_string = null ) {
$redirect = give_get_success_page_uri();
if ( $query_string ) {
$redirect .= $query_string;
}
$gateway = isset( $_REQUEST['give-gateway'] ) ? give_clean( $_REQUEST['give-gateway'] ) : '';
wp_redirect( apply_filters( 'give_success_page_redirect', $redirect, $gateway, $query_string ) );
give_die();
}
/**
* Send back to donation form.
*
* Used to redirect a user back to the donation form if there are errors present.
*
* @param array|string $args
*
* @access public
* @since 2.21.0 Auto set "payment-mode" in redirect url.
* @since 1.0
* @return Void
*/
function give_send_back_to_checkout( $args = [] ) {
$url = isset( $_POST['give-current-url'] ) ? sanitize_text_field( $_POST['give-current-url'] ) : '';
$form_id = 0;
$defaults = [];
// Set the form_id.
if ( isset( $_POST['give-form-id'] ) ) {
$defaults['form-id'] = (int) sanitize_text_field( $_POST['give-form-id'] );
}
// Set the payment mode.
if ( isset( $_POST['payment-mode'] ) ) {
$defaults['payment-mode'] = sanitize_text_field( $_POST['payment-mode'] );
}
// Need a URL to continue. If none, redirect back to single form.
if ( empty( $url ) ) {
wp_safe_redirect( get_permalink( $form_id ) );
give_die();
}
// Set the $level_id.
if ( isset( $_POST['give-price-id'] ) ) {
$defaults['level-id'] = sanitize_text_field( $_POST['give-price-id'] );
// If custom, set amount
if( 'custom' === $defaults[ 'level-id' ] ) {
$defaults['custom-amount'] = sanitize_text_field( $_POST['give-amount'] );
}
}
// Check for backward compatibility.
if ( is_string( $args ) ) {
$args = str_replace( '?', '', $args );
}
$args = wp_parse_args( $args, $defaults );
// Merge URL query with $args to maintain third-party URL parameters after redirect.
$redirect = add_query_arg( $args, $url );
// Precaution: don't allow any CC info.
$redirect = remove_query_arg( [ 'card_number', 'card_cvc' ], $redirect );
// Redirect them.
$redirect .= "#give-form-{$form_id}-wrap";
/**
* Filter the redirect url
*/
wp_safe_redirect( esc_url_raw( apply_filters( 'give_send_back_to_checkout', $redirect, $args ) ) );
give_die();
}
/**
* Get Success Page URL
*
* Gets the success page URL.
*
* @param string $query_string
*
* @access public
* @since 1.0
* @return string
*/
function give_get_success_page_url( $query_string = null ) {
$success_page = give_get_success_page_uri();
if ( $query_string ) {
$success_page .= $query_string;
}
return apply_filters( 'give_success_page_url', $success_page );
}
/**
* Get the URL of the Failed Donation Page.
*
* @since 1.0
*
* @param bool $extras Extras to append to the URL.
*
* @return mixed Full URL to the Failed Donation Page, if present, home page if it doesn't exist.
*/
function give_get_failed_transaction_uri( $extras = false ) {
$give_options = give_get_settings();
// Remove question mark.
if ( 0 === strpos( $extras, '?' ) ) {
$extras = substr( $extras, 1 );
}
$extras_args = wp_parse_args( $extras );
// Set nonce if payment id exist in extra params.
if ( array_key_exists( 'payment-id', $extras_args ) ) {
$extras_args['_wpnonce'] = wp_create_nonce( "give-failed-donation-{$extras_args['payment-id']}" );
$extras = http_build_query( $extras_args );
}
$uri = ! empty( $give_options['failure_page'] ) ?
trailingslashit( get_permalink( $give_options['failure_page'] ) ) :
home_url();
if ( $extras ) {
$uri .= "?{$extras}";
}
return apply_filters( 'give_get_failed_transaction_uri', $uri );
}
/**
* Determines if we're currently on the Failed Donation Page.
*
* @since 1.0
* @return bool True if on the Failed Donation Page, false otherwise.
*/
function give_is_failed_transaction_page() {
$give_options = give_get_settings();
$ret = isset( $give_options['failure_page'] ) ? is_page( $give_options['failure_page'] ) : false;
return apply_filters( 'give_is_failure_page', $ret );
}
/**
* Mark payments as Failed when returning to the Failed Donation Page
*
* @since 1.0
* @since 1.8.16 Add security check
*
* @return bool
*/
function give_listen_for_failed_payments() {
$payment_id = ! empty( $_GET['payment-id'] ) ? absint( $_GET['payment-id'] ) : 0;
$nonce = ! empty( $_GET['_wpnonce'] ) ? give_clean( $_GET['_wpnonce'] ) : false;
// Bailout.
if ( ! $payment_id || ! wp_verify_nonce( $nonce, "give-failed-donation-{$payment_id}" ) ) {
return false;
}
// Set payment status to failure
give_update_payment_status( $payment_id, 'failed' );
}
add_action( 'template_redirect', 'give_listen_for_failed_payments', 0 );
/**
* Retrieve the Donation History page URI
*
* @access public
* @since 1.7
*
* @return string
*/
function give_get_history_page_uri() {
$give_options = give_get_settings();
$history_page = isset( $give_options['history_page'] ) ? get_permalink( absint( $give_options['history_page'] ) ) : get_bloginfo( 'url' );
return apply_filters( 'give_get_history_page_uri', $history_page );
}
/**
* Determines if we're currently on the History page.
*
* @since 1.0
*
* @return bool True if on the History page, false otherwise.
*/
function give_is_history_page() {
$give_options = give_get_settings();
$history_page = isset( $give_options['history_page'] ) ? absint( $give_options['history_page'] ) : 0;
return apply_filters( 'give_is_history_page', is_page( $history_page ) );
}
/**
* Check if a field is required
*
* @param string $field
* @param int $form_id
*
* @access public
* @since 1.0
* @return bool
*/
function give_field_is_required( $field, $form_id ) {
$required_fields = give_get_required_fields( $form_id );
return array_key_exists( $field, $required_fields );
}
/**
* Record Donation In Log
*
* Stores log information for a donation.
*
* @since 1.0
*
* @param int $give_form_id Give Form ID.
* @param int $payment_id Payment ID.
* @param bool|int $price_id Price ID, if any.
* @param string|null $donation_date The date of the donation.
*
* @since 2.12.0 default value for the $give_form_id parameter is removed to prevent PHP8 warnings.
*
* @return void
*/
function give_record_donation_in_log( $give_form_id, $payment_id, $price_id = false, $donation_date = null ) {
$log_data = [
'log_content' => 'Payment log info',
'log_parent' => $payment_id,
'log_type' => 'sale',
'log_date' => isset( $donation_date ) ? $donation_date : null,
'log_date_gmt' => isset( $donation_date ) ? $donation_date : null,
];
$log_meta = [
'form_id' => $give_form_id,
'price_id' => (int) $price_id,
];
Give()->logs->insert_log( $log_data, $log_meta );
}
/**
* Increases the donation total count of a donation form.
*
* @since 1.0
*
* @param int $form_id Give Form ID
* @param int $quantity Quantity to increase donation count by
*
* @return bool|int
*/
function give_increase_donation_count( $form_id = 0, $quantity = 1 ) {
$quantity = (int) $quantity;
/** @var \Give_Donate_Form $form */
$form = new Give_Donate_Form( $form_id );
return $form->increase_sales( $quantity );
}
/**
* Update the goal progress count of a donation form.
*
* @since 2.4.0
*
* @param int $form_id Give Form ID
*
* @return void
*/
function give_update_goal_progress( $form_id = 0 ) {
// Get goal option meta key
$is_goal_enabled = give_is_setting_enabled( give_get_meta( $form_id, '_give_goal_option', true, 'disabled' ) );
// Check, if the form goal is enabled.
if ( $is_goal_enabled ) {
$goal_stats = give_goal_progress_stats( $form_id );
$form_goal_progress_value = ! empty( $goal_stats['progress'] ) ? $goal_stats['progress'] : 0;
} else {
$form_goal_progress_value = -1;
}
give_update_meta( $form_id, '_give_form_goal_progress', $form_goal_progress_value );
}
/**
* Decreases the sale count of a form. Primarily for when a donation is refunded.
*
* @since 1.0
*
* @param int $form_id Give Form ID
* @param int $quantity Quantity to increase donation count by
*
* @return bool|int
*/
function give_decrease_donation_count( $form_id = 0, $quantity = 1 ) {
$quantity = (int) $quantity;
/** @var \Give_Donate_Form $form */
$form = new Give_Donate_Form( $form_id );
return $form->decrease_sales( $quantity );
}
/**
* Increases the total earnings of a form.
*
* @since 1.0
*
* @since 2.1 Pass donation id.
*
* @param int $give_form_id Give Form ID
* @param int $amount Earnings
* @param int $payment_id Donation ID.
*
* @since 2.12.0 default value for the $give_form_id parameter is removed to prevent PHP8 warnings.
*
* @return bool|int
*/
function give_increase_earnings( $give_form_id, $amount, $payment_id = 0 ) {
/** @var \Give_Donate_Form $form */
$form = new Give_Donate_Form( $give_form_id );
return $form->increase_earnings( $amount, $payment_id );
}
/**
* Decreases the total earnings of a form.
*
* Primarily for when a donation is refunded.
*
* @since 1.0
*
* @since 2.1 Pass donation id.
*
* @param int $form_id Give Form ID
* @param int $amount Earnings
* @param int $payment_id Donation ID.
*
* @since 2.12.0 default value for the $form_id parameter is removed to prevent PHP8 warnings.
*
* @return bool|int
*/
function give_decrease_form_earnings( $form_id, $amount, $payment_id = 0 ) {
/** @var \Give_Donate_Form $form */
$form = new Give_Donate_Form( $form_id );
return $form->decrease_earnings( $amount, $payment_id );
}
/**
* Returns the total earnings for a form.
*
* @since 1.0
*
* @param int $form_id Give Form ID
*
* @return int $earnings Earnings for a certain form
*/
function give_get_form_earnings_stats( $form_id = 0 ) {
$give_form = new Give_Donate_Form( $form_id );
/**
* Filter the form earnings
*
* @since 1.8.17
*/
return apply_filters( 'give_get_form_earnings_stats', $give_form->earnings, $form_id, $give_form );
}
/**
* Return the sales number for a form.
*
* @since 1.0
*
* @param int $give_form_id Give Form ID
*
* @return int $sales Amount of sales for a certain form
*/
function give_get_form_sales_stats( $give_form_id = 0 ) {
$give_form = new Give_Donate_Form( $give_form_id );
return $give_form->sales;
}
/**
* Retrieves the average monthly sales for a specific donation form
*
* @since 1.0
*
* @param int $form_id Form ID
*
* @return float $sales Average monthly sales
*/
function give_get_average_monthly_form_sales( $form_id = 0 ) {
$sales = give_get_form_sales_stats( $form_id );
$release_date = get_post_field( 'post_date', $form_id );
$diff = abs( current_time( 'timestamp' ) - strtotime( $release_date ) );
$months = floor( $diff / ( 30 * 60 * 60 * 24 ) ); // Number of months since publication
if ( $months > 0 ) {
$sales = ( $sales / $months );
}
return $sales;
}
/**
* Retrieves the average monthly earnings for a specific form
*
* @since 1.0
*
* @param int $form_id Form ID
*
* @return float $earnings Average monthly earnings
*/
function give_get_average_monthly_form_earnings( $form_id = 0 ) {
$earnings = give_get_form_earnings_stats( $form_id );
$release_date = get_post_field( 'post_date', $form_id );
$diff = abs( current_time( 'timestamp' ) - strtotime( $release_date ) );
$months = floor( $diff / ( 30 * 60 * 60 * 24 ) ); // Number of months since publication
if ( $months > 0 ) {
$earnings = ( $earnings / $months );
}
return $earnings < 0 ? 0 : $earnings;
}
/**
* Get Price Option Name (Text)
*
* Retrieves the name of a variable price option.
*
* @since 1.0
*
* @param int $form_id ID of the donation form.
* @param int $price_id ID of the price option.
* @param int $payment_id payment ID for use in filters ( optional ).
* @param bool $use_fallback Outputs the level amount if no level text is provided.
*
* @return string $price_name Name of the price option
*/
function give_get_price_option_name( $form_id = 0, $price_id = 0, $payment_id = 0, $use_fallback = true ) {
$prices = give_get_variable_prices( $form_id );
$price_name = '';
if ( ! $prices ) {
return $price_name;
}
foreach ( $prices as $price ) {
if ( intval( $price['_give_id']['level_id'] ) === intval( $price_id ) ) {
$price_text = apply_filters( 'give_form_level_text', isset( $price['_give_text'] ) ? $price['_give_text'] : '', $form_id, $price );
$price_fallback = $use_fallback ?
give_currency_filter(
give_format_amount(
$price['_give_amount'],
[ 'sanitize' => false ]
),
[ 'decode_currency' => true ]
) : '';
$price_name = ! empty( $price_text ) ? $price_text : $price_fallback;
}
}
return apply_filters( 'give_get_price_option_name', $price_name, $form_id, $payment_id, $price_id );
}
/**
* Retrieves a price from from low to high of a variable priced form
*
* @since 1.0
*
* @param int $form_id ID of the form
* @param bool $formatted Flag to decide which type of price range string return
*
* @return string $range A fully formatted price range
*/
function give_price_range( $form_id = 0, $formatted = true ) {
$low = give_get_lowest_price_option( $form_id );
$high = give_get_highest_price_option( $form_id );
$order_type = ! empty( $_REQUEST['order'] ) ? $_REQUEST['order'] : 'asc';
$range = sprintf(
'<span class="give_price_range_%1$s">%2$s</span><span class="give_price_range_sep"> – </span><span class="give_price_range_%3$s">%4$s</span>',
'asc' === $order_type ? 'low' : 'high',
'asc' === $order_type ? give_currency_filter( give_format_amount( $low, [ 'sanitize' => false ] ) ) : give_currency_filter( give_format_amount( $high, [ 'sanitize' => false ] ) ),
'asc' === $order_type ? 'high' : 'low',
'asc' === $order_type ? give_currency_filter( give_format_amount( $high, [ 'sanitize' => false ] ) ) : give_currency_filter( give_format_amount( $low, [ 'sanitize' => false ] ) )
);
if ( ! $formatted ) {
$range = wp_strip_all_tags( $range );
}
return apply_filters( 'give_price_range', $range, $form_id, $low, $high );
}
/**
* Get Lowest Price ID
*
* Retrieves the ID for the cheapest price option of a variable donation form
*
* @since 1.5
*
* @param int $form_id ID of the donation
*
* @return int ID of the lowest price
*/
function give_get_lowest_price_id( $form_id = 0 ) {
if ( empty( $form_id ) ) {
$form_id = get_the_ID();
}
if ( ! give_has_variable_prices( $form_id ) ) {
return give_get_form_price( $form_id );
}
$prices = give_get_variable_prices( $form_id );
$min = $min_id = 0;
if ( ! empty( $prices ) ) {
foreach ( $prices as $key => $price ) {
if ( empty( $price['_give_amount'] ) ) {
continue;
}
if ( ! isset( $min ) ) {
$min = $price['_give_amount'];
} else {
$min = min( $min, $price['_give_amount'] );
}
if ( $price['_give_amount'] == $min ) {
$min_id = $price['_give_id']['level_id'];
}
}
}
return (int) $min_id;
}
/**
* Retrieves cheapest price option of a variable priced form
*
* @since 1.0
*
* @param int $form_id ID of the form
*
* @return float Amount of the lowest price
*/
function give_get_lowest_price_option( $form_id = 0 ) {
if ( empty( $form_id ) ) {
$form_id = get_the_ID();
}
if ( ! give_has_variable_prices( $form_id ) ) {
return give_get_form_price( $form_id );
}
if ( ! ( $low = get_post_meta( $form_id, '_give_levels_minimum_amount', true ) ) ) {
// Backward compatibility.
$prices = wp_list_pluck( give_get_variable_prices( $form_id ), '_give_amount' );
$low = ! empty( $prices ) ? min( $prices ) : 0;
}
return give_maybe_sanitize_amount( $low );
}
/**
* Retrieves most expensive price option of a variable priced form
*
* @since 1.0
*
* @param int $form_id ID of the form
*
* @return float Amount of the highest price
*/
function give_get_highest_price_option( $form_id = 0 ) {
if ( empty( $form_id ) ) {
$form_id = get_the_ID();
}
if ( ! give_has_variable_prices( $form_id ) ) {
return give_get_form_price( $form_id );
}
if ( ! ( $high = get_post_meta( $form_id, '_give_levels_maximum_amount', true ) ) ) {
// Backward compatibility.
$prices = wp_list_pluck( give_get_variable_prices( $form_id ), '_give_amount' );
$high = ! empty( $prices ) ? max( $prices ) : 0;
}
return give_maybe_sanitize_amount( $high );
}
/**
* Returns the price of a form, but only for non-variable priced forms.
*
* @since 1.0
*
* @param int $form_id ID number of the form to retrieve a price for
*
* @return mixed string|int Price of the form
*/
function give_get_form_price( $form_id = 0 ) {
if ( empty( $form_id ) ) {
return false;
}
$form = new Give_Donate_Form( $form_id );
return $form->__get( 'price' );
}
/**
* Returns the minimum price amount of a form, only enforced for the custom amount input.
*
* @since 1.3.6
*
* @param int $form_id ID number of the form to retrieve the minimum price for
*
* @return mixed string|int Minimum price of the form
*/
function give_get_form_minimum_price( $form_id = 0 ) {
if ( empty( $form_id ) ) {
return false;
}
$form = new Give_Donate_Form( $form_id );
return $form->get_minimum_price();
}
/**
* Return the maximum price amount of form.
*
* @since 2.1
*
* @param int $form_id Donate Form ID
*
* @return bool|float
*/
function give_get_form_maximum_price( $form_id = 0 ) {
if ( empty( $form_id ) ) {
return false;
}
$form = new Give_Donate_Form( $form_id );
return $form->get_maximum_price();
}
/**
* Displays a formatted price for a donation form
*
* @since 1.0
*
* @param int $form_id ID of the form price to show
* @param bool $echo Whether to echo or return the results
* @param bool|int $price_id Optional price id for variable pricing
*
* @return int $formatted_price
*/
function give_price( $form_id = 0, $echo = true, $price_id = false ) {
$price = 0;
if ( empty( $form_id ) ) {
$form_id = get_the_ID();
}
if ( give_has_variable_prices( $form_id ) ) {
$prices = give_get_variable_prices( $form_id );
if ( false !== $price_id ) {
// loop through multi-prices to see which is default
foreach ( $prices as $price ) {
// this is the default price
if ( isset( $price['_give_default'] ) && $price['_give_default'] === 'default' ) {
$price = (float) $price['_give_amount'];
};
}
} else {
$price = give_get_lowest_price_option( $form_id );
}
} else {
$price = give_get_form_price( $form_id );
}
$price = apply_filters( 'give_form_price', give_maybe_sanitize_amount( $price ), $form_id );
$formatted_price = '<span class="give_price" id="give_price_' . $form_id . '">' . $price . '</span>';
$formatted_price = apply_filters( 'give_form_price_after_html', $formatted_price, $form_id, $price );
if ( $echo ) {
echo $formatted_price;
} else {
return $formatted_price;
}
}
add_filter( 'give_form_price', 'give_format_amount', 10 );
add_filter( 'give_form_price', 'give_currency_filter', 20 );
/**
* Retrieves the amount of a variable price option
*
* @since 1.0
*
* @param int $form_id ID of the form
* @param int $price_id ID of the price option
*
* @return float $amount Amount of the price option
*/
function give_get_price_option_amount( $form_id = 0, $price_id = 0 ) {
$prices = give_get_variable_prices( $form_id );
$amount = 0.00;
foreach ( $prices as $price ) {
if ( isset( $price['_give_id']['level_id'] ) && $price['_give_id']['level_id'] == $price_id ) {
$amount = isset( $price['_give_amount'] ) ? $price['_give_amount'] : 0.00;
break;
}
}
/**
* Filter the price amount
*
* @since 1.0
*/
return apply_filters(
'give_get_price_option_amount',
give_maybe_sanitize_amount( $amount, [ 'currency' => give_get_currency( $form_id ) ] ),
$form_id,
$price_id
);
}
/**
* Returns the goal of a form
*
* @since 1.0
*
* @param int $form_id ID number of the form to retrieve a goal for
*
* @return mixed string|int Goal of the form
*/
function give_get_form_goal( $form_id = 0 ) {
if ( empty( $form_id ) ) {
return false;
}
$form = new Give_Donate_Form( $form_id );
return $form->goal;
}
/**
* Returns the goal format of a form
*
* @since 2.0
*
* @param int $form_id ID number of the form to retrieve a goal for
*
* @return mixed string|int Goal of the form
*/
function give_get_form_goal_format( $form_id = 0 ) {
if ( empty( $form_id ) ) {
return false;
}
return give_get_meta( $form_id, '_give_goal_format', true );
}
/**
* Display/Return a formatted goal for a donation form
*
* @since 1.0
*
* @param int $form_id ID of the form price to show
* @param bool $echo Whether to echo or return the results
*
* @return string $formatted_goal
*/
function give_goal( $form_id = 0, $echo = true ) {
if ( empty( $form_id ) ) {
$form_id = get_the_ID();
}
$goal = give_get_form_goal( $form_id );
$goal_format = give_get_form_goal_format( $form_id );
if ( 'donation' === $goal_format ) {
$goal = "{$goal} donations";
} else {
$goal = apply_filters( 'give_form_goal', give_maybe_sanitize_amount( $goal ), $form_id );
}
$formatted_goal = sprintf(
'<span class="give_price" id="give_price_%1$s">%2$s</span>',
$form_id,
$goal
);
$formatted_goal = apply_filters( 'give_form_price_after_html', $formatted_goal, $form_id, $goal );
if ( $echo ) {
echo $formatted_goal;
} else {
return $formatted_goal;
}
}
add_filter( 'give_form_goal', 'give_format_amount', 10 );
add_filter( 'give_form_goal', 'give_currency_filter', 20 );
/**
* Checks if users can only donate when logged in
*
* @since 1.0
*
* @param int $form_id Give form ID
*
* @return bool $ret Whether or not the logged_in_only setting is set
*/
function give_logged_in_only( $form_id ) {
// If _give_logged_in_only is set to enable then guest can donate from that specific form.
// Otherwise it is member only donation form.
$val = give_get_meta( $form_id, '_give_logged_in_only', true );
$val = ! empty( $val ) ? $val : 'enabled';
$ret = ! give_is_setting_enabled( $val );
return (bool) apply_filters( 'give_logged_in_only', $ret, $form_id );
}
/**
* Checks the option for the "Register / Login Option"
*
* @since 1.4.1
*
* @param int $form_id
*
* @return string
*/
function give_show_login_register_option( $form_id ) {
$show_register_form = give_get_meta( $form_id, '_give_show_register_form', true );
return apply_filters( 'give_show_register_form', $show_register_form, $form_id );
}
/**
* Get pre fill form field values.
*
* Note: this function will extract form field values from give_purchase session data.
*
* @since 1.8
*
* @param int $form_id Form ID.
*
* @return array
*/
function _give_get_prefill_form_field_values( $form_id ) {
$logged_in_donor_info = [];
if ( is_user_logged_in() ) :
$donor_data = get_userdata( get_current_user_id() );
$donor = new Give_Donor( get_current_user_id(), true );
$donor_address = $donor->get_donor_address();
$company_name = $donor->get_company_name();
$logged_in_donor_info = [
// First name.
'give_first' => $donor_data->first_name,
// Last name.
'give_last' => $donor_data->last_name,
// Title Prefix.
'give_title' => $donor->get_meta( '_give_donor_title_prefix', true ),
// Company name.
'company_name' => $company_name,
// Email.
'give_email' => $donor_data->user_email,
// Street address 1.
'card_address' => $donor_address['line1'],
// Street address 2.
'card_address_2' => $donor_address['line2'],
// Country.
'billing_country' => $donor_address['country'],
// State.
'card_state' => $donor_address['state'],
// City.
'card_city' => $donor_address['city'],
// Zipcode
'card_zip' => $donor_address['zip'],
];
endif;
// Bailout: Auto fill form field values only form form which donor is donating.
if (
empty( $_GET['form-id'] )
|| ! $form_id
|| ( $form_id !== absint( $_GET['form-id'] ) )
) {
return $logged_in_donor_info;
}
// Get purchase data.
$give_purchase_data = Give()->session->get( 'give_purchase' );
// Get donor info from form data.
$give_donor_info_in_session = empty( $give_purchase_data['post_data'] )
? []
: $give_purchase_data['post_data'];
// Output.
return wp_parse_args( $give_donor_info_in_session, $logged_in_donor_info );
}
/**
* Get donor count of form
*
* @since 2.1.0
*
* @param int $form_id
* @param array $args
*
* @return int
*/
function give_get_form_donor_count( $form_id, $args = [] ) {
global $wpdb;
$cache_key = Give_Cache::get_key( "form_donor_count_{$form_id}", $args, false );
$donor_count = absint( Give_Cache::get_db_query( $cache_key ) );
if ( $form_id && ! $donor_count ) {
// Set arguments.
$args = wp_parse_args(
$args,
[
'unique' => true,
]
);
$donation_meta_table = Give()->payment_meta->table_name;
$donation_id_col_name = Give()->payment_meta->get_meta_type() . '_id';
$distinct = $args['unique'] ? 'DISTINCT meta_value' : 'meta_value';
$query = $wpdb->prepare(
"
SELECT COUNT({$distinct})
FROM {$donation_meta_table}
WHERE meta_key=%s
AND {$donation_id_col_name} IN(
SELECT {$donation_id_col_name}
FROM {$donation_meta_table} as pm
INNER JOIN {$wpdb->posts} as p
ON pm.{$donation_id_col_name}=p.ID
WHERE pm.meta_key=%s
AND pm.meta_value=%s
AND p.post_status=%s
)
",
'_give_payment_donor_id',
'_give_payment_form_id',
$form_id,
'publish'
);
$donor_count = absint( $wpdb->get_var( $query ) );
}
/**
* Filter the donor count
*
* @since 2.1.0
*/
$donor_count = apply_filters( 'give_get_form_donor_count', $donor_count, $form_id, $args );
return $donor_count;
}
/**
* Verify the form status.
*
* @param int $form_id Donation Form ID.
*
* @since 2.1
*
* @return void
*/
function give_set_form_closed_status( $form_id ) {
// Bailout.
if ( empty( $form_id ) ) {
return;
}
$open_form = false;
$is_goal_enabled = give_is_setting_enabled( give_get_meta( $form_id, '_give_goal_option', true, 'disabled' ) );
// Proceed, if the form goal is enabled.
if ( $is_goal_enabled ) {
$close_form_when_goal_achieved = give_is_setting_enabled( give_get_meta( $form_id, '_give_close_form_when_goal_achieved', true, 'disabled' ) );
// Proceed, if close form when goal achieved option is enabled.
if ( $close_form_when_goal_achieved ) {
$form = new Give_Donate_Form( $form_id );
$goal_progress_stats = give_goal_progress_stats( $form );
// Verify whether the form is closed or not after processing data.
$closed = $goal_progress_stats['raw_goal'] <= $goal_progress_stats['raw_actual'];
// Update form meta if verified that the form is closed.
if ( $closed ) {
give_update_meta( $form_id, '_give_form_status', 'closed' );
} else {
$open_form = true;
}
} else {
$open_form = true;
}
} else {
$open_form = true;
}
// If $open_form is true, then update form status to open.
if ( $open_form ) {
give_update_meta( $form_id, '_give_form_status', 'open' );
}
}
/**
* Show Form Goal Stats in Admin ( Listing and Detail page )
*
* @since 3.16.0 Remove "give_donate_form_get_sales" filter logic
* @since 3.14.0 Use the "give_get_form_earnings_stats" filter to ensure the correct value will be displayed in the form progress bar
* @since 2.19.0 Prevent divide by zero issue in goal percentage calculation logic.
*
* @since 2.1.0
*
* @param int $form_id Form ID.
*
* @return string
*/
function give_admin_form_goal_stats( $form_id ) {
$html = '';
$goal_stats = give_goal_progress_stats( $form_id );
$percent_complete = $goal_stats['raw_goal'] && is_numeric($goal_stats['raw_actual']) && is_numeric($goal_stats['raw_goal'])
? round(($goal_stats['raw_actual'] / $goal_stats['raw_goal']), 3) * 100
: 0;
$html .= sprintf(
'<div class="give-admin-progress-bar" role="progressbar" aria-valuemin="0" aria-valuemax="100" aria-valuenow="%1$s">
<span style="width:%1$s%%;"></span>
</div>',
esc_attr( $goal_stats['progress'] )
);
$html .= sprintf(
( 'percentage' !== $goal_stats['format'] ) ?
'<div class="give-goal-text"><span>%1$s</span> %2$s <a href="%3$s">%4$s</a> %5$s ' :
'<div class="give-goal-text"><a href="%3$s">%1$s </a>',
( 'percentage' !== $goal_stats['format'] ) ? $goal_stats['actual'] : $percent_complete . '%',
( 'percentage' !== $goal_stats['format'] ) ? __( 'of', 'give' ) : '',
esc_url( admin_url( "post.php?post={$form_id}&action=edit&give_tab=donation_goal_options" ) ),
$goal_stats['goal'],
( 'donors' === $goal_stats['format'] ? __( 'donors', 'give' ) : ( 'donation' === $goal_stats['format'] ? __( 'donations', 'give' ) : '' ) )
);
$opacity = $goal_stats['raw_actual'] >= $goal_stats['raw_goal'] ? 1 : 0;
$html .= sprintf(
'<span style="opacity:%s" class="give-admin-goal-achieved"><span class="dashicons dashicons-star-filled"></span> %s</span>',
apply_filters('give_admin_goal_progress_achieved_opacity', $opacity),
__('Goal achieved', 'give')
);
$html .= '</div>';
return $html;
}
/**
* Get the default donation form's level id.
*
* @since 2.2.0
*
* @param integer $form_id Donation Form ID.
*
* @return null | array
*/
function give_form_get_default_level( $form_id ) {
$default_level = null;
// If donation form has variable prices.
if ( give_has_variable_prices( $form_id ) ) {
/**
* Filter the variable pricing
*
* @since 1.0
* @deprecated 2.2 Use give_get_donation_levels filter instead of give_form_variable_prices.
* Check Give_Donate_Form::get_prices().
*
* @param array $prices Array of variable prices.
* @param int $form Form ID.
*/
$prices = apply_filters( 'give_form_variable_prices', give_get_variable_prices( $form_id ), $form_id );
// Go through each of the level and get the default level id.
foreach ( $prices as $level ) {
if (
isset( $level['_give_default'] )
&& $level['_give_default'] === 'default'
) {
$default_level = $level;
}
}
}
/**
* Filter the default donation level id.
*
* @since 2.2.0
*
* @param array $default_level Default level price data.
* @param integer $form_id Donation form ID.
*/
return apply_filters( 'give_form_get_default_level', $default_level, $form_id );
}
/**
* Get the default level id.
*
* @since 2.2.0
*
* @param array|integer $price_or_level_id Price level data.
* @param boolean|integer $form_id Donation Form ID.
*
* @return boolean
*/
function give_is_default_level_id( $price_or_level_id, $form_id = 0 ) {
$is_default = false;
if (
! empty( $form_id )
&& is_numeric( $price_or_level_id )
) {
// Get default level id.
$form_price_data = give_form_get_default_level( $form_id );
$is_default = ! is_null( $form_price_data ) && ( $price_or_level_id === absint( $form_price_data['_give_id']['level_id'] ) );
}
$is_default = false === $is_default && is_array( $price_or_level_id ) ?
( isset( $price_or_level_id['_give_default'] ) && $price_or_level_id['_give_default'] === 'default' )
: $is_default;
/**
* Allow developers to modify the default level id checks.
*
* @since 2.2.0
*
* @param bool $is_default True if it is default price level id otherwise false.
* @param array|integer $price_or_level_id Price Data.
*/
return apply_filters( 'give_is_default_level_id', $is_default, $price_or_level_id );
}
/**
* Get Name Title Prefixes (a.k.a. Salutation) value.
*
* @param int $form_id Donation Form ID.
*
* @since 2.2.0
*
* @return array
*/
function give_get_name_title_prefixes( $form_id = 0 ) {
$name_title_prefix = give_is_name_title_prefix_enabled( $form_id );
$title_prefixes = give_get_option( 'title_prefixes', give_get_default_title_prefixes() );
// If form id exists, then fetch form specific title prefixes.
if ( intval( $form_id ) > 0 && $name_title_prefix ) {
$form_title_prefix = give_get_meta( $form_id, '_give_name_title_prefix', true );
if ( 'global' !== $form_title_prefix ) {
$form_title_prefixes = give_get_meta( $form_id, '_give_title_prefixes', true, give_get_default_title_prefixes() );
// Check whether the form based title prefixes exists or not.
if ( is_array( $form_title_prefixes ) && count( $form_title_prefixes ) > 0 ) {
$title_prefixes = $form_title_prefixes;
}
}
}
return array_filter( (array) $title_prefixes );
}
/**
* Check whether the name title prefix is enabled or not.
*
* @param int $form_id Donation Form ID.
* @param string $status Status to set status based on option value.
*
* @since 2.2.0
*
* @return bool
*/
function give_is_name_title_prefix_enabled( $form_id = 0, $status = '' ) {
if ( empty( $status ) ) {
$status = [ 'required', 'optional' ];
} else {
$status = [ $status ];
}
$title_prefix_status = give_is_setting_enabled( give_get_option( 'name_title_prefix' ), $status );
if ( intval( $form_id ) > 0 ) {
$form_title_prefix = give_get_meta( $form_id, '_give_name_title_prefix', true );
if ( 'disabled' === $form_title_prefix ) {
$title_prefix_status = false;
} elseif ( in_array( $form_title_prefix, $status, true ) ) {
$title_prefix_status = give_is_setting_enabled( $form_title_prefix, $status );
}
}
return $title_prefix_status;
}
/**
* Get Donor Name with Title Prefix
*
* @param int|Give_Donor $donor Donor Information.
*
* @since 2.2.0
*
* @return object
*/
function give_get_name_with_title_prefixes( $donor ) {
// Prepare Give_Donor object, if $donor is numeric.
if ( is_numeric( $donor ) ) {
$donor = new Give_Donor( $donor );
}
$title_prefix = Give()->donor_meta->get_meta( $donor->id, '_give_donor_title_prefix', true );
// Update Donor name, if non empty title prefix.
if ( ! empty( $title_prefix ) ) {
$donor->name = give_get_donor_name_with_title_prefixes( $title_prefix, $donor->name );
}
return $donor;
}
/**
* This function will generate donor name with title prefix if it is required.
*
* @param string $title_prefix Title Prefix of Donor
* @param string $name Donor Name.
*
* @since 2.2.0
*
* @return string
*/
function give_get_donor_name_with_title_prefixes( $title_prefix, $name ) {
$donor_name = $name;
if ( ! empty( $title_prefix ) && ! empty( $name ) ) {
$donor_name = "{$title_prefix} {$name}";
}
return trim( $donor_name );
}
/**
* This function will fetch the default list of title prefixes.
*
* @since 2.2.0
*
* @return array
*/
function give_get_default_title_prefixes() {
/**
* Filter the data
* Set default title prefixes.
*
* @since 2.2.0
*/
return apply_filters(
'give_get_default_title_prefixes',
[
'Mr.' => __( 'Mr.', 'give' ),
'Mrs.' => __( 'Mrs.', 'give' ),
'Ms.' => __( 'Ms.', 'give' ),
]
);
}
/**
* This function will check whether the name title prefix field is required or not.
*
* @param int $form_id Donation Form ID.
*
* @since 2.2.0
*
* @return bool
*/
function give_is_name_title_prefix_required( $form_id = 0 ) {
// Bail out, if name title prefix is not enabled.
if ( ! give_is_name_title_prefix_enabled( $form_id ) ) {
return false;
}
$status = [ 'optional' ];
$is_optional = give_is_setting_enabled( give_get_option( 'name_title_prefix' ), $status );
if ( intval( $form_id ) > 0 ) {
$form_title_prefix = give_get_meta( $form_id, '_give_name_title_prefix', true );
if ( 'required' === $form_title_prefix ) {
$is_optional = false;
} elseif ( 'optional' === $form_title_prefix ) {
$is_optional = true;
}
}
return ( ! $is_optional );
}
/**
* Deletes form meta when the form is permanently deleted from the trash.
*
* @since 2.3.0
*
* @param integer $id Donation Form ID which needs to be deleted.
*
* @return void
*/
function give_handle_form_meta_on_delete( $id ) {
global $wpdb;
$form = get_post( $id );
$get_data = give_clean( $_GET );
if (
'give_forms' === $form->post_type &&
'trash' === $form->post_status &&
(
( isset( $get_data['action'] ) && 'delete' === $get_data['action'] ) ||
! empty( $get_data['delete_all'] )
)
) {
$wpdb->query( $wpdb->prepare( "DELETE FROM {$wpdb->formmeta} WHERE form_id = '%d'", $form->ID ) );
}
}
add_action( 'before_delete_post', 'give_handle_form_meta_on_delete', 10, 1 );
/**
* Get the list of default parameters for the form shortcode.
*
* @since 3.2.1 Revert default display style to "onpage".
* @since 2.4.1
*
* @return array
*/
function give_get_default_form_shortcode_args() {
$default = [
'id' => '',
'show_title' => true,
'show_goal' => true,
'show_content' => '',
'float_labels' => '',
'display_style' => '',
'continue_button_title' => '',
// This attribute belong to form template functionality.
// You can use this attribute to set modal open button background color.
'button_color' => '#28C77B',
];
/**
* Fire the filter
*/
$default = apply_filters( 'give_get_default_form_shortcode_args', $default );
return $default;
}