shortcode-form-grid.php — GiveWP – Donation Plugin and Fundraising Platform 2.24.0

give / templates / shortcode-form-grid.php

give / templates Last commit date

shortcode-form-grid.php

451 lines

1	<?php
2	/**
3	* This template is used to display the donation grid with [donation_grid]
4	*/
5
6	// Exit if accessed directly.
7	use Give\Helpers\Form\Template;
8	use Give\Helpers\Form\Utils as FormUtils;
9
10	if ( ! defined( 'ABSPATH' ) ) {
11	exit;
12	}
13
14	$form_id = get_the_ID(); // Form ID.
15	$give_settings = $args[0]; // Give settings.
16	$atts = $args[1]; // Shortcode attributes.
17	$raw_content = ''; // Raw form content.
18	$stripped_content = ''; // Form content stripped of HTML tags and shortcodes.
19	$excerpt = ''; // Trimmed form excerpt ready for display.
20
21	$flex_direction = $atts['columns'] === '1' ? "row" : "column";
22
23	$activeTemplate = FormUtils::isLegacyForm( $form_id ) ? 'legacy' : Template::getActiveID( $form_id );
24
25	/* @var \Give\Form\Template $formTemplate */
26	$formTemplate = Give()->templates->getTemplate( $activeTemplate );
27
28	$renderTags = static function($wrapper_class, $apply_styles = true) use($form_id , $atts ) {
29	if( !taxonomy_exists( 'give_forms_tag' ) ) {
30	return '';
31	}
32
33	$tags = wp_get_post_terms($form_id,'give_forms_tag');
34
35	$tag_bg_color = ! empty( $atts['tag_background_color'] )
36	? $atts['tag_background_color']
37	: '#69b86b';
38
39	$tag_text_color = ! empty( $atts['tag_text_color'] )
40	? $atts['tag_text_color']
41	: '#ffffff';
42
43	$tag_container_color = count($tags) >= 1
44	? 'rgba(0, 0, 0, 0.35)'
45	: 'none';
46
47	$tag_elements = array_map(
48	static function($term)use($tag_text_color,$tag_bg_color){
49	return "<span style='color: $tag_text_color; background-color: $tag_bg_color;'>$term->name</span>";
50	}, $tags
51	);
52
53	$tag_elements = implode('', $tag_elements);
54	$styles = $apply_styles ? "style='background-color: $tag_container_color;'" : '';
55
56	return "
57	<div class='$wrapper_class' $styles >
58	$tag_elements
59	</div>
60	";
61	};
62
63	?>
64
65	<div class="give-grid__item">
66	<?php
67	// Print the opening anchor tag based on display style.
68	if ( 'redirect' === $atts['display_style'] ) {
69
70	$form_grid_option = give_get_meta( $form_id, '_give_form_grid_option', true );
71	$form_grid_redirect_url = esc_url(give_get_meta( $form_id, '_give_form_grid_redirect_url', true ));
72
73	$url = ( $form_grid_option === 'custom' && filter_var($form_grid_redirect_url, FILTER_VALIDATE_URL) )
74	? $form_grid_redirect_url
75	: get_the_permalink();
76
77	printf(
78	'<a id="give-card-%1$s" onclick="return !document.body.classList.contains( \'block-editor-page\' )" class="give-card" href="%2$s">',
79	esc_attr( $form_id ),
80	esc_attr( $url )
81	);
82	} elseif ( 'modal_reveal' === $atts['display_style'] ) {
83	printf(
84	'<a id="give-card-%1$s" class="give-card js-give-grid-modal-launcher" data-effect="mfp-zoom-out" href="#give-modal-form-%1$s">',
85	esc_attr( $form_id )
86	);
87	}
88	?>
89	<div class="give-form-grid" style="flex-direction:<?php echo $flex_direction ?>">
90	<?php
91	// Maybe display the featured image.
92	if (
93	give_is_setting_enabled($give_settings['form_featured_img'])
94	&& ($imageSrc = $formTemplate->getFormFeaturedImage($form_id))
95	&& $atts['show_featured_image']
96	&& $atts['columns'] !== '1'
97	) {
98	/*
99	* Filters the image size used in card layouts.
100	*
101	* @param string The image size.
102	* @param array Form grid attributes.
103	*/
104	$image_size = apply_filters('give_form_grid_image_size', $atts['image_size'], $atts);
105	$image_attr = '';
106
107	if ('auto' !== $atts['image_height']) {
108	$image_attr = [
109	'style' => 'height: ' . $atts['image_height'],
110	];
111	}
112
113	$image = wp_get_attachment_image( attachment_url_to_postid( $imageSrc ), $image_size, false, $image_attr );
114
115
116	echo "
117	<div class='give-form-grid-media'>
118	<div class='give-card__media'> $image </div>
119
120	{$renderTags('give-form-grid-media__tags')}
121	</div>
122	";
123	} elseif(
124	give_is_setting_enabled($give_settings['form_featured_img'])
125	&& ($imageSrc = $formTemplate->getFormFeaturedImage($form_id))
126	&& $atts['show_featured_image']
127	&& $atts['columns'] === '1')
128	{
129	echo "
130	<div id='row-media' class='give-form-grid-media'>
131	<img class='give-form-grid-media' src='$imageSrc' alt='' />
132
133	{$renderTags('give-form-grid-media__tags')}
134	</div>
135	";
136	}
137	?>
138
139	<div class="give-form-grid-container">
140	<div class="give-form-grid-content">
141	<?php
142	if( !$atts['show_featured_image']){
143	echo "
144	<div class='give-form-grid-media' >
145	{$renderTags('give-form-grid-media__tags_no_image', false)}
146	</div>
147	";
148	}
149	?>
150
151	<?php
152
153	// Maybe display the form title.
154	if ( true === $atts['show_title'] ) {
155	printf(
156	'<h3 class="give-form-grid-content__title">%1$s</h3>',
157	$formTemplate->getFormHeading( $form_id )
158	);
159	}
160
161	// Maybe display the form excerpt.
162	if ( true === $atts['show_excerpt'] ) {
163	if ( $raw_content = $formTemplate->getFormExcerpt( $form_id ) ) {
164	$stripped_content = wp_strip_all_tags(
165	strip_shortcodes( $raw_content )
166	);
167	} else {
168	// Get content from the form post's content field.
169	$raw_content = give_get_meta( $form_id, '_give_form_content', true );
170
171	if ( ! empty( $raw_content ) ) {
172	$stripped_content = wp_strip_all_tags(
173	strip_shortcodes( $raw_content )
174	);
175	}
176	}
177
178	// Maybe truncate excerpt.
179	if ( 0 < $atts['excerpt_length'] ) {
180	$excerpt = wp_trim_words( $stripped_content, $atts['excerpt_length'] );
181	} else {
182	$excerpt = $stripped_content;
183	}
184
185	printf( '<p class="give-form-grid-content__text">%s</p>', $excerpt );
186	}
187
188	if ($atts['show_donate_button']):
189	$button_text = ! empty($atts['donate_button_text'])
190	? $atts['donate_button_text']
191	: give_get_meta($form_id, '_give_form_grid_donate_button_text', true);
192
193	/**
194	* @since 2.23.1 Updated the default text color for the donate button, see #6591.
195	*/
196	$button_text_color = ! empty($atts['donate_button_text_color'])
197	? $atts['donate_button_text_color']
198	: '#000000';
199	?>
200	<button style="text-decoration-color: <?php
201	echo $button_text_color; ?>">
202	<span style="color: <?php
203	echo $button_text_color; ?>">
204	<?php
205	echo $button_text ?: __('Donate', 'give'); ?>
206	</span>
207	</button>
208	<?php endif; ?>
209
210	</div>
211	<?php
212	$form = new Give_Donate_Form( $form_id );
213	$goal_option = give_get_meta( $form->ID, '_give_goal_option', true );
214
215	// Sanity check - ensure form has pass all condition to show goal.
216	$hide_goal = ( isset( $atts['show_goal'] ) && ! filter_var( $atts['show_goal'], FILTER_VALIDATE_BOOLEAN ) )
217	\|\| empty( $form->ID )
218	\|\| ( is_singular( 'give_forms' ) && ! give_is_setting_enabled( $goal_option ) )
219	\|\| ! give_is_setting_enabled( $goal_option ) \|\| 0 === $form->goal;
220
221	// Maybe display the goal progress bar.
222
223	if (!$hide_goal) :
224	$goal_progress_stats = give_goal_progress_stats( $form );
225	$goal_format = $goal_progress_stats['format'];
226	$color = $atts['progress_bar_color'];
227	$show_goal = isset( $atts['show_goal'] ) ? filter_var( $atts['show_goal'], FILTER_VALIDATE_BOOLEAN ) : true;
228	$shortcode_stats = apply_filters(
229	'give_goal_shortcode_stats',
230	array(
231	'income' => $form->get_earnings(),
232	'goal' => $goal_progress_stats['raw_goal'],
233	),
234	$form_id,
235	$goal_progress_stats,
236	$args
237	);
238
239	$income = $shortcode_stats['income'];
240	$goal = $shortcode_stats['goal'];
241
242	switch ( $goal_format ) {
243
244	case 'donation':
245	$progress = $goal ? round( ( $form->get_sales() / $goal ) * 100, 2 ) : 0;
246	$progress_bar_value = $form->get_sales() >= $goal ? 100 : $progress;
247	break;
248
249	case 'donors':
250	$progress = $goal ? round( ( give_get_form_donor_count( $form->ID ) / $goal ) * 100, 2 ) : 0;
251	$progress_bar_value = give_get_form_donor_count( $form->ID ) >= $goal ? 100 : $progress;
252	break;
253
254	case 'percentage':
255	$progress = $goal ? round( ( $income / $goal ) * 100, 2 ) : 0;
256	$progress_bar_value = $income >= $goal ? 100 : $progress;
257	break;
258
259	default:
260	$progress = $goal ? round( ( $income / $goal ) * 100, 2 ) : 0;
261	$progress_bar_value = $income >= $goal ? 100 : $progress;
262	break;
263
264	}
265
266	?>
267	<div class="give-form-grid-progress">
268	<?php
269	$style = "width:$progress_bar_value%;";
270	$style .= "background: linear-gradient(180deg, {$color} 0%, {$color} 100%); background-blend-mode: multiply;";
271	echo "
272	<div class='give-form-grid-progress-bar'>
273	<div class='give-progress-bar' role='progressbar' aria-valuemin='0' aria-valuemax='100' aria-valuenow='$progress_bar_value'>
274	<span style='$style'></span>
275	</div>
276	</div>
277	";
278
279	?>
280	<div class="form-grid-raised">
281	<div class="form-grid-raised__details">
282	<?php
283	if ( 'amount' === $goal_format ) :
284
285	/**
286	* Filter the give currency.
287	*
288	* @since 1.8.17
289	*/
290	$form_currency = apply_filters( 'give_goal_form_currency', give_get_currency( $form_id ), $form_id );
291
292	/**
293	* Filter the income formatting arguments.
294	*
295	* @since 1.8.17
296	*/
297	$income_format_args = apply_filters(
298	'give_goal_income_format_args',
299	array(
300	'sanitize' => false,
301	'currency' => $form_currency,
302	'decimal' => false,
303	),
304	$form_id
305	);
306
307	/**
308	* Filter the goal formatting arguments.
309	*
310	* @since 1.8.17
311	*/
312	$goal_format_args = apply_filters(
313	'give_goal_amount_format_args',
314	array(
315	'sanitize' => false,
316	'currency' => $form_currency,
317	'decimal' => false,
318	),
319	$form_id
320	);
321
322	/**
323	* This filter will be used to convert the goal amounts to different currencies.
324	*
325	* @since 2.5.4
326	*
327	* @param array $amounts List of goal amounts.
328	* @param int $form_id Donation Form ID.
329	*/
330	$goal_amounts = apply_filters(
331	'give_goal_amounts',
332	array(
333	$form_currency => $goal,
334	),
335	$form_id
336	);
337
338	/**
339	* This filter will be used to convert the income amounts to different currencies.
340	*
341	* @since 2.5.4
342	*
343	* @param array $amounts List of goal amounts.
344	* @param int $form_id Donation Form ID.
345	*/
346	$income_amounts = apply_filters(
347	'give_goal_raised_amounts',
348	array(
349	$form_currency => $income,
350	),
351	$form_id
352	);
353
354	// Get human readable donation amount.
355	$income = give_human_format_large_amount( give_format_amount( $income, $income_format_args ), array( 'currency' => $form_currency ) );
356	$goal = give_human_format_large_amount( give_format_amount( $goal, $goal_format_args ), array( 'currency' => $form_currency ) );
357
358	// Format the human readable donation amount.
359	$formatted_income = give_currency_filter(
360	$income,
361	array(
362	'form_id' => $form_id,
363	)
364	);
365
366	$formatted_goal = give_currency_filter(
367	$goal,
368	array(
369	'form_id' => $form_id,
370	)
371	);
372	echo sprintf(
373	/* translators: 1: amount of income raised 2: goal target amount. */
374	__( '<span class="amount" data-amounts="%1$s">%2$s</span>
375	<span class="goal" data-amounts="%3$s">of %4$s</span>', 'give' ),
376	esc_attr( wp_json_encode( $income_amounts, JSON_PRETTY_PRINT ) ),
377	esc_attr( $formatted_income ),
378	esc_attr( wp_json_encode( $goal_amounts, JSON_PRETTY_PRINT ) ),
379	esc_attr( $formatted_goal )
380	);
381
382	elseif ( 'percentage' === $goal_format ) :
383
384	echo sprintf( /* translators: %s: percentage of the amount raised compared to the goal target */
385	__( '
386	<span class="amount">%s%%</span>
387	<span class="goal">of 100%</span>', 'give' ),
388	round( $progress )
389	);
390
391	elseif ( 'donation' === $goal_format ) :?>
392
393	<span class="amount">
394	<?php echo give_format_amount( $form->get_sales(), array( 'decimal' => false ))?>
395	</span>
396
397	<span class="goal">
398	<?php echo sprintf(_n('of %s donation', 'of %s donations', $goal, 'give'),
399	give_format_amount( $goal, array( 'decimal' => false ))); ?>
400	</span>
401
402	<?php elseif ( 'donors' === $goal_format ) : ?>
403
404	<span class="amount"> <?php echo give_get_form_donor_count( $form->ID ) ?> </span>
405	<span class="goal">
406	<?php echo sprintf(_n('of %s donor', 'of %s donors', $goal, 'give'),
407	give_format_amount( $goal, array( 'decimal' => false ))); ?>
408	</span>
409	<?php endif ?>
410	</div>
411
412	<div class="form-grid-raised__details">
413	<span class="amount form-grid-raised__details_donations">
414	<?php echo give_format_amount( $form->get_sales(), array( 'decimal' => false )) ?>
415	</span>
416	<span class="goal">
417	<?php echo _n('donation', 'donations', $goal, 'give')?> </span>
418	</div>
419	</div>
420	</div>
421	<?php endif?>
422	</div>
423	</div>
424	</a>
425	<?php
426	// If modal, print form in hidden container until it is time to be revealed.
427	if ( 'modal_reveal' === $atts['display_style'] ) {
428	if (
429	! isset($_GET['context']) // check if we are in block editor
430	&& ! FormUtils::isLegacyForm( $form_id )
431	) {
432	echo give_form_shortcode(
433	[
434	'id' => $form_id,
435	'display_style' => 'button',
436	]
437	);
438
439	} else {
440	printf(
441	'<div id="give-modal-form-%1$s" class="give-donation-grid-item-form give-modal--slide mfp-hide">',
442	$form_id
443	);
444	give_get_donation_form( $form_id );
445	echo '</div>';
446	}
447	}
448	?>
449	</div>
450
451