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

give / templates / shortcode-form-grid.php

give / templates Last commit date

shortcode-form-grid.php

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