formatting.php — GiveWP – Donation Plugin and Fundraising Platform 2.4.7

give / includes / formatting.php

give / includes Last commit date

formatting.php

848 lines

1	<?php
2	/**
3	* Formatting functions for taking care of proper number formats and such
4	*
5	* @package Give
6	* @subpackage Functions/Formatting
7	* @copyright Copyright (c) 2016, GiveWP
8	* @license https://opensource.org/licenses/gpl-license GNU Public License
9	* @since 1.0
10	*/
11
12	// Exit if accessed directly.
13	if ( ! defined( 'ABSPATH' ) ) {
14	exit;
15	}
16
17	/**
18	* Get Currency Formatting Settings for each donation.
19	*
20	* @param int\|string $id_or_currency_code Donation ID or Currency code.
21	*
22	* @since 1.8.15
23	*
24	* @return mixed
25	*/
26	function give_get_currency_formatting_settings( $id_or_currency_code = null ) {
27	$give_options = give_get_settings();
28	$setting = array();
29
30	if ( ! empty( $id_or_currency_code ) ) {
31	$currencies = give_get_currencies( 'all' );
32
33	// Set default formatting setting only if currency not set as global currency.
34	if (
35	is_string( $id_or_currency_code ) &&
36	! empty( $give_options['currency'] ) &&
37	$id_or_currency_code !== $give_options['currency'] &&
38	array_key_exists( $id_or_currency_code, $currencies )
39	) {
40	$setting = $currencies[ $id_or_currency_code ]['setting'];
41	} elseif ( is_numeric( $id_or_currency_code ) && 'give_payment' === get_post_type( $id_or_currency_code ) ) {
42	$currency = give_get_meta( $id_or_currency_code, '_give_payment_currency', true );
43
44	if (
45	! empty( $currency) &&
46	$give_options['currency'] !== $currency
47	) {
48	$setting = $currencies[ $currency ]['setting'];
49	}
50	}
51	}
52
53	if ( empty( $setting ) ) {
54	// Set thousand separator.
55	$thousand_separator = isset( $give_options['thousands_separator'] ) ? $give_options['thousands_separator'] : ',';
56	$thousand_separator = empty( $thousand_separator ) ? ' ' : $thousand_separator;
57
58	// Set decimal separator.
59	$default_decimal_separators = array(
60	'.' => ',',
61	',' => '.',
62	);
63
64	$default_decimal_separator = in_array( $thousand_separator, $default_decimal_separators ) ?
65	$default_decimal_separators[ $thousand_separator ] :
66	'.';
67
68	$decimal_separator = ! empty( $give_options['decimal_separator'] ) ? $give_options['decimal_separator'] : $default_decimal_separator;
69
70	$setting = array(
71	'currency_position' => give_get_option( 'currency_position', 'before' ),
72	'thousands_separator' => $thousand_separator,
73	'decimal_separator' => $decimal_separator,
74	'number_decimals' => give_get_option( 'number_decimals', 0 ),
75	);
76	}
77
78	/**
79	* Filter the currency formatting setting.
80	*
81	* @since 1.8.15
82	*/
83	return apply_filters( 'give_get_currency_formatting_settings', $setting, $id_or_currency_code );
84	}
85
86	/**
87	* Get decimal count
88	*
89	* @since 1.6
90	*
91	* @param int\|string $id_or_currency_code
92	*
93	* @return mixed
94	*/
95	function give_get_price_decimals( $id_or_currency_code = null ) {
96	// Set currency on basis of donation id.
97	if ( empty( $id_or_currency_code ) ) {
98	$id_or_currency_code = give_get_currency();
99	}
100
101	$number_of_decimals = 0;
102
103	if ( ! give_is_zero_based_currency( $id_or_currency_code ) ) {
104	$setting = give_get_currency_formatting_settings( $id_or_currency_code );
105	$number_of_decimals = $setting['number_decimals'];
106	}
107
108	/**
109	* Filter the number of decimals
110	*
111	* @since 1.6
112	*/
113	return apply_filters( 'give_sanitize_amount_decimals', $number_of_decimals, $id_or_currency_code );
114	}
115
116	/**
117	* Get thousand separator
118	*
119	* @param int\|string $id_or_currency_code
120	*
121	* @since 1.6
122	*
123	* @return mixed
124	*/
125	function give_get_price_thousand_separator( $id_or_currency_code = null ) {
126	$setting = give_get_currency_formatting_settings( $id_or_currency_code );
127
128	/**
129	* Filter the thousand separator
130	*
131	* @since 1.6
132	*/
133	return apply_filters( 'give_get_price_thousand_separator', $setting['thousands_separator'], $id_or_currency_code );
134	}
135
136	/**
137	* Get decimal separator
138	*
139	* @param string $id_or_currency_code
140	*
141	* @since 1.6
142	*
143	* @return mixed
144	*/
145	function give_get_price_decimal_separator( $id_or_currency_code = null ) {
146	$setting = give_get_currency_formatting_settings( $id_or_currency_code );
147
148	/**
149	* Filter the thousand separator
150	*
151	* @since 1.6
152	*/
153	return apply_filters( 'give_get_price_decimal_separator', $setting['decimal_separator'], $id_or_currency_code );
154	}
155
156	/**
157	* Check if amount sanitized
158	* Note: only for internal purpose
159	*
160	* Current this function only check if number is DB sanitize.
161	*
162	* @param string $amount
163	*
164	* @return bool
165	* @since 2.4.5
166	*/
167	function give_is_amount_sanitized( $amount ) {
168	$is_sanitize = false;
169
170	if ( false === strpos( $amount, '.' ) ) {
171	return $is_sanitize;
172	}
173
174	$number_parts = explode( '.', $amount );
175
176	// Handle thousand separator as '.'
177	// Handle sanitize database values.
178	$is_sanitize = ( 2 === count( $number_parts ) &&
179	is_numeric( $number_parts[0] ) &&
180	is_numeric( $number_parts[1] ) &&
181	in_array( strlen( $number_parts[1] ), array( 6, 10 ) ) );
182
183	return $is_sanitize;
184	}
185
186	/**
187	* Sanitize Amount before saving to database
188	*
189	* @since 1.8.12
190	*
191	* @param int\|float\|string $number Expects either a float or a string with a decimal separator only (no thousands)
192	* @param array\|bool $args It accepts 'number_decimals', 'trim_zeros', 'currency'.
193	*
194	* @return string $amount Newly sanitized amount
195	*/
196	function give_sanitize_amount_for_db( $number, $args = array() ) {
197	$args['number_decimals'] = 6;
198
199	if (
200	( isset( $args['currency'] ) && 'BTC' === $args['currency'] )
201	\|\| 'BTC' === give_get_currency()
202	) {
203	$args['number_decimals'] = 10;
204	}
205
206	return give_maybe_sanitize_amount( $number, $args );
207	}
208
209	/**
210	* Sanitize Amount before saving to database
211	*
212	* @since 1.8.12
213	*
214	* @param int\|float\|string $number Expects either a float or a string with a decimal separator only (no thousands)
215	* @param array\|bool $args It accepts 'number_decimals', 'trim_zeros', 'currency'.
216	*
217	* @return string $amount Newly sanitized amount
218	*/
219	function give_maybe_sanitize_amount( $number, $args = array() ) {
220	// Bailout.
221	if ( empty( $number ) \|\| ( ! is_numeric( $number ) && ! is_string( $number ) ) ) {
222	return $number;
223	}
224
225	$func_args = func_get_args();
226
227	// Backward compatibility.
228	if ( isset( $func_args[1] ) && ( is_bool( $func_args[1] ) \|\| is_numeric( $func_args[1] ) ) ) {
229	$args = array(
230	'number_decimals' => $func_args[1],
231	'trim_zeros' => isset( $func_args[2] ) ? $func_args[2] : false,
232	);
233	}
234
235	$args = wp_parse_args(
236	$args,
237	array(
238	'number_decimals' => false,
239	'trim_zeros' => false,
240	'currency' => give_get_currency(),
241	)
242	);
243
244	$thousand_separator = give_get_price_thousand_separator( $args['currency'] );
245	$decimal_separator = give_get_price_decimal_separator( $args['currency'] );
246	$number_decimals = is_bool( $args['number_decimals'] ) ?
247	give_get_price_decimals( $args['currency'] ) :
248	$args['number_decimals'];
249
250	// Explode number by . decimal separator.
251	$number_parts = explode( '.', $number );
252
253	// Remove currency symbols from number if any.
254	$number = trim( str_replace( give_currency_symbols( true ), '', $number ) );
255
256	if (
257	// Non formatted number.
258	false === strpos( $number, $thousand_separator )
259	&& false === strpos( $number, $decimal_separator )
260	) {
261	return number_format( $number, $number_decimals, '.', '' );
262	} elseif (
263	// Decimal formatted number.
264	// If number of decimal place set to non zero and
265	// number only contains `.` as separator, precision set to less then or equal to number of decimal
266	// then number will be consider as decimal formatted which means number is already sanitized.
267	$number_decimals
268	&& '.' === $thousand_separator
269	&& false !== strpos( $number, $thousand_separator )
270	&& false === strpos( $number, $decimal_separator )
271	&& 2 === count( $number_parts )
272	&& ( $number_decimals >= strlen( $number_parts[1] ) )
273	) {
274	return number_format( $number, $number_decimals, '.', '' );
275	}
276
277	if ( give_is_amount_sanitized( $number ) ) {
278	// Sanitize database value.
279	return number_format( $number, $number_decimals, '.', '' );
280
281	} elseif (
282	'.' === $thousand_separator &&
283	false !== strpos( $number, $thousand_separator )
284	) {
285	// Fix point thousand separator value.
286	$number = str_replace( '.', '', $number );
287	}
288
289	return give_sanitize_amount( $number, $args );
290	}
291
292	/**
293	* Sanitize Amount
294	*
295	* Note: Do not this function to sanitize amount instead use give_maybe_sanitize_amount function.
296	*
297	* Returns a sanitized amount by stripping out thousands separators.
298	*
299	* @since 1.0
300	*
301	* @param int\|float\|string $number Expects either a float or a string with a decimal separator only (no thousands)
302	* @param array\|bool $args It accepts 'number_decimals', 'trim_zeros', 'currency'.
303	*
304	* @return string $amount Newly sanitized amount
305	*/
306	function give_sanitize_amount( $number, $args = array() ) {
307
308	// Bailout.
309	if ( empty( $number ) \|\| ( ! is_numeric( $number ) && ! is_string( $number ) ) ) {
310	return $number;
311	}
312
313	// Get function arguments.
314	$func_args = func_get_args();
315
316	// Backward compatibility.
317	if ( isset( $func_args[1] ) && ( is_bool( $func_args[1] ) \|\| is_numeric( $func_args[1] ) ) ) {
318	$args = array(
319	'number_decimals' => $func_args[1],
320	'trim_zeros' => isset( $func_args[2] ) ? $func_args[2] : false,
321	);
322	}
323
324	$args = wp_parse_args(
325	$args,
326	array(
327	'number_decimals' => false,
328	'trim_zeros' => false,
329	'currency' => give_get_currency(),
330	)
331	);
332
333	// Remove slash from amount.
334	// If thousand or decimal separator is set to ' then in $_POST or $_GET param we will get an escaped number.
335	// To prevent notices and warning remove slash from amount/number.
336	$number = wp_unslash( $number );
337
338	$thousand_separator = give_get_price_thousand_separator( $args['currency'] );
339
340	$locale = localeconv();
341	$decimals = array(
342	give_get_price_decimal_separator( $args['currency'] ),
343	$locale['decimal_point'],
344	$locale['mon_decimal_point'],
345	);
346
347	// Remove locale from string
348	if ( ! is_float( $number ) ) {
349	$number = str_replace( $decimals, '.', $number );
350	}
351
352	// Remove thousand amount formatting if amount has.
353	// This condition use to add backward compatibility to version before 1.6, because before version 1.6 we were saving formatted amount to db.
354	// Do not replace thousand separator from price if it is same as decimal separator, because it will be already replace by above code.
355	if ( ! in_array( $thousand_separator, $decimals ) && ( false !== strpos( $number, $thousand_separator ) ) ) {
356	$number = str_replace( $thousand_separator, '', $number );
357	} elseif ( in_array( $thousand_separator, $decimals ) ) {
358	$number = preg_replace( '/\.(?=.*\.)/', '', $number );
359	}
360
361	// Remove non numeric entity before decimal separator.
362	$number = preg_replace( '/[^0-9\.]/', '', $number );
363	$default_dp = give_get_price_decimals( $args['currency'] );
364
365	// Reset negative amount to zero.
366	if ( 0 > $number ) {
367	$number = number_format( 0, $default_dp, '.' );
368	}
369
370	// If number does not have decimal then add number of decimals to it.
371	if (
372	false === strpos( $number, '.' )
373	\|\| ( $default_dp > strlen( substr( $number, strpos( $number, '.' ) + 1 ) ) )
374	) {
375	$number = number_format( $number, $default_dp, '.', '' );
376	}
377
378	// Format number by custom number of decimals.
379	if ( false !== $args['number_decimals'] ) {
380	$dp = intval( is_bool( $args['number_decimals'] ) ? $default_dp : $args['number_decimals'] );
381	$dp = apply_filters( 'give_sanitize_amount_decimals', $dp, $number );
382	$number = number_format( floatval( $number ), $dp, '.', '' );
383	}
384
385	// Trim zeros.
386	if ( $args['trim_zeros'] && strstr( $number, '.' ) ) {
387	$number = rtrim( rtrim( $number, '0' ), '.' );
388	}
389
390	/**
391	* Filter the sanitize amount
392	*
393	* @since 1.0
394	*/
395	return apply_filters( 'give_sanitize_amount', $number );
396	}
397
398	/**
399	* Returns a nicely formatted amount.
400	*
401	* @since 1.0
402	*
403	* @param string $amount Price amount to format
404	* @param array $args Array of arguments.
405	*
406	* @return string $amount Newly formatted amount or Price Not Available
407	*/
408	function give_format_amount( $amount, $args = array() ) {
409	// Backward compatibility.
410	if ( is_bool( $args ) ) {
411	$args = array(
412	'decimal' => $args,
413	);
414	}
415
416	$default_args = array(
417	'decimal' => true,
418	'sanitize' => true,
419	'donation_id' => 0,
420	'currency' => '',
421	);
422
423	$args = wp_parse_args( $args, $default_args );
424
425	// Set Currency based on donation id, if required.
426	if ( $args['donation_id'] && empty( $args['currency'] ) ) {
427	$args['currency'] = give_get_meta( $args['donation_id'], '_give_payment_currency', true );
428	}
429
430	$formatted = 0;
431	$currency = ! empty( $args['currency'] ) ? $args['currency'] : give_get_currency( $args['donation_id'] );
432	$thousands_sep = give_get_price_thousand_separator( $currency );
433	$decimal_sep = give_get_price_decimal_separator( $currency );
434	$decimals = ! empty( $args['decimal'] ) ? give_get_price_decimals( $currency ) : 0;
435
436	if ( ! empty( $amount ) ) {
437	// Sanitize amount before formatting.
438	$amount = ! empty( $args['sanitize'] ) ?
439	give_maybe_sanitize_amount( $amount, array( 'number_decimals' => $decimals, 'currency' => $currency ) ) :
440	number_format( $amount, $decimals, '.', '' );
441
442	switch ( $currency ) {
443	case 'INR':
444	$decimal_amount = '';
445
446	// Extract decimals from amount
447	if ( ( $pos = strpos( $amount, '.' ) ) !== false ) {
448	if ( ! empty( $decimals ) ) {
449	$decimal_amount = substr( round( substr( $amount, $pos ), $decimals ), 1 );
450	$amount = substr( $amount, 0, $pos );
451
452	if ( ! $decimal_amount ) {
453	$decimal_amount = substr( "{$decimal_sep}0000000000", 0, ( $decimals + 1 ) );
454	} elseif ( ( $decimals + 1 ) > strlen( $decimal_amount ) ) {
455	$decimal_amount = substr( "{$decimal_amount}000000000", 0, ( $decimals + 1 ) );
456	}
457	} else {
458	$amount = number_format( $amount, $decimals, $decimal_sep, '' );
459	}
460	}
461
462	// Extract last 3 from amount
463	$result = substr( $amount, - 3 );
464	$amount = substr( $amount, 0, - 3 );
465
466	// Apply digits 2 by 2
467	while ( strlen( $amount ) > 0 ) {
468	$result = substr( $amount, - 2 ) . $thousands_sep . $result;
469	$amount = substr( $amount, 0, - 2 );
470	}
471
472	$formatted = $result . $decimal_amount;
473	break;
474
475	default:
476	$formatted = number_format( $amount, $decimals, $decimal_sep, $thousands_sep );
477	}
478	}
479
480	/**
481	* Filter the formatted amount
482	*
483	* @since 1.0
484	*/
485	return apply_filters( 'give_format_amount', $formatted, $amount, $decimals, $decimal_sep, $thousands_sep, $currency, $args );
486	}
487
488
489	/**
490	* Get human readable amount.
491	*
492	* Note: This function only support large number formatting from million to trillion
493	*
494	* @since 1.6
495	*
496	* @use give_get_price_thousand_separator Get thousand separator.
497	*
498	* @param string $amount formatted amount number.
499	* @param array $args Array of arguments.
500	*
501	* @return string formatted amount number with large number names.
502	*/
503	function give_human_format_large_amount( $amount, $args = array() ) {
504	// Sanitize amount.
505	$sanitize_amount = give_maybe_sanitize_amount( $amount );
506
507	// Bailout.
508	if ( ! floatval( $sanitize_amount ) ) {
509	return '0';
510	};
511
512	// Set default currency;
513	if ( empty( $args['currency'] ) ) {
514	$args['currency'] = give_get_currency();
515	}
516
517	// Get thousand separator.
518	$thousands_sep = give_get_price_thousand_separator();
519
520	// Explode amount to calculate name of large numbers.
521	$amount_array = explode( $thousands_sep, $amount );
522
523	// Calculate amount parts count.
524	$amount_count_parts = count( $amount_array );
525
526	// Human format amount (default).
527	$human_format_amount = $amount;
528
529	switch ( $args['currency'] ) {
530	case 'INR':
531	// Calculate large number formatted amount.
532	if ( 4 < $amount_count_parts ) {
533	$human_format_amount = sprintf( esc_html__( '%s arab', 'give' ), round( ( $sanitize_amount / 1000000000 ), 2 ) );
534	} elseif ( 3 < $amount_count_parts ) {
535	$human_format_amount = sprintf( esc_html__( '%s crore', 'give' ), round( ( $sanitize_amount / 10000000 ), 2 ) );
536	} elseif ( 2 < $amount_count_parts ) {
537	$human_format_amount = sprintf( esc_html__( '%s lakh', 'give' ), round( ( $sanitize_amount / 100000 ), 2 ) );
538	}
539	break;
540	default:
541	// Calculate large number formatted amount.
542	if ( 4 < $amount_count_parts ) {
543	$human_format_amount = sprintf( esc_html__( '%s trillion', 'give' ), round( ( $sanitize_amount / 1000000000000 ), 2 ) );
544	} elseif ( 3 < $amount_count_parts ) {
545	$human_format_amount = sprintf( esc_html__( '%s billion', 'give' ), round( ( $sanitize_amount / 1000000000 ), 2 ) );
546	} elseif ( 2 < $amount_count_parts ) {
547	$human_format_amount = sprintf( esc_html__( '%s million', 'give' ), round( ( $sanitize_amount / 1000000 ), 2 ) );
548	}
549	}
550
551	return apply_filters( 'give_human_format_large_amount', $human_format_amount, $amount, $sanitize_amount );
552	}
553
554	/**
555	* Returns a nicely formatted amount with custom decimal separator.
556	*
557	* @since 1.0
558	*
559	* @param array $args {
560	*
561	* @type int\|float\|string $amount Formatted or sanitized price. (optional if donation id set)
562	* @type int $donation_id donation amount (optional if set amount, but provide it for better result if formatting decimal amount of donation).
563	* @type string $currency donation amount (optional if set donation id). Provide either amount or donation id
564	* @type int\|bool $dp number of decimals
565	* @type bool $sanitize Whether or not sanitize number
566	* }
567	*
568	* @return string $amount Newly formatted amount or Price Not Available
569	*/
570	function give_format_decimal( $args ) {
571	// Backward compatibility.
572	if ( ! is_array( $args ) ) {
573	$func_args = func_get_args();
574	$args = array(
575	'amount' => $func_args[0],
576	'dp' => isset( $func_args[1] ) ? $func_args[1] : false,
577	'sanitize' => isset( $func_args[2] ) ? $func_args[2] : true,
578	);
579	}
580
581	$args = wp_parse_args(
582	$args,
583	array(
584	'amount' => '',
585	'donation_id' => 0,
586	'currency' => '',
587	'dp' => false,
588	'sanitize' => false,
589	)
590	);
591
592	if( ! empty( $args['donation_id'] ) ) {
593
594	// Set currency if not already done.
595	if( empty( $args['currency'] ) ) {
596	$args['currency'] = give_get_payment_currency_code( $args['donation_id'] );
597	}
598
599	// Set amount if not already done.
600	if( empty( $args['amount'] ) ) {
601	$args['amount'] = give_donation_amount( $args['donation_id'] );
602	}
603	}
604
605	$decimal_separator = give_get_price_decimal_separator();
606	$formatted_amount = $args['sanitize'] ?
607	give_maybe_sanitize_amount( $args['amount'], array( 'number_decimals' => $args['dp'], 'currency' => $args['currency'] ) ) :
608	number_format( $args['amount'], ( is_bool( $args['dp'] ) ? give_get_price_decimals( $args['currency'] ) : $args['dp'] ), '.', '' );
609
610	if ( false !== strpos( $formatted_amount, '.' ) ) {
611	$formatted_amount = str_replace( '.', $decimal_separator, $formatted_amount );
612	}
613
614	return apply_filters( 'give_format_decimal', $formatted_amount, $args['amount'], $decimal_separator, $args );
615	}
616
617	/**
618	* Get date format string on basis of given context.
619	*
620	* @since 1.7
621	*
622	* @param string $date_context Date format context name.
623	*
624	* @return string Date format string
625	*/
626	function give_date_format( $date_context = '' ) {
627	/**
628	* Filter the date context
629	*
630	* You can add your own date context or use already exist context.
631	* For example:
632	* add_filter( 'give_date_format_contexts', 'add_new_date_contexts' );
633	* function add_new_date_contexts( $date_format_contexts ) {
634	* // You can add single context like this $date_format_contexts['checkout'] = 'F j, Y';
635	* // Instead add multiple date context at once.
636	* $new_date_format_contexts = array(
637	* 'checkout' => 'F j, Y',
638	* 'report' => 'Y-m-d',
639	* 'email' => 'm/d/Y',
640	* );
641	*
642	* // Merge date contexts array only if you are adding multiple date contexts at once otherwise return $date_format_contexts.
643	* return array_merge( $new_date_format_contexts, $date_format_contexts );
644	*
645	* }
646	*/
647	$date_format_contexts = apply_filters( 'give_date_format_contexts', array() );
648
649	// Set date format to default date format.
650	$date_format = get_option( 'date_format' );
651
652	// Update date format if we have non empty date format context array and non empty date format string for that context.
653	if ( $date_context && ! empty( $date_format_contexts ) && array_key_exists( $date_context, $date_format_contexts ) ) {
654	$date_format = ! empty( $date_format_contexts[ $date_context ] )
655	? $date_format_contexts[ $date_context ]
656	: $date_format;
657	}
658
659	return apply_filters( 'give_date_format', $date_format );
660	}
661
662	/**
663	* Get cache key.
664	*
665	* @since 1.7
666	* @deprecated 1.8.7 You can access this function from Give_Cache.
667	*
668	* @param string $action Cache key prefix.
669	* @param array $query_args Query array.
670	*
671	* @return string
672	*/
673	function give_get_cache_key( $action, $query_args ) {
674	return Give_Cache::get_key( $action, $query_args );
675	}
676
677	/**
678	* Clean variables using sanitize_text_field. Arrays are cleaned recursively.
679	* Non-scalar values are ignored.
680	*
681	* @since 1.8
682	*
683	* @param string\|array $var
684	*
685	* @return string\|array
686	*/
687	function give_clean( $var ) {
688	if ( is_array( $var ) ) {
689	return array_map( 'give_clean', $var );
690	} else {
691	return is_scalar( $var ) ? sanitize_text_field( wp_unslash( $var ) ) : $var;
692	}
693	}
694
695	/**
696	* Transforms php.ini notation for numbers (like '2M') to an integer.
697	*
698	* @since 1.8
699	*
700	* @param $size
701	*
702	* @return int
703	*/
704	function give_let_to_num( $size ) {
705	$l = substr( $size, - 1 );
706	$ret = substr( $size, 0, - 1 );
707	switch ( strtoupper( $l ) ) {
708	case 'P':
709	$ret *= 1024;
710	case 'T':
711	$ret *= 1024;
712	case 'G':
713	$ret *= 1024;
714	case 'M':
715	$ret *= 1024;
716	case 'K':
717	$ret *= 1024;
718	}
719
720	return $ret;
721	}
722
723	/**
724	* Verify nonce.
725	*
726	* @since 1.8
727	*
728	* @param string $nonce Nonce Hash.
729	* @param int $action Nonce verification action.
730	* @param array $wp_die_args Nonce fail arguments.
731	*
732	* @return bool
733	*/
734	function give_validate_nonce( $nonce, $action = - 1, $wp_die_args = array() ) {
735
736	// Verify nonce.
737	$verify_nonce = wp_verify_nonce( $nonce, $action );
738
739	// On ajax request send nonce verification status.
740	if ( wp_doing_ajax() ) {
741	return $verify_nonce;
742	}
743
744	if ( ! $verify_nonce ) {
745	$wp_die_args = wp_parse_args(
746	$wp_die_args,
747	array(
748	'message' => __( 'Nonce verification has failed.', 'give' ),
749	'title' => __( 'Error', 'give' ),
750	'args' => array(
751	'response' => 403,
752	),
753	)
754	);
755
756	wp_die(
757	$wp_die_args['message'],
758	$wp_die_args['title'],
759	$wp_die_args['args']
760	);
761	}
762
763	return true;
764	}
765
766	/**
767	* Verify nonce while processing donation form.
768	*
769	* @since 2.0
770	*
771	* @param string $nonce Nonce value.
772	* @param int $form_id Donation Form ID.
773	*
774	* @return bool
775	*/
776	function give_verify_donation_form_nonce( $nonce = '', $form_id ) {
777
778	// Form nonce action.
779	$nonce_action = "give_donation_form_nonce_{$form_id}";
780
781	// Nonce validation.
782	$verify_nonce = give_validate_nonce( $nonce, $nonce_action );
783
784	if ( ! $verify_nonce ) {
785	give_set_error( 'donation_form_nonce', __( 'Nonce verification has failed.', 'give' ) );
786	}
787
788	return $verify_nonce;
789	}
790
791	/**
792	* Check variable and get default or valid value.
793	*
794	* Helper function to check if a variable is set, empty, etc.
795	*
796	* @since 1.8
797	*
798	* @param $variable
799	* @param string (optional) $conditional default value: isset
800	* @param mixed (optional) $default default value: false
801	* @param string (optional) $array_key_name default value: false
802	*
803	* @return mixed
804	*/
805	function give_check_variable( $variable, $conditional = '', $default = false, $array_key_name = '' ) {
806	// Get value from array if array key non empty.
807	if( empty( $array_key_name ) ) {
808	switch ( $conditional ) {
809	case 'isset_empty':
810	$variable = ( isset( $variable ) && ! empty( $variable ) ) ? $variable : $default;
811	break;
812
813	case 'empty':
814	$variable = ! empty( $variable ) ? $variable : $default;
815	break;
816
817	case 'null':
818	$variable = ! is_null( $variable ) ? $variable : $default;
819	break;
820
821	default:
822	$variable = isset( $variable ) ? $variable : $default;
823	}
824	} else {
825	$isset = array_key_exists( $array_key_name, $variable );
826
827	switch ( $conditional ) {
828	case 'isset_empty':
829	$variable = ( $isset && ! empty( $variable[ $array_key_name ] ) ) ? $variable[ $array_key_name ] : $default;
830	break;
831
832	case 'empty':
833	$variable = ! empty( $variable[ $array_key_name ] ) ? $variable[ $array_key_name ] : $default;
834	break;
835
836	case 'null':
837	$variable = $isset && ! is_null( $variable[ $array_key_name ] ) ? $variable[ $array_key_name ] : $default;
838	break;
839
840	default:
841	$variable = $isset && isset( $variable[ $array_key_name ] ) ? $variable[ $array_key_name ] : $default;
842	}
843	}
844
845	return $variable;
846
847	}
848