template-functions.php — GiveWP – Donation Plugin and Fundraising Platform 2.3.1

give / includes / template-functions.php

give / includes Last commit date

template-functions.php

547 lines

1	<?php
2	/**
3	* Template Functions
4	*
5	* @package Give
6	* @subpackage Functions/Templates
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	* Returns the path to the Give templates directory
19	*
20	* @since 1.0
21	* @return string
22	*/
23	function give_get_templates_dir() {
24	return GIVE_PLUGIN_DIR . 'templates';
25	}
26
27	/**
28	* Returns the URL to the Give templates directory
29	*
30	* @since 1.0
31	* @return string
32	*/
33	function give_get_templates_url() {
34	return GIVE_PLUGIN_URL . 'templates';
35	}
36
37	/**
38	* Get other templates, passing attributes and including the file.
39	*
40	* @since 1.6
41	*
42	* @param string $template_name Template file name.
43	* @param array $args Passed arguments. Default is empty array().
44	* @param string $template_path Template file path. Default is empty.
45	* @param string $default_path Default path. Default is empty.
46	*/
47	function give_get_template( $template_name, $args = array(), $template_path = '', $default_path = '' ) {
48	if ( ! empty( $args ) && is_array( $args ) ) {
49	extract( $args );
50	}
51
52	$template_names = "{$template_name}.php";
53
54	$located = give_get_locate_template( $template_names, $template_path, $default_path );
55
56	if ( ! file_exists( $located ) ) {
57	/* translators: %s: the template */
58	Give()->notices->print_frontend_notice( sprintf( __( 'The %s template was not found.', 'give' ), $located ), true );
59
60	return;
61	}
62
63	// Allow 3rd party plugin filter template file from their plugin.
64	$located = apply_filters( 'give_get_template', $located, $template_name, $args, $template_path, $default_path );
65
66	/**
67	* Fires in give template, before the file is included.
68	*
69	* Allows you to execute code before the file is included.
70	*
71	* @since 1.6
72	*
73	* @param string $template_name Template file name.
74	* @param string $template_path Template file path.
75	* @param string $located Template file filter by 3rd party plugin.
76	* @param array $args Passed arguments.
77	*/
78	do_action( 'give_before_template_part', $template_name, $template_path, $located, $args );
79
80	include( $located );
81
82	/**
83	* Fires in give template, after the file is included.
84	*
85	* Allows you to execute code after the file is included.
86	*
87	* @since 1.6
88	*
89	* @param string $template_name Template file name.
90	* @param string $template_path Template file path.
91	* @param string $located Template file filter by 3rd party plugin.
92	* @param array $args Passed arguments.
93	*/
94	do_action( 'give_after_template_part', $template_name, $template_path, $located, $args );
95	}
96
97	/**
98	* Retrieves a template part
99	*
100	* Taken from bbPress.
101	*
102	* @since 1.0
103	*
104	* @param string $slug Template part file slug {slug}.php.
105	* @param string $name Optional. Template part file name {slug}-{name}.php. Default is null.
106	* @param bool $load If true the template file will be loaded, if it is found.
107	*
108	* @return string
109	*/
110	function give_get_template_part( $slug, $name = null, $load = true ) {
111
112	/**
113	* Fires in give template part, before the template part is retrieved.
114	*
115	* Allows you to execute code before retrieving the template part.
116	*
117	* @since 1.0
118	*
119	* @param string $slug Template part file slug {slug}.php.
120	* @param string $name Template part file name {slug}-{name}.php.
121	*/
122	do_action( "get_template_part_{$slug}", $slug, $name );
123
124	// Setup possible parts
125	$templates = array();
126	if ( isset( $name ) ) {
127	$templates[] = $slug . '-' . $name . '.php';
128	}
129	$templates[] = $slug . '.php';
130
131	// Allow template parts to be filtered
132	$templates = apply_filters( 'give_get_template_part', $templates, $slug, $name );
133
134	// Return the part that is found
135	return give_locate_template( $templates, $load, false );
136	}
137
138	/**
139	* Retrieve the name of the highest priority template file that exists.
140	*
141	* Searches in the STYLESHEETPATH before TEMPLATEPATH so that themes which
142	* inherit from a parent theme can just overload one file. If the template is
143	* not found in either of those, it looks in the theme-compat folder last.
144	*
145	* Forked from bbPress
146	*
147	* @since 1.0
148	*
149	* @param string\|array $template_names Template file(s) to search for, in order.
150	* @param bool $load If true the template file will be loaded if it is found.
151	* @param bool $require_once Whether to require_once or require. Default true.
152	* Has no effect if $load is false.
153	*
154	* @return string The template filename if one is located.
155	*/
156	function give_locate_template( $template_names, $load = false, $require_once = true ) {
157	// No file found yet
158	$located = false;
159
160	// Try to find a template file
161	foreach ( (array) $template_names as $template_name ) {
162
163	// Continue if template is empty
164	if ( empty( $template_name ) ) {
165	continue;
166	}
167
168	// Trim off any slashes from the template name
169	$template_name = ltrim( $template_name, '/' );
170
171	// try locating this template file by looping through the template paths
172	foreach ( give_get_theme_template_paths() as $template_path ) {
173
174	if ( file_exists( $template_path . $template_name ) ) {
175	$located = $template_path . $template_name;
176	break;
177	}
178	}
179
180	if ( $located ) {
181	break;
182	}
183	}
184
185	if ( ( true == $load ) && ! empty( $located ) ) {
186	load_template( $located, $require_once );
187	}
188
189	return $located;
190	}
191
192	/**
193	* Locate a template and return the path for inclusion.
194	*
195	* This is the load order:
196	*
197	* yourtheme / $template_path / $template_name
198	* yourtheme / $template_name
199	* $default_path / $template_name
200	*
201	* @since 2.0.3
202	* @access public
203	*
204	* @param string $template_name
205	* @param string $template_path (default: '')
206	* @param string $default_path (default: '')
207	*
208	* @return string
209	*/
210	function give_get_locate_template( $template_name, $template_path = '', $default_path = '' ) {
211	if ( ! $template_path ) {
212	$template_path = give_get_theme_template_dir_name() . '/';
213	}
214
215	if ( ! $default_path ) {
216	$default_path = GIVE_PLUGIN_DIR . 'templates/';
217	}
218
219	// Look within passed path within the theme - this is priority.
220	$template = locate_template(
221	array(
222	trailingslashit( $template_path ) . $template_name,
223	$template_name,
224	)
225	);
226
227	// Get default template/
228	if ( ! $template ) {
229	$template = $default_path . $template_name;
230	}
231
232	/**
233	* Filter the template
234	*
235	* @since 2.0.3
236	*/
237	return apply_filters( 'give_get_locate_template', $template, $template_name, $template_path );
238	}
239
240	/**
241	* Returns a list of paths to check for template locations
242	*
243	* @since 1.0
244	* @return array
245	*/
246	function give_get_theme_template_paths() {
247
248	$template_dir = give_get_theme_template_dir_name();
249
250	$file_paths = array(
251	1 => trailingslashit( get_stylesheet_directory() ) . $template_dir,
252	10 => trailingslashit( get_template_directory() ) . $template_dir,
253	100 => give_get_templates_dir(),
254	);
255
256	$file_paths = apply_filters( 'give_template_paths', $file_paths );
257
258	// sort the file paths based on priority
259	ksort( $file_paths, SORT_NUMERIC );
260
261	return array_map( 'trailingslashit', $file_paths );
262	}
263
264	/**
265	* Returns the template directory name.
266	*
267	* Themes can filter this by using the give_templates_dir filter.
268	*
269	* @since 1.0
270	* @return string
271	*/
272	function give_get_theme_template_dir_name() {
273	return trailingslashit( apply_filters( 'give_templates_dir', 'give' ) );
274	}
275
276	/**
277	* Adds Give Version to the <head> tag
278	*
279	* @since 1.0
280	* @return void
281	*/
282	function give_version_in_header() {
283	echo '<meta name="generator" content="Give v' . GIVE_VERSION . '" />' . "\n";
284	}
285
286	add_action( 'wp_head', 'give_version_in_header' );
287
288	/**
289	* Determines if we're currently on the Donations History page.
290	*
291	* @since 1.0
292	* @return bool True if on the Donations History page, false otherwise.
293	*/
294	function give_is_donation_history_page() {
295
296	$ret = is_page( give_get_option( 'history_page' ) );
297
298	return apply_filters( 'give_is_donation_history_page', $ret );
299	}
300
301	/**
302	* Adds body classes for Give pages
303	*
304	* @since 1.0
305	*
306	* @param array $class current classes
307	*
308	* @return array Modified array of classes
309	*/
310	function give_add_body_classes( $class ) {
311	$classes = (array) $class;
312
313	if ( give_is_success_page() ) {
314	$classes[] = 'give-success';
315	$classes[] = 'give-page';
316	}
317
318	if ( give_is_failed_transaction_page() ) {
319	$classes[] = 'give-failed-transaction';
320	$classes[] = 'give-page';
321	}
322
323	if ( give_is_donation_history_page() ) {
324	$classes[] = 'give-donation-history';
325	$classes[] = 'give-page';
326	}
327
328	if ( give_is_test_mode() ) {
329	$classes[] = 'give-test-mode';
330	$classes[] = 'give-page';
331	}
332
333	// Theme-specific Classes used to prevent conflicts via CSS
334	/* @var WP_Theme $current_theme */
335	$current_theme = wp_get_theme();
336
337	switch ( $current_theme->get_template() ) {
338
339	case 'Divi':
340	$classes[] = 'give-divi';
341	break;
342	case 'Avada':
343	$classes[] = 'give-avada';
344	break;
345	case 'twentysixteen':
346	$classes[] = 'give-twentysixteen';
347	break;
348	case 'twentyseventeen':
349	$classes[] = 'give-twentyseventeen';
350	break;
351	case 'twentynineteen':
352	$classes[] = 'give-twentynineteen';
353	break;
354
355	}
356
357	return array_unique( $classes );
358	}
359
360	add_filter( 'body_class', 'give_add_body_classes' );
361
362
363	/**
364	* Add Post Class Filter
365	*
366	* Adds extra post classes for forms
367	*
368	* @since 1.0
369	*
370	* @param array $classes
371	* @param string\|array $class
372	* @param int\|string $post_id
373	*
374	* @return array
375	*/
376	function give_add_post_class( $classes, $class = '', $post_id = '' ) {
377	if ( ! $post_id \|\| 'give_forms' !== get_post_type( $post_id ) ) {
378	return $classes;
379	}
380
381	//@TODO: Add classes for custom taxonomy and form configurations (multi vs single donations, etc).
382
383	if ( false !== ( $key = array_search( 'hentry', $classes ) ) ) {
384	unset( $classes[ $key ] );
385	}
386
387	return $classes;
388	}
389
390
391	add_filter( 'post_class', 'give_add_post_class', 20, 3 );
392
393	/**
394	* Get the placeholder image URL for forms etc
395	*
396	* @access public
397	* @return string
398	*/
399	function give_get_placeholder_img_src() {
400
401	$placeholder_url = '//placehold.it/600x600&text=' . urlencode( esc_attr__( 'Give Placeholder Image', 'give' ) );
402
403	return apply_filters( 'give_placeholder_img_src', $placeholder_url );
404	}
405
406
407	/**
408	* Global
409	*/
410	if ( ! function_exists( 'give_output_content_wrapper' ) ) {
411
412	/**
413	* Output the start of the page wrapper.
414	*/
415	function give_output_content_wrapper() {
416	give_get_template_part( 'global/wrapper-start' );
417	}
418	}
419	if ( ! function_exists( 'give_output_content_wrapper_end' ) ) {
420
421	/**
422	* Output the end of the page wrapper.
423	*/
424	function give_output_content_wrapper_end() {
425	give_get_template_part( 'global/wrapper-end' );
426	}
427	}
428
429	/**
430	* Single Give Form
431	*/
432	if ( ! function_exists( 'give_left_sidebar_pre_wrap' ) ) {
433	function give_left_sidebar_pre_wrap() {
434	echo apply_filters( 'give_left_sidebar_pre_wrap', '<div id="give-sidebar-left" class="give-sidebar give-single-form-sidebar-left">' );
435	}
436	}
437
438	if ( ! function_exists( 'give_left_sidebar_post_wrap' ) ) {
439	function give_left_sidebar_post_wrap() {
440	echo apply_filters( 'give_left_sidebar_post_wrap', '</div>' );
441	}
442	}
443
444	if ( ! function_exists( 'give_get_forms_sidebar' ) ) {
445	function give_get_forms_sidebar() {
446	give_get_template_part( 'single-give-form/sidebar' );
447	}
448	}
449
450	if ( ! function_exists( 'give_show_form_images' ) ) {
451
452	/**
453	* Output the donation form featured image.
454	*/
455	function give_show_form_images() {
456	if ( give_is_setting_enabled( give_get_option( 'form_featured_img' ) ) ) {
457	give_get_template_part( 'single-give-form/featured-image' );
458	}
459	}
460	}
461
462	if ( ! function_exists( 'give_template_single_title' ) ) {
463
464	/**
465	* Output the form title.
466	*/
467	function give_template_single_title() {
468	give_get_template_part( 'single-give-form/title' );
469	}
470	}
471
472	/**
473	* Conditional Functions
474	*/
475
476	if ( ! function_exists( 'is_give_form' ) ) {
477
478	/**
479	* is_give_form
480	*
481	* Returns true when viewing a single form.
482	*
483	* @since 1.6
484	*
485	* @return bool
486	*/
487	function is_give_form() {
488	return is_singular( array( 'give_form' ) );
489	}
490	}
491
492	if ( ! function_exists( 'is_give_category' ) ) {
493
494	/**
495	* is_give_category
496	*
497	* Returns true when viewing give form category archive.
498	*
499	* @since 1.6
500	*
501	* @param string $term The term slug your checking for.
502	* Leave blank to return true on any.
503	* Default is blank.
504	*
505	* @return bool
506	*/
507	function is_give_category( $term = '' ) {
508	return is_tax( 'give_forms_category', $term );
509	}
510	}
511
512	if ( ! function_exists( 'is_give_tag' ) ) {
513
514	/**
515	* is_give_tag
516	*
517	* Returns true when viewing give form tag archive.
518	*
519	* @since 1.6
520	*
521	* @param string $term The term slug your checking for.
522	* Leave blank to return true on any.
523	* Default is blank.
524	*
525	* @return bool
526	*/
527	function is_give_tag( $term = '' ) {
528	return is_tax( 'give_forms_tag', $term );
529	}
530	}
531
532	if ( ! function_exists( 'is_give_taxonomy' ) ) {
533
534	/**
535	* is_give_taxonomy
536	*
537	* Returns true when viewing a give form taxonomy archive.
538	*
539	* @since 1.6
540	*
541	* @return bool
542	*/
543	function is_give_taxonomy() {
544	return is_tax( get_object_taxonomies( 'give_form' ) );
545	}
546	}
547