class-notices.php — GiveWP – Donation Plugin and Fundraising Platform 2.9.2

give / includes / class-notices.php

give / includes Last commit date

class-notices.php

752 lines

1	<?php
2	/**
3	* Admin Notices Class.
4	*
5	* @package Give
6	* @subpackage Admin/Notices
7	* @copyright Copyright (c) 2016, GiveWP
8	* @license https://opensource.org/licenses/gpl-license GNU Public License
9	* @since 1.8.9
10	*/
11
12	// Exit if accessed directly.
13	if ( ! defined( 'ABSPATH' ) ) {
14	exit;
15	}
16
17	/**
18	* Give_Notices Class
19	*
20	* @since 1.8.9
21	*/
22	class Give_Notices {
23	/**
24	* List of notices
25	*
26	* @var array
27	* @since 1.8.9
28	* @access private
29	*/
30	private static $notices = [];
31
32
33	/**
34	* Flag to check if any notice auto dismissible among all notices
35	*
36	* @since 1.8.9
37	* @access private
38	* @var bool
39	*/
40	private static $has_auto_dismissible_notice = false;
41
42	/**
43	* Flag to check if any notice has dismiss interval among all notices
44	*
45	* @since 1.8.9
46	* @access private
47	* @var bool
48	*/
49	private static $has_dismiss_interval_notice = false;
50
51	/**
52	* Get things started.
53	*
54	* @since 1.8.9
55	*/
56	public function __construct() {
57	add_action( 'admin_notices', [ $this, 'render_admin_notices' ], 999 );
58	add_action( 'admin_footer', [ $this, '__reveal_notices' ] );
59	add_action( 'give_dismiss_notices', [ $this, 'dismiss_notices' ] );
60
61	add_action( 'give_frontend_notices', [ $this, 'render_frontend_notices' ], 999 );
62	add_action( 'give_pre_form_output', [ $this, 'render_frontend_form_notices' ], 10, 1 );
63	add_action( 'give_ajax_donation_errors', [ $this, 'render_frontend_notices' ] );
64
65	/**
66	* Backward compatibility for deprecated params.
67	*
68	* @since 1.8.14
69	*/
70	add_filter( 'give_register_notice_args', [ $this, 'bc_deprecated_params' ] );
71	add_filter( 'give_frontend_errors_args', [ $this, 'bc_deprecated_params' ] );
72	add_filter( 'give_frontend_notice_args', [ $this, 'bc_deprecated_params' ] );
73	}
74
75	/**
76	* Add backward compatibility to deprecated params.
77	*
78	* @since 1.8.14
79	* @access public
80	*
81	* @param array $args Array of notice params
82	*
83	* @return array
84	*/
85	public function bc_deprecated_params( $args ) {
86	/**
87	* Param: auto_dismissible
88	* deprecated in 1.8.14
89	*
90	* Check if auto_dismissible is set and it true then unset and change dismissible parameter value to auto
91	*/
92	if ( isset( $args['auto_dismissible'] ) ) {
93	if ( ! empty( $args['auto_dismissible'] ) ) {
94	$args['dismissible'] = 'auto';
95	}
96	// unset auto_dismissible as it has been deprecated.
97	unset( $args['auto_dismissible'] );
98	}
99
100	return $args;
101	}
102
103	/**
104	* Register notice.
105	*
106	* @since 1.8.9
107	* @access public
108	*
109	* @param $notice_args
110	*
111	* @return bool
112	*/
113	public function register_notice( $notice_args ) {
114	// Bailout.
115	if ( empty( $notice_args['id'] ) \|\| array_key_exists( $notice_args['id'], self::$notices ) ) {
116	return false;
117	}
118
119	$notice_args = wp_parse_args(
120	$notice_args,
121	[
122	'id' => '',
123	'description' => '',
124
125	/*
126	* Add custom notice html
127	* Note: This param has more priority then description, so if you have both param then this one will be use
128	* for generating notice html. Most of feature of notice attach to core generated html, so if you set
129	* custom html then please add required classes and data attribute which help to apply feature on notice.
130	*
131	* @since 1.8.16
132	*/
133	'description_html' => '',
134
135	/*
136	* Add New Parameter and remove the auto_dismissible parameter.
137	* Value: auto/true/false
138	*
139	* @since 1.8.14
140	*/
141	'dismissible' => true,
142
143	// Value: error/warning/success/info/updated
144	'type' => 'error',
145
146	// Value: null/user/all
147	'dismissible_type' => null,
148
149	// Value: shortly/permanent/null/custom
150	'dismiss_interval' => null,
151
152	// Only set it when custom is defined.
153	'dismiss_interval_time' => null,
154
155	]
156	);
157
158	/**
159	* Filter to modify Notice args before it get add
160	*
161	* @since 1.8.14
162	*/
163	$notice_args = apply_filters( 'give_register_notice_args', $notice_args );
164
165	// Set extra dismiss links if any.
166	if ( false !== strpos( $notice_args['description'], 'data-dismiss-interval' ) ) {
167
168	preg_match_all( '/data-([^"])="([^"])"/', $notice_args['description'], $extra_notice_dismiss_link );
169
170	if ( ! empty( $extra_notice_dismiss_link ) ) {
171	$extra_notice_dismiss_links = array_chunk( current( $extra_notice_dismiss_link ), 3 );
172	foreach ( $extra_notice_dismiss_links as $extra_notice_dismiss_link ) {
173	// Create array og key ==> value by parsing query string created after renaming data attributes.
174	$data_attribute_query_str = str_replace(
175	[ 'data-', '-', '"' ],
176	[
177	'',
178	'_',
179	'',
180	],
181	implode( '&', $extra_notice_dismiss_link )
182	);
183
184	$notice_args['extra_links'][] = wp_parse_args( $data_attribute_query_str );
185	}
186	}
187	}
188
189	self::$notices[ $notice_args['id'] ] = $notice_args;
190
191	// Auto set show param if not already set.
192	if ( ! isset( self::$notices[ $notice_args['id'] ]['show'] ) ) {
193	self::$notices[ $notice_args['id'] ]['show'] = $this->is_notice_dismissed( $notice_args ) ? false : true;
194	}
195
196	// Auto set time interval for shortly.
197	if ( 'shortly' === self::$notices[ $notice_args['id'] ]['dismiss_interval'] ) {
198	self::$notices[ $notice_args['id'] ]['dismiss_interval_time'] = DAY_IN_SECONDS;
199	}
200
201	return true;
202	}
203
204	/**
205	* Display notice.
206	*
207	* @since 1.8.9
208	*/
209	public function render_admin_notices() {
210	/* @var WP_Screen $wp_screen */
211	$wp_screen = get_current_screen();
212
213	// Bailout.
214	if ( empty( self::$notices ) ) {
215	return;
216	}
217
218	// Do not render notices on Gutenberg editor page.
219	if (
220	method_exists( $wp_screen, 'is_block_editor' )
221	&& $wp_screen->is_block_editor()
222	) {
223	return;
224	}
225
226	// Do not render notices on these pages as well.
227	// We don't want to annoy admins with notices on important screens like WP or GiveWP updates, etc.
228	if (
229	'update-core' === $wp_screen->id
230	\|\| 'give_forms_page_give-addons' === $wp_screen->id
231	\|\| 'give_forms_page_give-updates' === $wp_screen->id
232	) {
233	return;
234	}
235
236	$output = '';
237
238	foreach ( self::$notices as $notice_id => $notice ) {
239	// Check flag set to true to show notice.
240	if ( ! $notice['show'] ) {
241	continue;
242	}
243
244	// Render custom html.
245	if ( ! empty( $notice['description_html'] ) ) {
246	$output .= "{$notice['description_html']} \n";
247	continue;
248	}
249
250	// Check if notice dismissible or not.
251	if ( ! self::$has_auto_dismissible_notice ) {
252	self::$has_auto_dismissible_notice = ( 'auto' === $notice['dismissible'] );
253	}
254
255	// Check if notice dismissible or not.
256	if ( ! self::$has_dismiss_interval_notice ) {
257	self::$has_dismiss_interval_notice = $notice['dismiss_interval'];
258	}
259
260	$css_id = ( false === strpos( $notice['id'], 'give' ) ? "give-{$notice['id']}" : $notice['id'] );
261
262	$css_class = 'give-notice notice ' . ( empty( $notice['dismissible'] ) ? 'non' : 'is' ) . "-dismissible {$notice['type']} notice-{$notice['type']}";
263	$output .= sprintf(
264	'<div id="%1$s" class="%2$s" data-dismissible="%3$s" data-dismissible-type="%4$s" data-dismiss-interval="%5$s" data-notice-id="%6$s" data-security="%7$s" data-dismiss-interval-time="%8$s" style="display: none">' . " \n",
265	$css_id,
266	$css_class,
267	give_clean( $notice['dismissible'] ),
268	$notice['dismissible_type'],
269	$notice['dismiss_interval'],
270	$notice['id'],
271	empty( $notice['dismissible_type'] ) ? '' : wp_create_nonce( "give_edit_{$notice_id}_notice" ),
272	$notice['dismiss_interval_time']
273	);
274
275	$output .= ( 0 === strpos( $notice['description'], '<div' ) \|\| 0 === strpos( $notice['description'], '<p' ) ? $notice['description'] : "<p>{$notice['description']}</p>" );
276	$output .= "</div> \n";
277	}
278
279	echo $output;
280
281	$this->print_js();
282	}
283
284
285	/**
286	* Render give frontend notices.
287	*
288	* @since 1.8.9
289	* @access public
290	*
291	* @param int $form_id
292	*/
293	public function render_frontend_notices( $form_id = 0 ) {
294	$errors = give_get_errors();
295
296	$request_form_id = isset( $_REQUEST['form-id'] ) ? absint( $_REQUEST['form-id'] ) : 0;
297
298	// Sanity checks first: Ensure that gateway returned errors display on the appropriate form.
299	if ( ! isset( $_POST['give_ajax'] ) && $request_form_id !== $form_id ) {
300	return;
301	}
302
303	if ( $errors ) {
304	self::print_frontend_errors( $errors );
305
306	give_clear_errors();
307	}
308	}
309
310	/**
311	* Renders notices for different actions depending on
312	* the type of form display option.
313	*
314	* @since 2.2
315	* @access public
316	*
317	* @param int $form_id Form ID.
318	*
319	* @return void
320	*/
321	public function render_frontend_form_notices( $form_id ) {
322	$display_option = give_get_meta( $form_id, '_give_payment_display', true );
323
324	if ( 'modal' === $display_option ) {
325	add_action( 'give_payment_mode_top', [ $this, 'render_frontend_notices' ] );
326	} else {
327	add_action( 'give_pre_form', [ $this, 'render_frontend_notices' ], 11 );
328	}
329	}
330
331	/**
332	* Print notice js.
333	*
334	* @since 1.8.9
335	* @access private
336	*/
337	private function print_js() {
338	if ( self::$has_auto_dismissible_notice ) :
339	?>
340	<script>
341	jQuery(document).ready(function () {
342	// auto hide setting message in 5 seconds.
343	window.setTimeout(
344	function () {
345	jQuery('.give-notice[data-dismissible="auto"]').slideUp();
346	},
347	5000
348	);
349	})
350	</script>
351	<?php
352	endif;
353
354	if ( self::$has_dismiss_interval_notice ) :
355	?>
356	<script>
357	jQuery(document).ready(function () {
358	var $body = jQuery('body');
359
360	$body.on('click', '.give_dismiss_notice', function (e) {
361	var $parent = jQuery(this).parents('.give-notice'),
362	custom_notice_data = {
363	'dismissible_type': jQuery(this).data('dismissible-type'),
364	'dismiss_interval': jQuery(this).data('dismiss-interval'),
365	'dismiss_interval_time': jQuery(this).data('dismiss-interval-time')
366	};
367
368	$parent.find('button.notice-dismiss').trigger('click', [custom_notice_data]);
369	return false;
370	});
371
372	$body.on('click', 'button.notice-dismiss', function (e, custom_notice_data) {
373	var $parent = jQuery(this).parents('.give-notice'),
374	custom_notice_data = custom_notice_data \|\| {};
375
376	e.preventDefault();
377
378	var data = {
379	'give-action': 'dismiss_notices',
380	'notice_id': $parent.data('notice-id'),
381	'dismissible_type': $parent.data('dismissible-type'),
382	'dismiss_interval': $parent.data('dismiss-interval'),
383	'dismiss_interval_time': $parent.data('dismiss-interval-time'),
384	'_wpnonce': $parent.data('security')
385	};
386
387	if (Object.keys(custom_notice_data).length) {
388	jQuery.extend(data, custom_notice_data);
389	}
390
391	// Bailout.
392	if (
393	!data.dismiss_interval \|\|
394	!data.dismissible_type
395	) {
396	return false;
397	}
398
399	jQuery.post(
400	'<?php echo admin_url(); ?>admin-ajax.php',
401	data,
402	function (response) {
403
404	})
405	})
406	});
407	</script>
408	<?php
409	endif;
410	}
411
412	/**
413	* Show notices
414	* Note: only for internal use
415	*
416	* @since 2.3.0
417	*/
418	public function __reveal_notices() {
419	?>
420	<script>
421	jQuery(document).ready(function($){
422	// Fix notice appearance issue.
423	var give_notices = $('.give-notice');
424	if( give_notices.length ) {
425	give_notices.show();
426	}
427	});
428	</script>
429	<?php
430	}
431
432
433	/**
434	* Hide notice.
435	*
436	* @since 1.8.9
437	* @access public
438	*/
439	public function dismiss_notices() {
440	$_post = give_clean( $_POST );
441	$notice_id = esc_attr( $_post['notice_id'] );
442
443	// Bailout.
444	if (
445	empty( $notice_id ) \|\|
446	empty( $_post['dismissible_type'] ) \|\|
447	empty( $_post['dismiss_interval'] ) \|\|
448	! check_ajax_referer( "give_edit_{$notice_id}_notice", '_wpnonce' )
449	) {
450	wp_send_json_error();
451	}
452
453	$notice_key = Give()->notices->get_notice_key( $notice_id, $_post['dismiss_interval'] );
454	if ( 'user' === $_post['dismissible_type'] ) {
455	$current_user = wp_get_current_user();
456	$notice_key = Give()->notices->get_notice_key( $notice_id, $_post['dismiss_interval'], $current_user->ID );
457	}
458
459	$notice_dismiss_time = ! empty( $_post['dismiss_interval_time'] ) ? $_post['dismiss_interval_time'] : null;
460
461	// Save option to hide notice.
462	Give_Cache::set( $notice_key, true, $notice_dismiss_time, true );
463
464	/**
465	* Fire the action when notice dismissed
466	*
467	* @since 2.2.0
468	*/
469	do_action( 'give_notice_dismissed', $_post );
470
471	wp_send_json_success();
472	}
473
474
475	/**
476	* Get notice key.
477	*
478	* @since 1.8.9
479	* @access public
480	*
481	* @param string $notice_id
482	* @param string $dismiss_interval
483	* @param int $user_id
484	*
485	* @return string
486	*/
487	public function get_notice_key( $notice_id, $dismiss_interval = null, $user_id = 0 ) {
488	$notice_key = "_give_notice_{$notice_id}";
489
490	if ( ! empty( $dismiss_interval ) ) {
491	$notice_key .= "_{$dismiss_interval}";
492	}
493
494	if ( $user_id ) {
495	$notice_key .= "_{$user_id}";
496	}
497
498	$notice_key = sanitize_key( $notice_key );
499
500	return $notice_key;
501	}
502
503
504	/**
505	* Get notice dismiss link.
506	*
507	* @param $notice_args
508	*
509	* @return string
510	*/
511	public function get_dismiss_link( $notice_args ) {
512	$notice_args = wp_parse_args(
513	$notice_args,
514	[
515	'title' => __( 'Click here', 'give' ),
516	'dismissible_type' => '',
517	'dismiss_interval' => '',
518	'dismiss_interval_time' => null,
519	]
520	);
521
522	return sprintf(
523	'<a href="#" class="give_dismiss_notice" data-dismissible-type="%1$s" data-dismiss-interval="%2$s" data-dismiss-interval-time="%3$s">%4$s</a>',
524	$notice_args['dismissible_type'],
525	$notice_args['dismiss_interval'],
526	$notice_args['dismiss_interval_time'],
527	$notice_args['title']
528	);
529	}
530
531
532	/**
533	* Check if notice dismissed or not
534	*
535	* @since 1.8.9
536	* @access public
537	*
538	* @param array $notice
539	*
540	* @return bool\|null
541	*/
542	public function is_notice_dismissed( $notice ) {
543	$notice_key = $this->get_notice_key( $notice['id'], $notice['dismiss_interval'] );
544	$is_notice_dismissed = false;
545
546	if ( 'user' === $notice['dismissible_type'] ) {
547	$current_user = wp_get_current_user();
548	$notice_key = Give()->notices->get_notice_key( $notice['id'], $notice['dismiss_interval'], $current_user->ID );
549	}
550
551	$notice_data = Give_Cache::get( $notice_key, true );
552
553	// Find notice dismiss link status if notice has extra dismissible links.
554	if ( ( empty( $notice_data ) \|\| is_wp_error( $notice_data ) ) && ! empty( $notice['extra_links'] ) ) {
555
556	foreach ( $notice['extra_links'] as $extra_link ) {
557	$new_notice_data = wp_parse_args( $extra_link, $notice );
558	unset( $new_notice_data['extra_links'] );
559
560	if ( $is_notice_dismissed = $this->is_notice_dismissed( $new_notice_data ) ) {
561	return $is_notice_dismissed;
562	}
563	}
564	}
565
566	$is_notice_dismissed = ! empty( $notice_data ) && ! is_wp_error( $notice_data );
567
568	return $is_notice_dismissed;
569	}
570
571
572	/**
573	* Print frontend errors.
574	*
575	* @since 1.8.9
576	* @access public
577	*
578	* @param array $errors
579	*/
580	public static function print_frontend_errors( $errors ) {
581	// Bailout.
582	if ( ! $errors ) {
583	return;
584	}
585
586	/**
587	* Change auto_dismissible to dismissible and set the value to true
588	*
589	* @since 1.8.14
590	*/
591	$default_notice_args = [
592	'dismissible' => true,
593	'dismiss_interval' => 5000,
594	];
595
596	// Note: we will remove give_errors class in future.
597	$classes = apply_filters( 'give_error_class', [ 'give_notices', 'give_errors' ] );
598
599	echo sprintf( '<div class="%s">', implode( ' ', $classes ) );
600
601	// Loop error codes and display errors.
602	foreach ( $errors as $error_id => $error ) {
603	// Backward compatibility v<1.8.11
604	if ( is_string( $error ) ) {
605	$error = [
606	'message' => $error,
607	'notice_args' => [],
608	];
609	}
610
611	$notice_args = wp_parse_args( $error['notice_args'], $default_notice_args );
612
613	/**
614	* Filter to modify Frontend Errors args before errors is display.
615	*
616	* @since 1.8.14
617	*/
618	$notice_args = apply_filters( 'give_frontend_errors_args', $notice_args );
619
620	echo sprintf(
621	'<div class="give_error give_notice" id="give_error_%1$s" data-dismissible="%2$s" data-dismiss-interval="%3$d">
622	<p><strong>%4$s</strong>: %5$s</p>
623	</div>',
624	$error_id,
625	give_clean( $notice_args['dismissible'] ),
626	absint( $notice_args['dismiss_interval'] ),
627	esc_html__( 'Error', 'give' ),
628	$error['message']
629	);
630	}
631
632	echo '</div>';
633	}
634
635	/**
636	* Print frontend notice.
637	* Notice: notice type can be success/error/warning
638	*
639	* @since 1.8.9
640	* @access public
641	*
642	* @param string $message
643	* @param bool $echo
644	* @param string $notice_type
645	* @param array $notice_args
646	*
647	* @return string
648	*/
649	public static function print_frontend_notice( $message, $echo = true, $notice_type = 'warning', $notice_args = [] ) {
650	if ( empty( $message ) ) {
651	return '';
652	}
653
654	/**
655	* Change auto_dismissible to dismissible and set the value to true
656	*
657	* @since 1.8.14
658	*/
659	$default_notice_args = [
660	'dismissible' => false,
661	'dismiss_type' => 'auto',
662	'dismiss_interval' => 5000,
663	];
664
665	$notice_args = wp_parse_args( $notice_args, $default_notice_args );
666
667	// Notice dismissible must be true for dismiss type.
668	$notice_args['dismiss_type'] = ! $notice_args['dismissible'] ? '' : $notice_args['dismiss_type'];
669
670	/**
671	* Filter to modify Frontend notice args before notices is display.
672	*
673	* @since 1.8.14
674	*/
675	$notice_args = apply_filters( 'give_frontend_notice_args', $notice_args );
676
677	$close_icon = 'manual' === $notice_args['dismiss_type'] ?
678	sprintf(
679	'<img class="notice-dismiss give-notice-close" src="%s" />',
680	esc_url( GIVE_PLUGIN_URL . 'assets/dist/images/close.svg' )
681	) :
682	'';
683
684	// Note: we will remove give_errors class in future.
685	$error = sprintf(
686	'<div class="give_notices give_errors" id="give_error_%1$s">
687	<p class="give_notice give_%1$s" data-dismissible="%2$s" data-dismiss-interval="%3$d" data-dismiss-type="%4$s">
688	%5$s
689	</p>
690	%6$s
691	</div>',
692	$notice_type,
693	give_clean( $notice_args['dismissible'] ),
694	absint( $notice_args['dismiss_interval'] ),
695	give_clean( $notice_args['dismiss_type'] ),
696	$message,
697	$close_icon
698	);
699
700	if ( ! $echo ) {
701	return $error;
702	}
703
704	echo $error;
705	}
706
707	/**
708	* Print Inline Notice.
709	* Note: dismissible feature will note work if notice will add to dom by javascript after document load.
710	*
711	* @param array $notice_args An array of notice arguments.
712	*
713	* @todo Implement render_admin_notices function within this function in future.
714	*
715	* @access public
716	* @since 1.8.17
717	*
718	* @return string
719	*/
720	public function print_admin_notices( $notice_args = [] ) {
721	// Bailout.
722	if ( empty( $notice_args['description'] ) ) {
723	return '';
724	}
725
726	$defaults = [
727	'id' => '',
728	'echo' => true,
729	'notice_type' => 'warning',
730	'dismissible' => true,
731	];
732	$notice_args = wp_parse_args( $notice_args, $defaults );
733
734	$output = '';
735	$css_id = ! empty( $notice_args['id'] ) ? $notice_args['id'] : uniqid( 'give-inline-notice-' );
736	$css_class = "notice-{$notice_args['notice_type']} give-notice notice inline";
737	$css_class .= ( $notice_args['dismissible'] ) ? ' is-dismissible' : '';
738	$output .= sprintf(
739	'<div id="%1$s" class="%2$s"><p>%3$s</p></div>',
740	$css_id,
741	$css_class,
742	$notice_args['description']
743	);
744
745	if ( ! $notice_args['echo'] ) {
746	return $output;
747	}
748
749	echo $output;
750	}
751	}
752